a13nDocs
API referenceConnections

Test Connection

POST/api/v1/connections/{connection_id}/test

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

connection_id*Connection Id

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/connections/string/test"
{  "connection_id": "string",  "connection_version": 0,  "message": "string",  "status": "succeeded",  "tested_at": "2019-08-24T14:15:22Z",  "tools": [    {      "annotations": {        "property1": null,        "property2": null      },      "description": "string",      "input_schema": {        "property1": null,        "property2": null      },      "name": "string",      "output_schema": {        "property1": null,        "property2": null      },      "provider_version": "string"    }  ]}