Contact usConsole
© 2023 Nebius Israel Ltd
Compute Cloud

Compute Cloud API, REST: SnapshotSchedule.create

Creates a snapshot schedule in the specified folder.

HTTP request

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

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "schedulePolicy": {
    "startAt": "string",
    "expression": "string"
  },
  "snapshotSpec": {
    "description": "string",
    "labels": "object"
  },
  "diskIds": [
    "string"
  ],

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

}
Field Description
folderId string

ID of the folder to create a snapshot schedule in.

Snapshots are created in the same folder as the schedule, even if disks from other folders are attached to the schedule.

To get a folder ID, make a list request.
name string

Name of the snapshot schedule.

The name must be unique within the folder.
description string

Description of the snapshot schedule.
labels object

Snapshot schedule labels as key:value pairs.
schedulePolicy object
Frequency settings of the snapshot schedule.
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).
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
snapshotSpec object
Attributes of snapshots created by the snapshot schedule.
snapshotSpec.
description		 string

Description of the created snapshot.
snapshotSpec.
labels		 object

Snapshot labels as key:value pairs.
diskIds[] string

List of IDs of the disks attached to the snapshot schedule.

To get a disk ID, make a list request.
retentionPeriod string
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.
snapshotCount string (int64)
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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.
description string

Description of the operation. 0-256 characters long.
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).
createdBy string

ID of the user or service account who initiated the operation.
modifiedAt string (date-time)

The time when the Operation resource was last modified.

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).
done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
© 2023 Nebius Israel Ltd
In this article: