Skip to main content
PATCH
Update a connection

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The connection to change. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
key
string

Rename it. The stored value is untouched.

kind
enum<string>

Change how the gateway injects it. Refused on an OAuth account or a provider app, whose kind belongs to their connection.

Available options:
api_key,
secret,
basic
scope
enum<string>

Move it between scopes. Host mappings follow the key, so they are unaffected.

Available options:
org,
worker,
client
workerId
string

Required when scope is worker.

clientId
string

Required when scope is client.

internalOnly
boolean

Hide it from client-tier agents, or stop hiding it. Cannot end up combined with a client scope — the two together resolve for nobody, so setting it here on a client-scoped connection, or moving an internal-only one to a client scope, is refused.

Response

Success.

data
object
required