API Reference

Test a connector configuration

View Markdown

POST /api/connectors/test

Instantiates a connector from the provided type and config (without persisting) and runs per-type validation checks.

Operation IDtestConnectorConfig

Authentication

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

Request body

This request body is required.

Content typeapplication/json

requestobject

2 properties

typestringrequired

configobjectrequired

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

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/test' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "string",
  "config": {}
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/test", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string",
    "config": {}
  }),
});

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