Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
web_backend

Update a connection

Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Any operations that lack an ID will be created. Then, the newly created operationId will be applied to the connection along with the rest of the operationIds in the request body. 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/web_backend/connections/update

Request body

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

Name that will be set to 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
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

skipResetboolean
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

catalogIdstring uuid
connectionIdstring uuid required
destinationIdstring uuid required
geography'auto' | 'us' | 'eu'
isSyncingboolean required
latestSyncJobCreatedAtinteger

epoch time of the latest sync job. null if no sync job has taken place.

latestSyncJobStatus'pending' | 'running' | 'incomplete' | 'failed' | 'succeeded' | 'cancelled'
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' required
notifySchemaChangesboolean required
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

schemaChange'no_change' | 'non_breaking' | 'breaking' required
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

{
  "destination": {
    "connectionConfiguration": {
      "user": "charles"
    }
  },
  "namespaceFormat": "${SOURCE_NAMESPACE}",
  "source": {
    "connectionConfiguration": {
      "user": "charles"
    }
  }
}