Skip to main content
PATCH
Update Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

Patch payload for an OpenAPI connection. All fields optional — unset = unchanged.

auth_config_id
string<uuid> | null

Optional MCPAuthConfig UUID for OAuth2 token rotation.

base_url
string | null
Maximum string length: 500
cost
Cost · object | null

What a call of this connection costs, set by a member on a connection the workspace pays for: a rate (per call or per unit), a field of the response, or free (wiki ADR-0038 §2.3). It wins over the connector's declaration. Send null to go back to the connector's.

custom_headers
HeaderInput · object[] | null

Replace the full custom-header set. Pass [] to clear all. Secret values are stored encrypted in the secret manager.

custom_query_params
QueryParamInput · object[] | null

Replace the full query-parameter set. Pass [] to clear all. An empty value for a secret parameter keeps the one already stored under that name.

description
string | null
name
string | null
Required string length: 1 - 255
spec_content
Spec Content · object | null
spec_url
string | null
url_variables
UrlVariableInput · object[] | null

Replace the full URL-variable set; must match the base URL's placeholders. Pass [] to clear all. Values are stored encrypted.

Response

Successful Response

available_tools
OpenAPIToolResponse · object[]
required
base_url
string | null
required
created_at
string<date-time>
required
id
string<uuid>
required
name
string
required
status
string
required
updated_at
string<date-time>
required
auth_config_id
string<uuid> | null
cost
Cost · object | null
custom_headers
HeaderOutput · object[] | null
custom_query_params
QueryParamOutput · object[] | null
description
string | null
last_dispatch
Last Dispatch · object | null
managed_by
string | null
registry_item_id
string<uuid> | null
spec_url
string | null
url_variables
string[] | null