Update shuttle job schedule
Updates the mutable properties of an existing shuttle job schedule identified by its ID. Only the fields supplied in the request body are changed. The owning job cannot be changed.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version header.
2026.0 Path Parameters
The unique identifier for the shuttle job schedule.
Body
The request body used to update an existing shuttle job schedule. Only the fields supplied in the request body are changed.
Whether the schedule is active.
enabled, paused "paused"
The kind of run the schedule starts. scan is not a valid schedule run mode.
transfer, simulation, analysis "simulation"
An optional human-readable description of the schedule.
"Nightly finance share replay."
A time-based trigger that starts the schedule at a wall-clock time and optionally repeats.
- Shuttle job schedule trigger by time
- Shuttle job schedule trigger by job
Response
Returns the updated shuttle job schedule.
A schedule that starts runs of a shuttle job. A schedule is either time-based or triggered by another job's run. Schedules cannot start a run in scan mode.
The unique identifier for the shuttle job schedule.
"7c1ba68e810d9156194530b2"
The value will always be shuttle_job_schedule.
shuttle_job_schedule "shuttle_job_schedule"
The unique identifier of the shuttle job this schedule belongs to.
"6a3ba68e810d9156194530a1"
Whether the schedule is active.
enabled, paused "enabled"
The kind of run the schedule starts. scan is not a valid schedule run mode.
transfer, simulation, analysis "transfer"
A time-based trigger that starts the schedule at a wall-clock time and optionally repeats.
- Shuttle job schedule trigger by time
- Shuttle job schedule trigger by job
An optional human-readable description of the schedule.
"Nightly finance share replay."
When the schedule last attempted to start a run. null when the schedule has never started a run.
"2026-03-16T09:00:12Z"