- About Veeam Backup for AWS REST API
- Overview
- How To
- Changelog
- Authorization
- Authorization (Single Sign-On)
- Appliance Connection Test
- Appliance Configuration Overview
- Appliance Statistics
- Appliance System Info
- Amazon Connections
- getGet Collection of Amazon Connections
- postAdd Amazon Connection
- getGet Amazon Connection Data
- delRemove Amazon Connection
- getGet Collection of Availability Zones
- postCheck Permissions for Performing Restore
- postVerify EC2 Instance Details
- postVerify RDS Resource Details
- getGet Collection of Encryption Keys
- getGet Collection of VPCs
- getGet Collection of Security Groups
- getGet Collection of Route Tables
- getGet Collection of Amazon Machine Images
- postVerify EC2 Instance AMI
- getGet Collection of Subnets
- getGet Collection of AWS Outposts
- getGet Collection of Option Groups
- getGet Collection of Parameter Groups
- getGet Collection of Cluster Parameter Groups
- getGet Collection of DB Subnet Groups
- getGet Collection of VPC Security Groups
- getGet Collection of RDS Licenses
- getGet Collection of DB Instance Classes
- getValidate S3 Endpoint
- postValidate Worker Settings
- getGet Collection of AWS Managed Microsoft Active Directories (ADs)
- getGet Collection of Redshift Subnet Groups
- getGet Collection of Redshift Parameter Groups
- getGet Collection of Redshift Node Configurations
- getGet Collection of IAM roles
- getGet Collection of Instance Profiles
- Amazon S3 Buckets
- AWS Regions
- AWS Tags
- Backup Vaults
- Backup Repositories
- Configuration Backup and Restore
- getGet Configuration Backup Settings
- putModify Configuration Backup Settings
- postEnable Configuration Backup Schedule
- postDisable Configuration Backup Schedule
- getGet Configuration Backup Restore Points
- getGet Configuration Backup Restore Point Data
- delRemove Configuration Backup Restore Point
- postCreate Configuration Backup
- postRestore Backup Appliance Configuration
- postCheck Configuration
- getGet Configuration Check Results
- postComplete Configuration Restore
- postStart Configuration Backup Export
- getCheck Status of Configuration Backup Export
- postDownload Configuration Backup File
- postImport Configuration Backup File
- delRemove Imported Configuration Backup File
- postCheck Imported Backup File
- getGet List of Uploaded Configuration Backup Files
- getGet Configuration Backup and Restore Session Data
- Database Accounts
- DynamoDB Backup Policies
- getGet Collection of DynamoDB Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet Resources Protected by DynamoDB Backup Policy
- getGet AWS Regions Selected for Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postExport Collection of Backup Policies
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- DynamoDB Restore Points
- DynamoDB Tables
- EC2 Backup Policies
- getGet Collection of EC2 Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet AWS Regions Selected for Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet Resources Protected by EC2 Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- postExport Collection of Backup Policies
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- EC2 Instances
- getGet Collection of EC2 Instances
- postPerform Infrastructure Rescan for EC2 Instances
- getGet EC2 Instance Data
- postCreate Snapshot of EC2 Instance
- postRemove Snapshots of EC2 Instance
- postRemove Backups of EC2 Instance
- delRemove Restore Points of EC2 Instance
- getGet EBS Volumes
- postExport Collection of EC2 Instances
- EC2 Restore Points
- getGet EC2 Instance Restore Points
- getGet EC2 Instance Restore Point Data
- postPerform Volume-Level Restore
- postValidate Volume-Level Restore
- postPerform EC2 Instance Restore
- postValidate EC2 Instance Restore
- postPerform EC2 File-Level Restore
- getGet Default Network Settings of Restore Point
- getGet Collection of Data Retrieval Sessions
- getGet Data Retrieval Session Data
- postRetrieve Data From Archive
- postExtend Data Availability Period
- postGet Data Retrieval Sessions for Restore Point
- EFS Backup Policies
- getGet Collection of EFS Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet Resources Protected by EFS Backup Policy
- getGet AWS Regions Selected for Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postExport Collection of Backup Policies
- EFS File Systems
- EFS Restore Points
- File-Level Recovery
- FSx Backup Policies
- getGet Collection of FSx Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet AWS Regions Selected for Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postExport Collection of Backup Policies
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- FSx File Systems
- FSx Restore Points
- Redshift Backup Policies
- getGet Collection of Redshift Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet AWS Regions Selected for Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postExport Collection of Backup Policies
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- Redshift Restore Points
- Redshift Clusters
- Redshift Serverless Namespaces
- Redshift Serverless Backup Policies
- getGet Collection of Redshift Serverless Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet AWS Regions Selected for Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postExport Collection of Backup Policies
- Redshift Serverless Restore Points
- Global Retention Settings
- IAM Roles
- Organizations
- postPerform Rescan of AWS Organization Structure
- getGet Collection of AWS Organizations
- postAdd AWS Organization
- getGet AWS Organization Data
- putModify AWS Organization
- delRemove AWS Organization
- postGet AWS Organization Structure Rescan Results
- postGet Structure of AWS Organization Added to Veeam Backup for AWS
- postValidate Removing of AWS Organization
- postValidate Removing of Multiple AWS Organizations
- postCheck AWS Organization Configuration
- postExport Collection of AWS Organizations
- postCheck Adding AWS Organization
- postValidate AWS Organization Name
- postValidate AWS Organization Settings
- Infrastructure
- Identity Provider
- Immutability Settings
- Initial Configuration
- License Agreements
- Licensing
- RDS Backup Policies
- getGet Collection of RDS Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- getGet Resources Protected by Backup Policy
- getGet AWS Regions Selected for Backup Policy
- getGet Resources Excluded from Backup Policy
- getGet Resources Protected by RDS Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- getExport Backup Policy Settings
- postImport Backup Policy Settings
- postValidate Backup Policy Settings
- postSet Backup Policy Priority
- postExport Collection of Backup Policies
- postCalculate Estimated Cost for Backup Policy
- getGet Backup Policy Estimated Cost
- RDS Resources
- RDS Restore Points
- getGet RDS Resource Restore Points
- getGet RDS Resource Restore Point Data
- delRemove RDS Resource Restore Point
- postPerform RDS Resource Restore
- postPerform DB Instance Database Restore
- postValidate the RDS Resource Restore from Backup
- postValidate RDS Resource Restore from Snapshot
- getGet RDS Resource Restore Point Databases List
- Security Certificates
- Sessions
- SMTP Accounts
- Time Zone
- User Accounts
- getGet Collection of Users
- postAdd User Account
- getGet Collection of User Roles
- getGet User Data
- putModify User Account
- delRemove User Account
- postValidate User Name
- postValidate User Description
- postValidate User Password
- postGet MFA Secret Key
- postEnable MFA for User
- postDisable MFA for User
- getVerify First Login
- postValidate Backup Appliance Instance ID
- postCreate Default User
- postExport Collection of Users
- Veeam Backup for AWS Version
- VPC Configuration Backup Policy
- VPC Configuration Restore Points
- getGet VPC Configuration Restore Points
- getGet VPC Configuration Restore Point Data
- getGet Backed-Up VPC Configuration Items
- getGet Collection of Backed-Up VPCs
- postCheck IAM Role Permissions
- postCompare VPC Configuration
- postPerform VPC Configuration Restore
- postValidate VPC Configuration Restore
- postExport Backed-Up VPC Configuration
- postRemove VPC Configuration Backups
- Workers
- getGet Collection of Worker Profiles
- postAdd Worker Profiles
- getGet Worker Profiles for Region
- putModify Worker Profiles
- delRemove Worker Profiles
- getGet IAM Role Used to Launch Worker Instances
- putChange IAM Role Used to Launch Worker Instances
- getGet Collection of Worker Configurations
- postAdd Worker Configuration
- getGet Worker Configuration Data
- putModify Worker Configuration
- delRemove Worker Configuration
- getGet Worker Configurations for Production Accounts
- postAdd Worker Configuration for Production Account
- getGet Worker Configuration for Production Account Data
- putModify Worker Configuration for Production Account
- delRemove Worker Configuration for Production Account
- getGet Worker Custom Tags
- putModify Worker Custom Tags
The /virtualMachines/restorePoints
resource collection represents all restore points created for EC2 instances in Veeam Backup for AWS.
Get EC2 Instance Restore Points
The HTTP GET request to the /virtualMachines/restorePoints
endpoint retrieves a list of all restore points of EC2 instances in Veeam Backup for AWS.
query Parameters
VirtualMachineId | string <uuid> Returns only restore points of an EC2 instance with the specified ID. |
RestorePointAwsAccountId | string Returns only EC2 restore points stored in an AWS account with the specified ID. |
ResourceAwsAccountId | string Returns only EC2 restore points of an instance that belong to an AWS account with the specified ID. |
ResourceAwsOrganizationId | string Returns only EC2 restore points of an instance that belong to an AWS Organization with the specified ID. |
Offset | integer <int32> >= 0 Excludes from a response the first N items of a resource collection. |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response. |
Sort | Array of strings (VmRestorePointsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X GET \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints?VirtualMachineId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RestorePointAwsAccountId=string&ResourceAwsAccountId=string&ResourceAwsOrganizationId=string&Offset=0&Limit=-1&Sort=pointInTimeAsc' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 400
- 401
- 404
{- "totalCount": 0,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "virtualMachineId": "9762a6e8-4bff-4000-8b55-670896232de9",
- "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
- "jobType": "Backup",
- "pointInTime": "2019-08-24T14:15:22Z",
- "backupSizeBytes": 0,
- "volumes": [
- {
- "diskId": "string",
- "type": "Standard",
- "backupSizeBytes": 0,
- "iops": 0,
- "name": "string",
- "device": "string",
- "encryptionKey": "string",
- "encryptionKeyName": "string"
}
], - "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
- "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
- "storageClass": "S3",
- "publishState": "None",
- "publishedUntil": "2019-08-24T14:15:22Z",
- "healthState": "Healthy",
- "immutabilityInfo": {
- "immutabilityEnabled": true,
- "immutableTillUtc": "2019-08-24T14:15:22Z"
}, - "resourceAwsAccountId": "string",
- "restorePointAwsAccountId": "string",
- "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
], - "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
Get EC2 Instance Restore Point Data
The HTTP GET request to the /virtualMachines/restorePoints/{vmRestorePointId}
endpoint retrieves information on an EC2 instance restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X GET \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints/{vmRestorePointId}' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 401
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "virtualMachineId": "9762a6e8-4bff-4000-8b55-670896232de9",
- "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
- "jobType": "Backup",
- "pointInTime": "2019-08-24T14:15:22Z",
- "backupSizeBytes": 0,
- "volumes": [
- {
- "diskId": "string",
- "type": "Standard",
- "backupSizeBytes": 0,
- "iops": 0,
- "name": "string",
- "device": "string",
- "encryptionKey": "string",
- "encryptionKeyName": "string"
}
], - "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
- "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
- "storageClass": "S3",
- "publishState": "None",
- "publishedUntil": "2019-08-24T14:15:22Z",
- "healthState": "Healthy",
- "immutabilityInfo": {
- "immutabilityEnabled": true,
- "immutableTillUtc": "2019-08-24T14:15:22Z"
}, - "resourceAwsAccountId": "string",
- "restorePointAwsAccountId": "string",
- "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
Perform Volume-Level Restore
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/restoreDisk
endpoint performs EBS volume restore to a restore point with the specified ID.
Veeam Backup for AWS does not attach restored volumes to EC2 instances — restored volumes are placed as standalone EBS volumes to the specified location.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: required
required | Array of objects (DiskRestoreOptions) Specifies volume restore settings. |
reason | string Specifies a reason for the restore operation. |
object (AuthenticationSpecification) Specifies authentication settings used to perform the restore operation. | |
outpost | string Specifies AWS Outpost where the EBS volume must be restored. |
useProductionWorkers | boolean Defines whether to deploy worker instances in the target production account. By default, workers are deployed in the backup account. For more information, see the Veeam Backup for AWS User Guide. |
workerRoleId | string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role that will be attached to worker instances launched to perform restore operations in the production account. |
object (DiskBulkRestoreToAlternativeOptions) [Applies if you want to restore to a new location or with different settings] Specifies volume restore settings. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "authenticationSpecification": [
- {
- "authenticationType": "KeyPair",
- "authenticationKeyPair": [
- {
- "accessKey": "AKIAY4ZWOU4BJ2VRJJPX",
- "secretKey": "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"
}
]
}
], - "volumes": [
- {
- "diskId": "vol-07e0c86bf2f217dcf"
}
]
}
- 202
- 400
- 401
- 404
{- "sessionId": "46c83tya-kl67-4a15-ab7e-4c4a76fbc9a1",
- "_links": [
- {
- "method": "GET",
- "rel": "self",
}
]
}
Validate Volume-Level Restore
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/validateRestoreDisk
endpoint checks whether restore settings specified for the restore operation of the EBS volume are valid.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: required
required | Array of objects (DiskRestoreOptions) Specifies volume restore settings. |
reason | string Specifies a reason for the restore operation. |
object (AuthenticationSpecification) Specifies authentication settings used to perform the restore operation. | |
outpost | string Specifies AWS Outpost where the EBS volume must be restored. |
useProductionWorkers | boolean Defines whether to deploy worker instances in the target production account. By default, workers are deployed in the backup account. For more information, see the Veeam Backup for AWS User Guide. |
workerRoleId | string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role that will be attached to worker instances launched to perform restore operations in the production account. |
object (DiskBulkRestoreToAlternativeOptions) [Applies if you want to restore to a new location or with different settings] Specifies volume restore settings. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "authenticationSpecification": [
- {
- "authenticationType": "KeyPair",
- "authenticationKeyPair": [
- {
- "accessKey": "AKIAY4ZWOU4BJ2VRJJPX",
- "secretKey": "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"
}
]
}
], - "volumes": [
- {
- "diskId": "vol-07e0c86bf2f217dcf"
}
]
}
- 200
- 400
- 401
- 404
[- {
- "severity": "Warning",
- "message": "string",
- "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}
]
Perform EC2 Instance Restore
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/restoreVm
endpoint performs restore of entire EC2 instance to a restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: required
required | object (AuthenticationSpecification) Specifies authentication settings used to perform the restore operation. |
reason | string Specifies a reason for the restore operation. |
startInstance | boolean Defines whether to start the restored EC2 instance after the restore operation is completed. |
restorePrivateIp | boolean Defines whether to restore the private IP address. |
useProductionWorkers | boolean Defines whether to deploy worker instances in the target production account. By default, workers are deployed in the backup account. For more information, see the Veeam Backup for AWS User Guide. |
workerRoleId | string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role that will be attached to worker instances launched to perform restore operations in the production account. |
assignPublicIp | boolean Defines whether to assign a public IP address to the restored instance. |
object (VirtualMachineToAlternativeRestoreOptions) [Applies if you want to restore to a new location or with different settings] Specifies restore settings. | |
imageId | string [Applies only if the original AMI used to launch the source instance cannot be found and you want to change the default AMI selected by Veeam Backup for AWS] Specifies an ID of the AMI that will be used to restore the instance. |
restoreInstanceProfile | boolean Defines whether to restore the instance profile attached to the restored instance. |
object (InstanceProfileSpec) Specifies the instance profile that will be attached to the restored instance. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "reason": "string",
- "authenticationSpecification": {
- "authenticationType": "CloudAccount",
- "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
- "authenticationKeyPair": {
- "accessKey": "string",
- "secretKey": "string"
}, - "authenticationOrganizationMemberAccount": {
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "limitedScopeId": "b6545d46-ca5a-4879-bb5f-c66e76373c5d"
}
}, - "startInstance": true,
- "restorePrivateIp": true,
- "useProductionWorkers": true,
- "workerRoleId": "64df62f7-ea74-4b40-a93f-13fb342a45e2",
- "assignPublicIp": true,
- "toAlternative": {
- "name": "string",
- "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
- "vmType": "string",
- "subnetId": "string",
- "networkSecurityGroupId": "string",
- "preserveEncryptionForVolumes": true,
- "encryptionKeyId": "string"
}, - "imageId": "string",
- "restoreInstanceProfile": true,
- "instanceProfile": {
- "mode": "Arn",
- "value": "string"
}
}
- 202
- 400
- 401
- 404
{- "sessionId": "46c39b1a-kl67-4a15-ab7e-4c4a76fbc9a1",
- "_links": [
- {
- "method": "GET",
- "rel": "self",
}
]
}
Validate EC2 Instance Restore
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/validateRestoreVm
endpoint checks whether restore settings specified for the restore operation of the EC2 instance are valid.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: required
required | object (AuthenticationSpecification) Specifies authentication settings used to perform the restore operation. |
reason | string Specifies a reason for the restore operation. |
startInstance | boolean Defines whether to start the restored EC2 instance after the restore operation is completed. |
restorePrivateIp | boolean Defines whether to restore the private IP address. |
useProductionWorkers | boolean Defines whether to deploy worker instances in the target production account. By default, workers are deployed in the backup account. For more information, see the Veeam Backup for AWS User Guide. |
workerRoleId | string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role that will be attached to worker instances launched to perform restore operations in the production account. |
assignPublicIp | boolean Defines whether to assign a public IP address to the restored instance. |
object (VirtualMachineToAlternativeRestoreOptions) [Applies if you want to restore to a new location or with different settings] Specifies restore settings. | |
imageId | string [Applies only if the original AMI used to launch the source instance cannot be found and you want to change the default AMI selected by Veeam Backup for AWS] Specifies an ID of the AMI that will be used to restore the instance. |
restoreInstanceProfile | boolean Defines whether to restore the instance profile attached to the restored instance. |
object (InstanceProfileSpec) Specifies the instance profile that will be attached to the restored instance. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "reason": "string",
- "authenticationSpecification": {
- "authenticationType": "CloudAccount",
- "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
- "authenticationKeyPair": {
- "accessKey": "string",
- "secretKey": "string"
}, - "authenticationOrganizationMemberAccount": {
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "limitedScopeId": "b6545d46-ca5a-4879-bb5f-c66e76373c5d"
}
}, - "startInstance": true,
- "restorePrivateIp": true,
- "useProductionWorkers": true,
- "workerRoleId": "64df62f7-ea74-4b40-a93f-13fb342a45e2",
- "assignPublicIp": true,
- "toAlternative": {
- "name": "string",
- "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
- "vmType": "string",
- "subnetId": "string",
- "networkSecurityGroupId": "string",
- "preserveEncryptionForVolumes": true,
- "encryptionKeyId": "string"
}, - "imageId": "string",
- "restoreInstanceProfile": true,
- "instanceProfile": {
- "mode": "Arn",
- "value": "string"
}
}
- 200
- 400
- 401
- 404
[- {
- "severity": "Warning",
- "message": "string",
- "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}
]
Perform EC2 File-Level Restore
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/restoreFile
endpoint starts a FLR session to restore of files and folders of an EC2 instance to a restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: application/jsonrequired
reason | string Specifies a reason for the restore operation. |
countShards | integer Specifies the incoming write bandwidth value of the Kinesis Data Stream (MB per second). |
useProductionWorkers | boolean Defines whether to deploy worker instances in the target production account. By default, workers are deployed in the backup account. For more information, see the Veeam Backup for AWS User Guide. |
workerRoleId | string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role that will be attached to worker instances launched to perform restore operations in the production account. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "reason": "string",
- "countShards": 0,
- "useProductionWorkers": true,
- "workerRoleId": "64df62f7-ea74-4b40-a93f-13fb342a45e2"
}
- 202
- 400
- 401
- 403
- 404
{- "sessionId": "cb7b83bc-ca21-40a0-8d67-c57b34498785",
- "_links": [
- {
- "method": "GET",
- "rel": "self",
}
]
}
Get Default Network Settings of Restore Point
The HTTP GET request to the /virtualMachines/restorePoints/{vmRestorePointId}/defaultNetworkSettings
endpoint retrieves the default network settings of a restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X GET \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints/{vmRestorePointId}/defaultNetworkSettings' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 401
- 404
{- "restorePointId": "22288dd2-163c-4059-96db-f1e40ffeffff",
- "networkName": "Default (172.31.0.0/16)",
- "networkId": "vpc-66a3c80e",
- "subNetworkName": "172.31.16.0/20 (eu-central-1a)",
- "subNetworkId": "subnet-32ccfd5a",
- "securityGroupName": "Veeam Generic Access",
- "securityGroupId": "sg-056f236c9d4e788a7"
}
Get Collection of Data Retrieval Sessions
The HTTP GET request to the /virtualMachines/restorePoints/dataRetrievals
endpoint retrieves a list of all data retrieval sessions.
query Parameters
Offset | integer <int32> >= 0 Excludes from a response the first N items of a resource collection. |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response. |
Sort | Array of strings (VmRestorePointDataRetrievalsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X GET \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints/dataRetrievals?Offset=0&Limit=-1&Sort=publishStateAsc' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 400
- 401
- 404
{- "totalCount": 0,
- "results": [
- {
- "vmRestorePointId": "52d14fc1-6db8-4239-b850-1518ae8829ee",
- "state": "None",
- "isReady": true,
- "tier": "Standard",
- "retrievedUntilUtc": "2019-08-24T14:15:22Z",
- "notifyBeforeHours": 0,
- "storageClass": "S3",
- "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
], - "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
Get Data Retrieval Session Data
The HTTP GET request to the /virtualMachines/restorePoints/{vmRestorePointId}/dataRetrieval
endpoint retrieves a data retrieval session with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X GET \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints/{vmRestorePointId}/dataRetrieval' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 400
- 401
- 404
{- "vmRestorePointId": "52d14fc1-6db8-4239-b850-1518ae8829ee",
- "state": "None",
- "isReady": true,
- "tier": "Standard",
- "retrievedUntilUtc": "2019-08-24T14:15:22Z",
- "notifyBeforeHours": 0,
- "storageClass": "S3",
- "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}
Retrieve Data From Archive
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/dataRetrievals/start
endpoint retrieves data of an archived restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: application/jsonrequired
tier required | string (VmRestorePointDataRetrievalTier) Retrieval option used to retrieve the data. |
days required | integer <int32> >= 1 Specifies the number of days for which the retrieved data will be kept. |
notifyBeforeHours | integer <int32> >= 1 Specifies the time when a notification will be sent (in hours remaining until the expiration). |
notifyAfterCompletion | boolean Defines whether to send a notification after the data retrieval is completed. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "tier": "Standard",
- "days": 1,
- "notifyBeforeHours": 1,
- "notifyAfterCompletion": true
}
- 202
- 400
- 401
- 404
{- "sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
- "_links": [
- {
- "method": "GET",
- "rel": "self",
}
]
}
Extend Data Availability Period
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/dataRetrievals/prolongate
endpoint extends the data availability period of a retrieved restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
Request Body schema: application/jsonrequired
days required | integer <int32> >= 1 Specifies the number of days for which the data availability period will be extended. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "days": 1
}
- 202
- 400
- 401
- 404
{- "sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
- "_links": [
- {
- "method": "GET",
- "rel": "self",
}
]
}
Get Data Retrieval Sessions for Restore Point
The HTTP POST request to the /virtualMachines/restorePoints/{vmRestorePointId}/dataRetrieval/sessions
endpoint returns a list of all data retrieval sessions run for an archived restore point with the specified ID.
path Parameters
vmRestorePointId required | string <uuid> System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API. |
header Parameters
x-api-version required | string Default: 1.7-rev0 Specifies the current version and revision of the Veeam Backup for AWS REST API. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.
Service Unavailable
Gateway Timeout
- curl
- Python
- JavaScript
- C#
- Go
curl -i -X POST \ 'https://helpcenter.veeam.com/api/v1/virtualMachines/restorePoints/{vmRestorePointId}/dataRetrieval/sessions' \ -H 'Authorization: YOUR_API_KEY_HERE' \ -H 'x-api-version: 1.7-rev0'
- 200
- 400
- 401
{- "sessions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
- "name": "string",
- "type": "Policy",
- "extendedSessionType": "Other",
- "executionStartTime": "2019-08-24T14:15:22Z",
- "executionStopTime": "2019-08-24T14:15:22Z",
- "executionDuration": 0,
- "status": "Running",
- "result": "Running",
- "reason": "string",
- "usn": 0,
- "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
], - "_embedded": {
- "backupJobInfo": {
- "rel": "string",
- "href": "string",
- "method": "GET"
}, - "restoreJobInfo": {
- "rel": "string",
- "href": "string",
- "method": "GET"
}, - "retentionJobDeletedRestorePoints": {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
}
}
], - "_links": [
- {
- "rel": "string",
- "href": "string",
- "method": "GET"
}
]
}