API Reference

Export tasks and/or job templates as NDJSON bundle

View Markdown

GET /api/export

Streams a newline-delimited JSON bundle. Tasks are emitted before job templates. Requires admin or superadmin role.

Operation IDexportBundle

Authentication

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

Query parameters

include_tasksboolean

Default: true

include_job_templatesboolean

Default: false

task_namesstring

Comma-separated task names to export (legacy; use repeated task_name for names that contain commas)

task_namearray<string>

Exact task name to export. May be repeated.

Array items

itemstring

job_template_namesstring

Comma-separated job template names to export (legacy; use repeated job_template_name for names that contain commas)

job_template_namearray<string>

Exact job template name to export. May be repeated.

Array items

itemstring

statusstring

Default: active
Allowed values: active, archived

include_archivedboolean

Default: false

include_versionsboolean

Default: false

Success response body

200NDJSON export stream

NDJSON export stream

Content typeapplication/x-ndjson

responsestring

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/export?include_tasks=true&include_job_templates=false&task_names=YOUR_TASK_NAMES&task_name=YOUR_TASK_NAME&job_template_names=YOUR_JOB_TEMPLATE_NAMES&job_template_name=YOUR_JOB_TEMPLATE_NAME&status=active&include_archived=false&include_versions=false' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/export?include_tasks=true&include_job_templates=false&task_names=YOUR_TASK_NAMES&task_name=YOUR_TASK_NAME&job_template_names=YOUR_JOB_TEMPLATE_NAMES&job_template_name=YOUR_JOB_TEMPLATE_NAME&status=active&include_archived=false&include_versions=false", {
  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);