Skip to main content
PUT
/
api
/
orchestration
/
fabric
/
{fabricId}
/
connection
/
name
/
{connectionName}
Update connection
curl --request PUT \
  --url https://app.prophecy.io/api/orchestration/fabric/{fabricId}/connection/name/{connectionName} \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "name": "bigquery_api_test",
  "kind": "bigquery",
  "isDefaultWarehouseConnection": false,
  "properties": {
    "authType": "private_key",
    "dataset": "kw_dev_api",
    "id": "",
    "projectId": "product-internal-463917",
    "serviceAccountKey": {
      "kind": "prophecy",
      "properties": {
        "id": "4657",
        "name": "bq_service_account_2"
      },
      "subKind": "text",
      "type": "secret"
    }
  }
}
'
{
  "success": true,
  "data": {
    "id": "d0ef2f82-5b66-4a17-b238-cc04c6f1cb3e",
    "name": "bigquery_api_test",
    "kind": "bigquery",
    "isDefaultWarehouseConnection": false,
    "properties": {
      "authType": "private_key",
      "dataset": "kw_dev_api",
      "id": "",
      "projectId": "product-internal-463917",
      "serviceAccountKey": {
        "kind": "prophecy",
        "properties": {
          "id": "4657",
          "name": "bq_service_account_2"
        },
        "subKind": "text",
        "type": "secret"
      }
    }
  },
  "message": "List(), List()"
}

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

Body

application/json
​
name
string
required

The connection name. Must match the connection name specified in the endpoint URL path parameter. This value cannot be changed.

​
kind
string
required

The type of connection. This value cannot be changed.

​
isDefaultWarehouseConnection
boolean
required

Whether this connection is the default warehouse connection. This value cannot be changed.

​
properties
object
required

Connection configuration properties. All required properties for the connection type must be included. Only certain properties can be updated. Check the Prophecy UI to see which properties can be updated.

Find specific properties in the Connections > Properties section of the API documentation.

Response

Connection updated successfully

​
success
boolean

Indicates whether the request was successful.

​
data
object
​
message
string

Response message.