Skip to main content
PATCH
Update connection settings

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

connection_id
string
required

Body

application/json

Non-secret connector settings on their own, with no field that can carry a credential.

The sibling of ConnectionSnapshotConfigRequest: that one carries the snapshot policy, this one the connector's own settings. Both exist because the combined connection PATCH accepts secrets and so stays off the agent surface — which also withheld settings that hold no credential at all, such as an HTTP connection's health_probe.

Which keys are accepted is not written here: it is ConnectorField.patchable_without_secret in the connector registry, so the answer travels with the field definition rather than a list that a rename could silently fall out of.

config
Config · object
required

Settings to change, MERGED into the stored config — omitted keys keep their values, and a null value clears one key. (Unlike snapshot_config, which replaces in full.) Only settings that neither hold a credential nor change how the connection authenticates are accepted; GET /v1/connections/data/types/{type} marks each one patchable_without_secret. Re-pointing the connection at a different host, changing its auth mode, or weakening its transport security stay on the credentialed route.

Example:
if_match_updated_at
string | null

The connection's current updatedAt, from GET /v1/connections/data/{connection_id}. When given, this write is refused with 412 if the connection changed since that read, so it cannot overwrite an edit made in between. Omitted, the write applies unconditionally.

Response

Successful Response