API Reference

Get a job task's YAML (override or pinned version)

GET /api/jobs/{id}/tasks/{taskKey}/yaml

Returns the YAML used to edit a task within a job. If a per-job override exists for the DAG node key, its YAML is returned (is_overridden: true); otherwise the pinned task_versions row YAML is returned. Admin only.

Operation IDgetJobTaskYaml

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

200Task YAML for the job DAG node

Task YAML for the job DAG node

Content typeapplication/json

responseobject

5 properties

task_keystring

task_namestring

base_versioninteger | null

Nullable: yes

yaml_contentstring

is_overriddenboolean

Error responses

400Job has no snapshotted YAML, the snapshot fails to parse, or task_versions_snapshot is corrupt

Job has no snapshotted YAML, the snapshot fails to parse, or task_versions_snapshot is corrupt

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

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 GET \
  --url 'https://your-envoy.example.com/api/jobs/YOUR_ID/tasks/YOUR_TASK_KEY/yaml' \
  --header 'Authorization: Bearer $API_KEY'

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