v1
protected
openapi-connections

Update Connection

Changed on
patch/v1/workspaces/{workspace}/openapi-connections/{connection_id}

Request

Path parameters

connection_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Request body

auth_config_idstring uuid nullable

Optional MCPAuthConfig UUID for OAuth2 token rotation.

base_urlstring nullable
costobject nullable

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.

descriptionstring nullable
namestring nullable
spec_contentobject nullable
spec_urlstring nullable

Response

Successful Response

auth_config_idstring uuid nullable
base_urlstring nullable required
costobject nullable
created_atstring date-time required
descriptionstring nullable
idstring uuid required
is_ownerboolean
last_dispatchobject nullable
managed_bystring nullable
namestring required
personalboolean
registry_item_idstring uuid nullable
spec_urlstring nullable
statusstring required
updated_atstring date-time required
url_variablesstring[] nullable

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      response property base_url list-of-types was widened by adding types null to media type application/json of response 200