Skip to content

Run a schedule now without changing its timing or activity ​

http
POST /api/v1/schedules/{id}/run

Requires permission to edit the schedule. Active and paused schedules can run manually. Returns 409 schedule_busy while an occurrence is unfinished, including an unknown dispatch outcome. A repeated key for this schedule returns the same occurrence with its current state, even after completion or deletion, subject to current permissions. The worker prepares the saved settings through the usual execution path. Acceptance does not mean the agent has started.

operationId: RunSchedule

Authentication ​

bearerAuth / browserSession / Public in anonymous mode

See Space authentication for access, browser writes and SAML callback rules.

Parameters ​

NameInRequiredTypeDescription and constraints
idpathYesstringformat: "uuid"
Idempotency-KeyheaderYesstringNonzero UUID identifying this manual command within the schedule. Retrying the same key never creates another occurrence. Keys do not expire. format: "uuid"

Responses ​

CodeDescriptionContent
202The command was stored, or the same command was already accepted.application/json: Occurrence
defaultStructured API error. 401 credentials, 403 CSRF or schedule_forbidden, 404 missing, 409 conflict, 422 validation, 503 unavailable.application/json: Problem

HTTP API