Skip to main content
PATCH
Update connection snapshot policy

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

Query Parameters

confirm
boolean
default:false

Set confirm=true to replace the snapshot policy. Required.

Body

application/json

Snapshot policy on its own, with no field that can carry a credential.

The combined connection PATCH accepts secrets, so it is withheld from the agent surface — which also withheld the snapshot policy, the one part of a connection an agent must be able to author (an HTTP/REST connection produces flat, typed tables only once http_replication names each resource's path, data pointer, pagination and nested JSON fields). This route carries that policy alone, so it is safe to expose.

snapshot_config
Snapshot Config · object
required

Replaces the stored snapshot policy in full — read the current one back from the connection first and send the merged object, since omitted keys are cleared. Same shape as the connection PATCH's snapshot_config, including http_replication.

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