Skip to content

POST /api/v1/runs/schedules

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Create Schedule

create a schedule (validates pipeline + cron; computes next_fire_at).

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/runs/schedules" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"cron":"<cron>","enabled":"<enabled>","entity":"<entity>","max_targets_per_fire":"<max_targets_per_fire>","mode":"<mode>","name":"<name>","params":"<params>","pipeline_id":"<pipeline_id>","selector":"<selector>","steps":"<steps>"}'

The contract carries no example for this response; schema: RunScheduleRead. Field-level shape: interactive explorer.

RunScheduleRead — Successful Response

FieldTypeDescription
cronstring
enabledboolean
entitystring
guidinteger
last_fire_summaryobject
last_fired_atstring | null
max_targets_per_fireinteger
modestring
namestring
next_fire_atstring | null
paramsobject
pipeline_idstring
selectorobject
stepsarray of string | null
ParameterInRequiredTypeDefaultConstraintsDescription
Idempotency-Keyheadernostring—uuidOptional.
FieldTypeRequiredDescription
cronstringyes
enabledbooleanno
entitystringyes
max_targets_per_fireintegerno
modestringno
namestringyes
paramsobjectno
pipeline_idstringyes
selectorobjectyes
stepsarray of string | nullno
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.