API Reference

Test an existing connector

View Markdown

POST /api/connectors/{id}/test

Loads the stored connector config (including secrets) and runs per-type validation checks on a fresh instance.

Operation IDtestConnectorById

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Test results

Test results

Content typeapplication/json

responseobject

2 properties

okbooleanrequired

checksarray<ConnectorCheck>required

Array items

itemobject

5 properties

namestringrequired

Check name (e.g. Authenticate, Write probe)

okbooleanrequired

messagestring

Short friendly summary (set on failure)

errorobject

3 properties

namestringrequired

Error class name (e.g. MongoServerError)

messagestringrequired

Raw error message

codestring

Driver/SDK error code

duration_msnumberrequired

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/test' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/test", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);