Update Connection details

patch

https://api.airbyte.com/v1/connections/{connectionId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint can be used to update the configuration of a Connection, including streams and other connection-level configuration settings.

Any unspecified properties will not be updated.

📘
Will execute a full ovewrite of stream configurations
Unlike Source or Destination updates, any stream configuration you submit will execute a full overwrite of the existing stream configuration. Ensure that all desired streams and their configurations are present in the request body.

Path Params

connectionId

string

required

Body Params

name

string

Optional name of the connection

configurations

object

A list of configured stream options for a connection.

schedule

object

schedule for when the the connection should run, per the schedule type

dataResidency

string

enum

Allowed:

namespaceDefinition

string

enum

Define the location where the data will be stored in the destination

Allowed:

namespaceFormat

string

Defaults to null

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

prefix

string

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

string

enum

Set how Airbyte handles syncs when it detects a non-breaking schema change in the source

Allowed:

status

string

enum

Allowed:

Responses

403

Not allowed

404

Not found

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Will execute a full ovewrite of stream configurations

200Update a Connection by the id in the path.