Skip to main content
POST
/
api
/
orchestration
/
fabric
/
{fabricId}
/
connection
Add connection to fabric
curl --request POST \
  --url https://app.prophecy.io/api/orchestration/fabric/{fabricId}/connection \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "name": "bigquery_connection_1",
  "kind": "bigquery",
  "isDefaultWarehouseConnection": false,
  "properties": {
    "authType": "private_key",
    "dataset": "dev",
    "id": "",
    "projectId": "dev-project-2222",
    "serviceAccountKey": {
      "kind": "prophecy",
      "properties": {
        "id": "1234",
        "name": "bq_service_account_1"
      },
      "subKind": "text",
      "type": "secret"
    }
  }
}
'
{
  "success": true,
  "data": {
    "id": "<connection-id>",
    "name": "bigquery_connection_1",
    "kind": "bigquery",
    "isDefaultWarehouseConnection": false,
    "properties": {
      "authType": "private_key",
      "dataset": "dev",
      "id": "",
      "projectId": "dev-project-2222",
      "serviceAccountKey": {
        "kind": "prophecy",
        "properties": {
          "id": "1234",
          "name": "bq_service_account_1"
        },
        "subKind": "text",
        "type": "secret"
      }
    }
  }
}
The properties object in the connection request body depends on the connection type. Find specific properties in the Connections > Properties section of the API documentation.

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

Body

application/json
​
name
string
required

The unique name of the connection.

​
kind
enum<string>
required

The type of connection.

Available options:
databricks,
bigquery,
synapse,
snowflake,
mssql,
oracle,
mongodb,
hana,
smtp,
redshift,
s3,
salesforce,
sftp,
sharepoint,
smartsheet,
ADLS,
tableau,
onedrive,
powerbi,
GCS
​
properties
object
required

Connection configuration properties. The structure varies by connection kind. Find specific properties in the Connections > Properties section of the API documentation.

​
isDefaultWarehouseConnection
boolean

Whether this connection is the default SQL warehouse connection in the fabric.

This field can only be set to true for Databricks and BigQuery connections.

Response

200 - application/json

Connection created successfully

​
success
boolean

Indicates whether the request was successful.

​
data
object