This is an archive version of the document. To get the most up-to-date information, see the
current version.
Schemas
The following JSON schemas are used to represent resources in the /sessions collection in the Veeam Backup for AWS REST API. Properties included in schemas represent session details. Some of the properties can be used in POST requests as well as for query parameter values in GET requests.
Session
Property | Type | Description |
|---|
id | string($uuid) | System ID assigned to a session in the Veeam Backup for AWS REST API. | type | string | Type of the session: Policy, Job, Task, UserPolicy, RetentionActivity, RestoreTask, FLRTask, SelfBackupActivity. | executionStartTime | string($date-time) | Date and time when the session started. | executionStopTime | string($date-time) | Date and time when the session finished or stopped. | executionDuration | integer($int64) | Time taken to complete the latest job session (in ms). | status | string | Status of the session: Running, NeverExecuted, Succeeded, Warning, Failed, Canceled. | result | string | State of the session: Running, Success, Warning, Failed, Cancelled. | reason | string | | usn | integer($int64) | Update sequence number of the session. | _links | array | A list of methods and operations available for the session in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. | _embedded | SessionEmbeddedResources | A list of methods and operations available for the session type in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
|
SessionEmbeddedResources
Property | Type | Description |
|---|
backupJobInfo | link | Request URL used to get information on EC2 Instances protected during the session. | restoreJobInfo | link | Request URL used to get information on items restored during the session. | retentionJobDeletedRestorePoints | link | Request URL used to get information on restore points deleted during the session. |
|
LogItem
Property | Type | Description |
|---|
logTime | string($date-time) | Date and time of the operation performed during the session. | status | string | Operation status: NeverExecuted, Success, Warning, Error, Pending, Canceling, Canceled, Running, RunningWithWarning, RunningWithError. | message | string | Description of the operation. | executionStartTime | string($date-time) | Date and time when the operation started. | executionDuration | integer($int64) | Time taken to complete the operation. |
|
RetentionJobDeletedRestorePoint
Property | Type | Description |
|---|
id | string($uuid) | System ID assigned to a restore point in the Veeam Backup for AWS REST API. | name | string | Name of the restore point. | status | string | Status of restore point deletion: Succeeded, Warning, Failed. | region | string | AWS region where restore points were deleted. | _embedded | RetentionJobDeletedRestorePointEmbedded | A list of methods and operations used to get information on the restore point in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
|
RetentionJobDeletedRestorePointEmbedded
Property | Type | Description |
|---|
region | link | Request URL used to get information on the AWS region where the restore point was located. |
|
ProtectedItem
Property | Type | Description |
|---|
id | string($uuid) | System ID assigned to an EC2 instance in the Veeam Backup for AWS REST API. | name | string | Name of the EC2 instance. | status | string | Status of backup operation: Succeeded, Warning, Failed. | region | string | AWS region where the EC2 instance is located. | _embedded | ProtectedItemEmbedded | A list of methods and operations used to get information on the protected EC2 instance in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
|
ProtectedItemEmbedded
Property | Type | Description |
|---|
virtualMachine | link | Request URL used to get information on the EC2 instance. | region | link | Request URL used to get information on the AWS region where EC2 instance is located. |
|
RestoredItem
Property | Type | Description |
|---|
name | string | Name of a restored EC2 instance. | status | string | Status of restore operation: Succeeded, Warning, Failed. | regionName | string | AWS region where the restored EC2 instance is located. | _embedded | RestoreItemEmbedded | A list of methods and operations used to get information on the restored EC2 instance in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
|
RestoreItemEmbedded
Property | Type | Description |
|---|
virtualMachine | link | Request URL used to get information on the EC2 instance. | region | link | Request URL used to get information on the AWS region where EC2 instance is located. |
|