This is an archive version of the document. To get the most up-to-date information, see the current version.Schemas
The following JSON schema is used to represent resources in the /virtualMachines collection in the Veeam Backup for AWS REST API. Properties included in schemas represent EC2 Instance details. Some of the properties can be used in POST and PUT requests as well as for query parameter values in GET requests.
VirtualMachine
Property | Type | Description |
|---|---|---|
id | string($uuid) | System ID assigned to an EC2 instance role in the Veeam Backup for AWS REST API. |
name | string | Name of the EC2 instance. |
awsResourceId | string | AWS ID of the EC2 instance. |
protectionStatus | string | Protection status of the EC2 instance: Protected, Unprotected. |
backupDestinations | string | Type of restore points of the EC2 instance: Snapshot (EC2 instance has snapshots), AwsBlob (EC2 instance has backups), ManualSnapshot (snapshot of the EC2 instance was taken manually). |
location | array | Sistem ID and name of an AWS region where the EC2 instance is located. Note: The location property can be used as a value for the Sort parameter: locationAsc, locationDesc. |
isDeleted | boolean | Defines whether the EC2 instance was removed from the AWS infrastructure. |
_links | array | A list of methods and operations available for the EC2 instance in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |