Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Snapshot Schedules

Update schedule

patch/cloud/v1/schedule/{project_id}/{region_id}/{schedule_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

schedule_idstring required

Schedule ID

Example:1488e2ce-f906-47fb-ba32-c25a3f63df4f

Schedule ID

Request body

daystring

Day of the month (1-31, '*') or a comma-separated list of days

day_of_weekstring

Weekday or a comma-separated list of weekdays (mon,tue,wed,thu,fri,sat,sun,*)

daysinteger

Number of days to wait

hourstring

Hour (0-23, '*') or a comma-separated list of hours

hoursinteger

Number of hours to wait

max_quantityinteger

Number of stored resources.

minutestring

Minute (0-59, '*') or a comma-separated list of minutes

minutesinteger

Number of minutes to wait

monthstring

Month (1-12, '*') or a comma-separated list of months

resource_name_templatestring

Template for resource names.

timezonestring

A pytz timezone. Defaults to UTC.

type'cron' | 'interval'

Type of the schedule.

weekstring

ISO week (1-53, '*') or a comma-separated list of weeks

weeksinteger

Number of weeks to wait

Example request

{
  "day": "5",
  "day_of_week": "mon,fri",
  "hour": "0, 20",
  "hours": 2,
  "max_quantity": 2,
  "minute": "30",
  "minutes": 1,
  "month": "1,6",
  "resource_name_template": "Snapshot of volume {volume_id} created by policy {lifecycle_policy_id}",
  "retention_time": {
    "hours": 2,
    "minutes": 1
  },
  "timezone": "UTC",
  "type": "cron",
  "week": "1"
}

Response

OK

OR

Example response

{
  "day": "5",
  "day_of_week": "mon,fri",
  "hour": "0, 20",
  "id": "1488e2ce-f906-47fb-ba32-c25a3f63df4f",
  "max_quantity": 2,
  "minute": "30",
  "month": "1,6",
  "owner": "lifecycle_policy",
  "owner_id": 1,
  "resource_name_template": "reserve snap of the volume {volume_id}",
  "retention_time": {
    "hours": 2,
    "minutes": 1
  },
  "timezone": "UTC",
  "type": "cron",
  "user_id": 12,
  "week": "1"
}