https://api.planasonix.com
If your workspace uses a versioned base path (for example
/v1), prepend it before /api. See API reference.List schedules
Retrieves every schedule in the workspace. Optional filters narrow results by pipeline or enabled state.GET /api/schedules
Request parameters
string
Return only schedules bound to this pipeline ID.
boolean
When
true or false, filter by enabled status. Omit to return all.integer
default:"50"
Page size for collection responses (max varies by deployment).
string
Opaque cursor from
meta.page.cursor for the next page.Example response
Create schedule
Creates a new schedule for a pipeline. The pipeline must exist and your API key must have permission to attach schedules.POST /api/schedules
Request body
string
required
Target pipeline ID.
string
required
Standard five-field cron expression (minute hour day month weekday).
string
required
IANA time zone name (for example
UTC, Europe/Berlin).boolean
default:"true"
Whether the schedule starts active. You can enable or disable later via dedicated endpoints.
Example response
Get schedule
Returns a single schedule by ID.GET /api/schedules/{id}
Request parameters
string
required
Schedule ID.
Example response
Update schedule
Updates mutable fields on an existing schedule. Omitted fields are left unchanged unless the API version documents otherwise.PUT /api/schedules/{id}
Request parameters
string
required
Schedule ID.
Request body
string
New cron expression.
string
New IANA timezone.
boolean
Enable or disable without calling the enable/disable endpoints.
Example response
Delete schedule
Permanently removes the schedule. In-flight runs are not canceled unless documented by your deployment.DELETE /api/schedules/{id}
Request parameters
string
required
Schedule ID.
Example response
Enable schedule
Setsenabled to true and resumes future invocations according to the cron expression.
POST /api/schedules/{id}/enable
Request parameters
string
required
Schedule ID.
Example response
Disable schedule
Setsenabled to false. Already queued or running jobs may still complete.
POST /api/schedules/{id}/disable
Request parameters
string
required
Schedule ID.
Example response
Trigger immediate run
Enqueues a pipeline run for the schedule’s pipeline immediately, independent of the next cron tick.POST /api/schedules/{id}/run
Request parameters
string
required
Schedule ID.
Request body
object
Optional key-value variables passed into the pipeline run context.