Sign in
mcp-connections

Get an MCPConnection resource.

Changed on
get/api/mcp-connection/{name}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/mcp-connection/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

MCPConnection resource name.

MCPConnection name.

Query parameters

scope'Organisation' | 'Workspace' required

Headers

X-AgentZ-Workspace-IDstring

Stable Workspace ID selecting Workspace scope. Omit for Organisation scope.

Response

MCPConnection.

can_deleteboolean required

Whether the current principal may delete this connection in the selected scope.

namestring required

MCPConnection resource name.

scope'Organisation' | 'Workspace' required
created_atstring date-time required
status'Accepted' | 'Ready' | 'Error' required
reason'Ready' | 'ProbePending' | 'Unreachable' | 'InvalidCredentials' | 'ProtocolError' | 'InternalError' required
messagestring required
tool_catalog_readyboolean required

Changes

  • f9e13a5159d6Revision changes
    • breaking

      added the new required query request parameter scope

    • info

      the endpoint scheme security GatewayBearer was added to the API

    • info

      added the new optional header request parameter X-AgentZ-Workspace-ID

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • c3bba62f11e5Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status