Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
connection

Update a connection

Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Note that if a catalog is present in the request body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.

post/v1/connections/update

Request body

breakingChangeboolean
connectionIdstring uuid required
geography'auto' | 'us' | 'eu'
namestring

Name that will be set to this connection

namespaceDefinition'source' | 'destination' | 'customformat'

Method used for computing final namespace in destination

namespaceFormatstring

Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.

nonBreakingChangesPreference'ignore' | 'disable'
notifySchemaChangesboolean
operationIdsOperationId[]
prefixstring

Prefix that will be prepended to the name of each stream when it is written to the destination.

scheduleType'manual' | 'basic' | 'cron'

determine how the schedule data should be interpreted

sourceCatalogIdstring uuid
status'active' | 'inactive' | 'deprecated'

Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.

Example request

{
  "namespaceFormat": "${SOURCE_NAMESPACE}"
}

Response

Successful operation

breakingChangeboolean required
connectionIdstring uuid required
destinationIdstring uuid required
geography'auto' | 'us' | 'eu'
namestring required
namespaceDefinition'source' | 'destination' | 'customformat'

Method used for computing final namespace in destination

namespaceFormatstring

Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.

nonBreakingChangesPreference'ignore' | 'disable'
notifySchemaChangesboolean
operationIdsOperationId[]
prefixstring

Prefix that will be prepended to the name of each stream when it is written to the destination.

scheduleType'manual' | 'basic' | 'cron'

determine how the schedule data should be interpreted

sourceCatalogIdstring uuid
sourceIdstring uuid required
status'active' | 'inactive' | 'deprecated' required

Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.

Example response

{
  "namespaceFormat": "${SOURCE_NAMESPACE}"
}