API Reference

Stop a job run

POST /api/job-runs/{id}/stop

Stops a running job run, cancels active task subprocesses, and marks the job run as completed. Individual task runs are stopped via SIGINT (local) or executor cancel (remote); their job-run-task rows become cancelled or skipped.

Operation IDstopJobRun

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

200Job run stopped

Job run stopped

Content typeapplication/json

responseobject

1 property

successboolean

Error responses

400Cannot stop

Cannot stop

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Code examples

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

const response = await fetch("https://your-envoy.example.com/api/job-runs/YOUR_ID/stop", {
  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);