API Reference

Register an executor

POST /api/executors/register

Called by an executor on startup (and re-called after a control-plane restart when its first heartbeat 404s). The control plane renews the leases of any runIds included so liveness is re-established immediately rather than waiting for the next heartbeat cycle.

Operation IDexecutorRegister

Authentication

ExecutorKeyAuth·http bearer·Shared executor secret (ENVOY_EXECUTOR_KEY). Used by internal executor-to-control-plane routes (registration, heartbeat, completion/log callbacks).·Internal executor authentication; use the shared executor key.

Request body

This request body is required.

Content typeapplication/json

requestobject

4 properties

urlstringrequired

Executor base URL (matches runs.executor_id).

maxConcurrentintegerrequired

Concurrency capacity.

labelsobject

Optional labels used for dispatch selection.

Additional properties

valuestring | boolean | number

One of

One of 1string

One of 2boolean

One of 3number

runIdsarray<integer>

Run IDs currently in flight on the executor; their leases are renewed on register.

Array items

iteminteger

Success response body

200Registered.

Registered.

Content typeapplication/json

responseobject

1 property

registeredboolean

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/executors/register' \
  --header 'Authorization: Bearer $EXECUTOR_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "string",
  "maxConcurrent": 0
}'

const response = await fetch("https://your-envoy.example.com/api/executors/register", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_EXECUTOR_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "string",
    "maxConcurrent": 0
  }),
});

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