post

/snapshots

Create a Snapshot of a VM, Volume, Database, Aurora, DynamoDB or Redshift. For Azure, currently only VM with managed disks is supported.

Request Parameters

2 Headers

Request Body

Schema
object
cloud_account_id
string

ID of the Cloud Provider Account. This value can be obtained by making the GET /cloud-accounts request.

1 validation + required
region_id
string

Region the resource belongs to. Refer to the Cloud Provider documentation.

required
resource_id
string

ID of the Resource for which the snapshot is to be taken. Refer to the Cloud Provider documentation.

required
resource_type
string

Type of the Resource for which the snapshot is to be taken

1 validation + required
resource_group_id
string

Required; Azure only. Azure Resource Group. Refer to the Cloud Provider documentation.

scripts
object

Scripts to run pre and post the Snapshot operation. Mutually exclusive to vss_enabled property. A script is valid if either of preSnapshotScript and postSnapshotScript or both are present.

vss_enabled
boolean

AWS only. Flag to indicate whether to use AWS VSS mechanism for Snapshot. Mutually exclusive to scripts property.

2 validations
retention
integer

Snapshot retention period in seconds

2 validations

Responses

Accepted

Schema
object
id
string

ID of the created Snapshot

1 validation
resource_id
string

ID of the Resource from which the Snapshot is created. Refer to the Cloud Provider documentation.

resource_type
string

Type of the Resource

1 validation
cloud_account_id
string

ID of the Cloud Provider Account.

1 validation
region_id
string

The region. Refer to the Cloud Provider documentation.

resource_group_id
string

Azure Resource Group. Refer to the Cloud Provider documentation.

status
string

Status of the Snapshot

2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.