API referenceEndpointsConnections
connections.test
RPC connections.test · Scope control
AuthorizationBearer <token>
A Plane API key, pl_<env>_…. The key is the environment: everything it reads and writes is scoped to the environment it was minted in, and the two tenancy headers are ignored for one.
In: header
Header Parameters
x-plane-environment?string
The environment slug this request is about. Honoured only for a session cookie; ignored for an API key, whose environment is its identity.
x-plane-organization?string
The organization slug or id this request is about, resolved before the environment. Honoured only for a session cookie.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/connections/test" \ -H "Content-Type: application/json" \ -d '{ "id": "string" }'{ "tools": [ { "name": "string", "description": "string", "inputSchema": null, "annotations": { "title": "string", "readOnlyHint": true, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } } ]}