Skip to main content
POST
/
api
/
orchestration
/
fabric
Create a new fabric
curl --request POST \
  --url https://app.prophecy.io/api/orchestration/fabric \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "name": "API_Generated_Fabric",
  "description": "This is a description of the fabric.",
  "teamName": "devTeam",
  "provider": "databricks",
  "secret": {
    "subKind": "text",
    "properties": {
      "name": "databricks-pat",
      "value": "databricks-pat-value"
    },
    "kind": "prophecy"
  },
  "connection": {
    "name": "databricks_pat_1",
    "kind": "databricks",
    "properties": {
      "authType": "pat",
      "jdbcUrl": "<databricks-jdbc>",
      "catalog": "pipelinehub",
      "schema": "katherine",
      "token": "{{SECRET}}"
    },
    "isDefaultWarehouseConnection": true
  }
}
'
{
  "success": true,
  "data": {
    "id": "10740"
  }
}
You can only add one secret and one connection in the same request. In most cases, the connection will require a secret, so these will be created together.
The connection.properties object and secret.properties object depend on the connection type and secret type. Find specific properties in the following API documentation sections:
  • Connections > Properties
  • Secrets > Properties

Headers

​
X-AUTH-TOKEN
string
required

Prophecy authentication token. Required for all API requests.

Body

application/json
​
name
string
required

Name of the fabric to be created.

​
teamName
string
required

Name of the team that will own the fabric.

​
provider
enum<string>
required

SQL warehouse provider for the fabric.

Available options:
databricks,
bigquery,
ProphecyManaged
​
description
string

Short description of the fabric.

​
dataplaneUrl
string

Specific dataplane URL for the fabric. This is usually not needed and will be automatically set by Prophecy.

​
secret
object

Optional secret to be created with the fabric. Only one secret can be added per request.

​
connection
object

Optional connection to be created with the fabric. Only one connection can be added per request.

It often makes sense to create the connection for your SQL warehouse when creating the fabric. This means you would set isDefaultWarehouseConnection to true.

Response

Fabric created successfully

​
success
enum<boolean>
required

Indicates the request was successful.

Available options:
true,
false
​
data
object
required

Response data containing the fabric ID.