public_connections
public
Connections
Update Connection details
patch/connections/{connectionId}
Request body
namestring
Optional name of the connection
dataResidencystring
namespaceDefinition'source' | 'destination' | 'custom_format'
Define the location where the data will be stored in the destination
namespaceFormatstring
Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefixstring
Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).
nonBreakingSchemaUpdatesBehavior'ignore' | 'disable_connection' | 'propagate_columns' | 'propagate_fully'
Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
status'active' | 'inactive' | 'deprecated' | 'locked'
Response
Update a Connection by the id in the path.
connectionIdstring UUID required
namestring required
sourceIdstring UUID required
destinationIdstring UUID required
workspaceIdstring UUID required
status'active' | 'inactive' | 'deprecated' | 'locked' required
nonBreakingSchemaUpdatesBehavior'ignore' | 'disable_connection' | 'propagate_columns' | 'propagate_fully'
Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
namespaceDefinition'source' | 'destination' | 'custom_format'
Define the location where the data will be stored in the destination
namespaceFormatstring
prefixstring
createdAtinteger required
statusReasonstring