v2

latestOpenAPI 3.1.02026-07-262937191.0 MB

workflows.schedules

Get Schedule

get/v1/workflows/schedules/{schedule_id}

Path parameters

schedule_idstring required

Response

Successful Response

{"stackTrail":"components:schemas:ScheduleDefinitionOutput:properties:input","oasType":"schema","type":"unknown","title":"Input","description":"Input to provide to the workflow when starting it."}

cron_expressionsstring[]

Cron-based specification of times.

start_atstring date-time nullable

Time after which the first action may be run.

end_atstring date-time nullable

Time after which no more actions will be run.

jitterstring duration nullable

Jitter to apply each action.

An action's scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule).

time_zone_namestring nullable

IANA time zone name, for example US/Central.

schedule_idstring required

Unique identifier for the schedule.

remaining_executionsinteger nullable

Remaining workflow executions before this schedule stops triggering automatically. null means unlimited; 0 means the limit has been reached and the schedule is exhausted.

workflow_namestring required

Name of the workflow this schedule triggers.

deployment_namestring nullable

Name of the deployment this schedule targets.

pausedboolean required

Whether the schedule is currently paused.

notestring nullable

Human-readable note associated with the current pause or resume state.