Interlaken
API referenceAgents and workflowsTools

Test a tool's stored credential (structural check, plus an optional reachability probe when test_url is provided)

POST
/api/v1/tools/{id}/test

Requires the tools:read permission.

Authorization

AuthorizationBearer <token>

An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

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

application/json

curl -X POST "https://example.com/api/v1/tools/string/test" \  -H "Content-Type: application/json" \  -d '{}'
{  "http_status": 0,  "message": "string",  "probed": true,  "status": "string"}