Sign in
latestOpenAPI 3.1.02026-08-20118232229.3 KB

0e42b0fb26d9

Update schedule

Update an existing schedule for an app.

put/schedules/{idOrName}

Path parameters

idOrNamestring required

The ID or name of the schedule to update.

The ID or name of the schedule to update.

Headers

X-Tower-Request-Numberinteger

Optional account-scoped monotonic sequence token used to reject out-of-order writes. See the fence documentation for the acceptance window and retry behavior.

Optional account-scoped monotonic sequence token used to reject out-of-order writes. See the fence documentation for the acceptance window and retry behavior.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

app_versionstring nullable

This property is deprecated and ignored. Schedules inherit the version from their environment.

cronstring

The cron expression defining when the app should run

environmentstring

The environment to run the app in

namestring nullable

The name for this schedule. Must be unique per environment.

overlap_policy'skip' | 'allow' nullable

The overlap policy for the schedule

status'active' | 'disabled' nullable

The status of the schedule

timezonestring nullable

The IANA timezone identifier that the cron expression should be evaluated in (e.g., 'America/New_York', 'Europe/London').

Example request

{
  "$schema": "https://api.tower.dev/v1/schemas/UpdateScheduleParams.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://api.tower.dev/v1/schemas/UpdateScheduleResponse.json"
}