Reference

Schedules

A Schedule starts Runs of a Workflow on a calendar or an interval.

Checked 2026-09-28

A Schedule starts Runs of a Workflow on a calendar or an interval. Every fire is an engine timer; (schedule, intended time) is the Run identity, so one instant starts at most one Run. A fire is not a Run result.

Service Sylphx Workflows · Resource type workflows.sylphx.com/Schedule · Name pattern orgs/{org}/projects/{project}/envs/{env}/schedules/{schedule} · Shape spec_status

#Fields

Field	Type	What it is
name	string	orgs/{org}/projects/{project}/envs/{env}/schedules/{schedule}.
uid	string	sch_<cell><ulid>; never reused. Output only.
meta	ResourceMeta	Resource metadata.
spec	ScheduleSpec	Desired state. Required.
status	ScheduleStatus	Observed state. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

Method	Call	What it does
GET	get	Gets a schedule.
GET	list	Lists schedules.
POST	create	Creates a schedule.
PATCH	update	Updates a schedule.
DELETE	delete	Deletes a schedule.
POST	pause	Pauses a Schedule: no fire starts a Run until it is resumed.
POST	resume	Resumes a paused Schedule; missed fires follow catchup_window.

#get

Gets a schedule.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule · scope workflows:read · effect read · Request, response and examples

#list

Lists schedules.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules · scope workflows:read · effect read · paginated · Request, response and examples

#create

Creates a schedule.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules · scope workflows:write · effect write · long-running · Request, response and examples

#update

Updates a schedule.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule · scope workflows:write · effect write · long-running · Request, response and examples

#delete

Deletes a schedule.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule · scope workflows:write · effect destructive · long-running · Request, response and examples

#pause

Pauses a Schedule: no fire starts a Run until it is resumed.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:pause · scope workflows:write · effect write · validate_only · long-running · Request, response and examples

#resume

Resumes a paused Schedule; missed fires follow catchup_window.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:resume · scope workflows:write · effect write · validate_only · long-running · Request, response and examples