PATCH /api/v1/runs/schedules/{schedule_id}

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

Update Schedule

partial update; a changed cron recomputes next_fire_at.

Auth: Authorization: Bearer <token> required

Request

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

Response `200`

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

Returns

RunScheduleRead — Successful Response

Field	Type	Description
`cron`	`string`
`enabled`	`boolean`
`entity`	`string`
`guid`	`integer`
`last_fire_summary`	`object`
`last_fired_at`	`string \| null`
`max_targets_per_fire`	`integer`
`mode`	`string`
`name`	`string`
`next_fire_at`	`string \| null`
`params`	`object`
`pipeline_id`	`string`
`selector`	`object`
`steps`	`array of string \| null`

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
`schedule_id`	path	yes	`integer`	—	—
`Idempotency-Key`	header	no	`string`	—	uuid	Optional.

Request body

Field	Type	Required
`cron`	`string \| null`	no
`enabled`	`boolean \| null`	no
`max_targets_per_fire`	`integer \| null`	no
`mode`	`string \| null`	no
`name`	`string \| null`	no
`params`	`object \| null`	no
`selector`	`object \| null`	no
`steps`	`array of string \| null`	no

Errors

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

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