Update schedule
Partially updates a schedule. Any omitted field is left unchanged. Changing expression or type (or reactivating from inactive) reschedules the next run and bumps generation; payload-only and agent_tag-only changes leave the firing cadence in place.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique routing key of the agent the schedule belongs to.
The schedule's ULID, as returned from create.
Body
Change the pinned agent version.
Rename the schedule.
Update the schedule expression. Same 6-field cron shapes as create; minimum firing cadence is 1 hour.
Activate or deactivate the schedule. Deactivating removes the NATS entry; activating re-publishes with current values.
Update the invocation payload. Payload-only changes do not reset the firing cadence or bump generation.
Change the schedule type. Only cron is accepted. Changing type or expression resets the NATS schedule and bumps generation.
cron Response
Schedule updated.
ULID identifying this schedule.
ID of the API key that created the schedule.
6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp.
Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers.
Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing.
Total firings since creation or last expression/type change.
Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction.
cron, once, interval Pinned agent version. Omit to always run the agent's current active version.
Human-readable name of the schedule. Omitted for schedules created before display names were required.
Timestamp of the most recent firing, if any.
ID of the API key that last updated the schedule. Omitted until the schedule is updated.