Skip to main content
POST
Add connection to fabric
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.

Reachability test

Prophecy checks the connection and tests that it can reach the external system before saving it. Prophecy In Memory runs in Prophecy’s cloud, so the external system must accept connections from Prophecy. To save the connection without the reachability test, add "shouldTest": false to the request body.

Store credentials as secrets

A connection never holds a password or key directly. Store each one as a secret on the fabric first, then reference the secret from the connection by its ID and name. Prophecy never returns a stored secret value again.

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,
postgres,
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, BigQuery, and Snowflake connections.

shouldTest
boolean
default:true

Whether Prophecy tests that it can reach the external system before saving the connection. Defaults to true. Set to false to save the connection without the reachability test.

Response

200 - application/json

Connection created successfully

success
boolean

Indicates whether the request was successful.

data
object