Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
connection

Create a connection between a source and a destination

post/v1/connections/create

Request body

destinationIdstring uuid required
geography'auto' | 'us' | 'eu'
namestring

Optional name of the 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
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 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}"
}