Contact usConsole
© 2023 Nebius Israel Ltd
Compute Cloud

Compute Cloud API, REST: SnapshotSchedule.list

Retrieves the list of snapshot schedules in the specified folder.

HTTP request

GET https://compute.api.il.nebius.cloud/compute/v1/snapshotSchedules

Query parameters

Parameter Description
folderId

Required. ID of the folder to list snapshot schedules in.

To get the folder ID, make a list request.

The maximum string length in characters is 50.
pageSize

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.
pageToken

Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request.

The maximum string length in characters is 100.
filter

A filter expression that filters snapshot schedules listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on SnapshotSchedule.name field.
  2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
  3. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=my-schedule.

The maximum string length in characters is 1000.
orderBy

A sorting expression that sorts snapshot schedules listed in the response.

The expression must specify the field name from SnapshotSchedule and ascending or descending order, e.g. createdAt desc.

Default value: id asc.

The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "snapshotSchedules": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "schedulePolicy": {
        "startAt": "string",
        "expression": "string"
      },
      "snapshotSpec": {
        "description": "string",
        "labels": "object"
      },

      // `snapshotSchedules[]` includes only one of the fields `retentionPeriod`, `snapshotCount`
      "retentionPeriod": "string",
      "snapshotCount": "string",
      // end of the list of possible fields`snapshotSchedules[]`

    }
  ],
  "nextPageToken": "string"
}
Field Description
snapshotSchedules[] object

List of snapshot schedules in the specified folder.
snapshotSchedules[].
id		 string

ID of the snapshot schedule.
snapshotSchedules[].
folderId		 string

ID of the folder that the snapshot schedule belongs to.
snapshotSchedules[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
snapshotSchedules[].
name		 string

Name of the snapshot schedule.

The name is unique within the folder.
snapshotSchedules[].
description		 string

Description of the snapshot schedule.
snapshotSchedules[].
labels		 object

Snapshot schedule labels as key:value pairs.
snapshotSchedules[].
status		 string
Status of the snapshot schedule.
  • CREATING: The snapshot schedule is being created.
  • ACTIVE: The snapshot schedule is on: new disk snapshots will be created, old ones deleted (if [SnapshotSchedule.retention_policy] is specified).
  • INACTIVE: The schedule is interrupted, snapshots won't be created or deleted.
  • DELETING: The schedule is being deleted.
  • UPDATING: Changes are being made to snapshot schedule settings or a list of attached disks.
snapshotSchedules[].
schedulePolicy		 object
Frequency settings of the snapshot schedule.
snapshotSchedules[].
schedulePolicy.
startAt		 string (date-time)

Timestamp for creating the first snapshot.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
snapshotSchedules[].
schedulePolicy.
expression		 string

Cron expression for the snapshot schedule (UTC+0).

The expression must consist of five fields (Minutes Hours Day-of-month Month Day-of-week) or be one of nonstandard predefined expressions (e.g. @hourly). For details about the format, see documentation
snapshotSchedules[].
snapshotSpec		 object
Attributes of snapshots created by the snapshot schedule.
snapshotSchedules[].
snapshotSpec.
description		 string

Description of the created snapshot.
snapshotSchedules[].
snapshotSpec.
labels		 object

Snapshot labels as key:value pairs.
snapshotSchedules[].
retentionPeriod		 string
snapshotSchedules[] includes only one of the fields retentionPeriod, snapshotCount

Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is automatically deleted.
snapshotSchedules[].
snapshotCount		 string (int64)
snapshotSchedules[] includes only one of the fields retentionPeriod, snapshotCount

Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted after the sixth one is created, the second is deleted after the seventh one is created, and so on.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use next_page_token as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.
© 2023 Nebius Israel Ltd
In this article: