Create or replace a job schedule
PUT/api/v1/jobs/{jobDefinitionId}/schedule
Validates and stores the Quartz CRON schedule after EDIT permission, then reconciles the durable scheduler trigger. Blank time zones default to UTC. Protected mutations require the session cookie and CSRF header.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Job definition identifier.
Request Bodyrequired
Section titled “Request Bodyrequired”Recurring Quartz schedule for one job.
object
Quartz CRON expression with seconds, minutes, hours, day, month, and weekday fields.
Example
0 0 2 * * ?Whether the scheduler may create runs from this schedule.
IANA time-zone identifier. Null or blank defaults to UTC.
Example
UTCResponses
Section titled “Responses”Schedule created or replaced
Persisted job schedule and its currently computed next fire time.
object
Creation timestamp in UTC.
Validated Quartz CRON expression.
Whether the schedule is enabled.
Scheduled job definition identifier.
Next fire time computed by the current scheduler, or null when disabled or unscheduled.
IANA time-zone identifier used by Quartz.
Last update timestamp in UTC.
The request is malformed or fails validation.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
Authentication is required or credentials are invalid.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
The authenticated identity lacks the required permission.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
The requested resource does not exist or is not visible.
RFC 7807 problem response. Dynamic detail text is credential-redacted.