Skip to main content
GET
/
cloud
/
v1
/
schedule
/
{project_id}
/
{region_id}
/
{schedule_id}
Get schedule
curl --request GET \
  --url https://api.gcore.com/cloud/v1/schedule/{project_id}/{region_id}/{schedule_id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "max_quantity": 123,
  "owner": "<string>",
  "owner_id": 123,
  "retention_time": {
    "days": 0,
    "hours": 2,
    "minutes": 1,
    "weeks": 0
  },
  "type": "<string>",
  "user_id": 123,
  "day": "5",
  "day_of_week": "mon,fri",
  "hour": "0, 20",
  "minute": "30",
  "month": "1,6",
  "resource_name_template": "reserve snap of the volume {volume_id}",
  "timezone": "UTC",
  "week": "1"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID Project ID

​
region_id
integer
required

Region ID Region ID

​
schedule_id
string
required

Schedule ID Schedule ID

Response

200 - application/json

OK

  • GetCronScheduleSerializer
  • GetIntervalScheduleSerializer
​
id
string
required

Schedule ID

​
max_quantity
integer
required

Number of stored resources.

Required range: x <= 10000
​
owner
string
required

Schedule owner

​
owner_id
integer
required

Owner ID

​
retention_time
RetentionTimeSerializer · object
required

Time after which the resource will be deleted

​
type
string
required

Schedule type

Allowed value: "cron"
​
user_id
integer
required

User ID

​
day
string | null

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

Example:

"5"

​
day_of_week
string | null

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

Example:

"mon,fri"

​
hour
string | null

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

Example:

"0, 20"

​
minute
string | null

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

Example:

"30"

​
month
string | null

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

Example:

"1,6"

​
resource_name_template
string | null

Template for resource names

Example:

"reserve snap of the volume {volume_id}"

​
timezone
string | null

A pytz timezone. Defaults to UTC.

Example:

"UTC"

​
week
string | null

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

Example:

"1"