Sign in
v1
protected
openapi-connections

Create Connection

post/v1/workspaces/{workspace}/openapi-connections/

Path parameters

workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

auth_config_idstring uuid nullable

Optional MCPAuthConfig UUID for OAuth2 token rotation. When set, tokens are minted/refreshed on the connection's behalf.

base_urlstring required

Base URL for API requests, e.g. 'https://api.example.com'.

descriptionstring nullable

Optional human-readable summary of what this API exposes.

namestring required

Display name for the connection (unique per workspace).

spec_contentobject nullable

Inline OpenAPI 3.x spec as a JSON object. Use instead of spec_url when the spec host is unreachable from the API.

spec_urlstring nullable

URL to an OpenAPI 3.x JSON or YAML spec. The spec is fetched and parsed eagerly at create time so the connection is ready for use.

Response

Successful Response

auth_config_idstring uuid nullable
base_urlstring required
created_atstring required
descriptionstring nullable
idstring uuid required
namestring required
registry_item_idstring uuid nullable
spec_urlstring nullable
statusstring required
updated_atstring required

Changes

Changed in 1 of the 45 revisions of this API.1