API Reference

Get server configuration

View Markdown

GET /api/server/config

Operation IDgetServerConfig

Authentication

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

Success response body

200Server configuration

Server configuration

Content typeapplication/json

responseobject

5 properties

executorobject

2 properties

typestring

Allowed values: local, http

callback_urlstring | null

Nullable: yes

runsobject

1 property

max_concurrentinteger

connectorsobject

1 property

upload_max_bytesinteger

Server-wide connector file upload limit in bytes.

tasks_dirstring

jobs_dirstring

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/server/config' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/server/config", {
  method: "GET",
  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);