API Reference

Query connector data

POST /api/connectors/{id}/query

Executes a query against the connector. Only whitelisted methods are allowed per connector type. SQL execute is restricted to SELECT/WITH/EXPLAIN. MongoDB write methods (insert_one, update_one, delete_one, delete_many) require admin or superadmin role; update_one, delete_one and delete_many require a non-empty filter.

Operation IDqueryConnector

Authentication

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

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

3 properties

methodstringrequired

Connector method to call (must be read-only)

argsobjectrequired

Method arguments

Additional properties are allowed.

limitinteger

Max rows to return (no upper cap — in-flight queries are cancellable)

Default: 100
Minimum: 1

Success response body

200Query results

Query results

Content typeapplication/json

responseobject

4 properties

dataarray<object>

Array items

itemobject

countinteger

truncatedboolean

mutationboolean

True when the response is from a MongoDB write operation

Error responses

400Validation error

Validation error

No response content schema is documented.

403Method not allowed for data exploration

Method not allowed for data exploration

No response content schema is documented.

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"
}

500Query execution failed

Query execution failed

No response content schema is documented.

Code examples

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

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

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