Skip to main content
GET
/
api
/
orchestration
/
fabric
/
{fabricId}
/
connection
/
name
/
{connectionName}
Retrieve connection details
curl --request GET \
  --url https://app.prophecy.io/api/orchestration/fabric/{fabricId}/connection/name/{connectionName} \
  --header 'X-AUTH-TOKEN: <x-auth-token>'
{
  "success": true,
  "data": {
    "id": "<connection-id>",
    "name": "synapse_1",
    "kind": "synapse",
    "isDefaultWarehouseConnection": false,
    "properties": {
      "database": "SynapseDev",
      "password": {
        "kind": "prophecy",
        "properties": {
          "id": "2719",
          "name": "secret-synapse"
        },
        "subKind": "text",
        "type": "secret"
      },
      "port": "1433",
      "server": "<server-name>.sql.azuresynapse.net",
      "username": "<username>"
    }
  }
}

Headers

X-AUTH-TOKEN
string
required

Prophecy authentication token. Required for all API requests.

Path Parameters

fabricId
string
required

The unique ID of the parent fabric

connectionName
string
required

The unique name of the connection

Response

200 - application/json

Connection resource found

success
boolean

Indicates whether the request was successful.

data
object