API Reference

Bulk delete runs

POST /api/runs/bulk-delete

Deletes multiple runs by explicit IDs or by filter criteria. Active runs are skipped. Logs, metrics, and job_run_tasks references are cleaned up before deletion. Provide exactly one of ids or where.

Operation IDbulkDeleteRuns

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

idsarray<integer>

Explicit run IDs to delete

Array items

iteminteger

whereobject

Filter criteria — deletes all matching runs

2 properties

statusstring

Allowed values: pending, running, success, completed, failed, cancelled

task_idinteger

Success response body

200Bulk delete result

Bulk delete result

Content typeapplication/json

responseobject

3 properties

deleted_countintegerrequired

skipped_countintegerrequired

skippedarray<object>required

Array items

itemobject

2 properties

idinteger

reasonstring

Error responses

400Invalid request (missing or conflicting parameters)

Invalid request (missing or conflicting parameters)

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/runs/bulk-delete' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    0
  ],
  "where": {
    "status": "pending",
    "task_id": 0
  }
}'

const response = await fetch("https://your-envoy.example.com/api/runs/bulk-delete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ids": [
      0
    ],
    "where": {
      "status": "pending",
      "task_id": 0
    }
  }),
});

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