OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-148243531000.1 KB

5f7e0c3a8f59

schedule

update schedule

post/w/{workspace}/schedules/update/{path}

Path parameters

workspacestring required
pathstring required

Request body

schedulestring required

Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon

timezonestring required

IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')

argsScriptArgs required

The arguments to pass to the script or flow

on_failurestring nullable

Path to a script or flow to run when the scheduled job fails

on_failure_timesnumber nullable

Number of consecutive failures before the on_failure handler is triggered (default 1)

on_failure_exactboolean nullable

If true, trigger on_failure handler only on exactly N failures, not on every failure after N

on_failure_extra_argsScriptArgs

The arguments to pass to the script or flow

on_recoverystring nullable

Path to a script or flow to run when the schedule recovers after failures

on_recovery_timesnumber nullable

Number of consecutive successes before the on_recovery handler is triggered (default 1)

on_recovery_extra_argsScriptArgs

The arguments to pass to the script or flow

on_successstring nullable

Path to a script or flow to run after each successful execution

on_success_extra_argsScriptArgs

The arguments to pass to the script or flow

ws_error_handler_mutedboolean

If true, the workspace-level error handler will not be triggered for this schedule's failures

retryRetry — unresolved $ref
no_flow_overlapboolean

If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)

summarystring nullable

Short summary describing the purpose of this schedule

descriptionstring nullable

Detailed description of what this schedule does

tagstring nullable

Worker tag to route jobs to specific worker groups

paused_untilstring date-time nullable

ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time

cron_versionstring nullable

Cron parser version. Use 'v2' for extended syntax with additional features

dynamic_skipstring nullable

Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)

permissioned_asstring nullable

The user or group this schedule runs as (e.g., 'u/admin' or 'g/mygroup'). Only admins and wm_deployers can set this via preserve_permissioned_as.

preserve_permissioned_asboolean nullable

If true and user is admin/wm_deployers, preserve the provided permissioned_as instead of using the deploying user's identity

labelsstring[]

Response

schedule updated