Skip to content
Console
On this page

Get a schedule

Gets a schedule.

Gets a schedule.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule
  • Scope workflows:read
  • Effect read — nothing is written.
  • Collection schedules

Request

FieldTypeWhat it is
namestringThe name of the schedule to get. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/schedules/{schedule}.
uidstringsch_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specScheduleSpecDesired state. Required.
statusScheduleStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ScheduleSpec

FieldTypeWhat it is
workflowstringThe Workflow the Schedule starts, in the same environment. Required.
inputstructThe input of every Run, at most 64 KiB of JSON.
calendarCalendarSpecA calendar: cron expression and time zone. One of the trigger group.
intervalIntervalSpecA fixed interval. One of the trigger group.
jitterdurationRandom delay added to each fire, at most min(interval, 1h).
overlap_policyOverlapPolicyWhat a fire does while a previous Run is still running. One of skip, buffer_one, buffer_all, cancel_other, allow.
catchup_windowdurationMissed fires older than this are skipped; 10s to 365d.
pausedboolWhether fires are paused.
pause_notestringWhy the Schedule is paused; shown in status.

ScheduleStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
next_fire_timestimestamp[]The next intended fire times. Output only.
last_fireScheduleFireThe most recent fire. Output only.

CalendarSpec

FieldTypeWhat it is
cronstringA 5-field cron expression, for example 0 3 * * *. Required.
time_zonestringIANA time zone; default UTC.

IntervalSpec

FieldTypeWhat it is
everydurationThe period, 1s to 365d. Required.
offsetdurationPhase offset within each period.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

ScheduleFire

FieldTypeWhat it is
intended_timetimestampThe instant the fire was due. Output only.
runstringThe Run it started, if any. Output only.
outcomeFireOutcomeWhat the fire did. Output only. One of started, skipped, buffered.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"