API Reference

Remove a per-job task YAML override

View Markdown

DELETE /api/jobs/{id}/tasks/{taskKey}/override

Resets the DAG node to the pinned task version from the task library. Admin only.

Operation IDdeleteJobTaskOverride

Authentication

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

Path parameters

idintegerrequired

Resource ID

taskKeystringrequired

Success response body

200Override removed

Override removed

Content typeapplication/json

responseobject

2 properties

okboolean

overridden_task_keysarray<string>

Array items

itemstring

Error responses

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

Code examples

curl --request DELETE \
  --url 'https://your-envoy.example.com/api/jobs/YOUR_ID/tasks/YOUR_TASK_KEY/override' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/jobs/YOUR_ID/tasks/YOUR_TASK_KEY/override", {
  method: "DELETE",
  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);