- 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 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 Cluster 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 Schedule-Based 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 SLA-Based Backup Policies
- getGet Collection of SLA-Based Backup Policies
- postCreate SLA-Based Backup Policy
- getGet SLA-Based Backup Policy Data
- putModify SLA-Based Backup Policy
- delDelete SLA-Based Backup Policy
- getGet SLA Compliance Information
- getGet Resources Excluded from SLA-Based Backup Policy
- getGet Resources Protected by SLA-Based Backup Policy
- getGet AWS Regions Selected for SLA-Based Backup Policy
- postEnable SLA-Based Backup Policy
- postDisable SLA-Based Backup Policy
- postSet SLA-Based Backup Policy Priority
- postExport Collection of SLA-Based Backup Policies
- postCalculate Estimated Cost for SLA-Based Policy
- getGet SLA-Based Backup Policy Estimated Cost
- getGet SLA Results per Period
- getGet SLA Compliance per EC2 Instance
- getGet SLA-Based Backup Policy Sessions per EC2 instance
- getGet SLA-Based Backup Policy Session Log per EC2 Instance
- 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
- postRemove Backups of Multiple EC2 Instances
- 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
- Global Retention Settings
- IAM Roles
- Infrastructure
- 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
- Identity Provider
- Immutability Settings
- 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 RDS Resource Restore from Backup
- postValidate RDS Resource Restore from Snapshot
- getGet RDS Resource Restore Point Databases List
- 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
- getGet Collection of Redshift Serverless Namespaces
- postPerform Infrastructure Rescan for Redshift Serverless Namespaces
- getGet Redshift Serverless Namespace Data
- postCreate Backup of Redshift Serverless Namespace
- postRemove Backups of Redshift Serverless Namespace
- postRemove Backups of Multiple 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
- Security Certificates
- Sessions
- Sla Templates
- Storage Templates
- 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
This section describes the latest changes and features introduced in the Veeam Backup for AWS REST API 1.8-rev0. To use this version of the REST API specification, when performing an operation, specify the 1.8-rev0 value in the x-api-version header of an HTTP request. For more information on Veeam Backup for AWS REST API versioning, see Versioning.
Breaking changes cause REST API 1.8-rev0 to function differently and could affect the client code.
The following change in the REST API schema was made:
OrganizationSettingsExportModelschema:- The
limitedScopeIdproperty was replaced by thelimitedScopeName, and the property type has changed from UUID to string.
- The
The topic provides information on operation, parameter and schema changes made in the Veeam Backup for AWS REST API 1.8-rev0.
The following changes in the REST API schemas were made:
HTTP POST
/api/v1/accounts/amazonrequest:- The
AmazonAccountCreateSpecschema was replaced by theAmazonAccountAddExistingSpec.
- The
HTTP GET
/api/v1/sessionsrequest:- The optional
VmIdparameter was removed.
- The optional
FlrSessionschema:- Added the
resultandstatusrequired properties.
- Added the
RdsRestorePointsPageschema:- The required property
totalCountnow appears first, followed by theresultsrequired property.
- The required property
NoKeyPairAuthenticationTypeschema:- The
CloudAccountenum value was replaced by theIamRole.
- The
RdsJobTypesschema:- The
RemoteSnapshotenum value was replaced by theReplica.
- The
SessionsFiltersschema:- Added the
ToUtcproperty.
- Added the
VmRestorePointschema:- The
pointInTime,publishStateandpublishUntilresponse properties are returned in UTC date and time.
- The
NotificationSettingsschema:- The
supressNotificationsUntilLastTryresponse property was replaced by thesuppressNotificationsUntilLastRetry.
- The
VirtualMachineSnapshotSpecschema:- The
CopyTagsFromVolumeEnabledparameter was replaced by theCopyTagsFromVolume.
- The
RdsSnapshotSpecschema:- The
CopyTagsFromInstanceEnabledparameter was replaced by theCopyTagsFromInstance.
- The
DynamoDbBackupSpecificationschema:- The
CopyTagsFromTableEnabledparameter was replaced by theCopyTagsFromTable.
- The
RedshiftBackupSpecificationschema:- The
CopyTagsFromInstanceEnabledparameter was replaced by theCopyTagsFromCluster.
- The
EfsBackupSpecificationschema:- The
CopyTagsFromVolumeEnabledparameter was replaced by theCopyTagsFromFileSystem.
- The
FsxBackupSpecificationschema:- The
CopyTagsFromInstanceEnabledparameter was replaced by theCopyTagsFromFileSystem.
- The
The REST API 1.8-rev0 introduces new resource collections and operations that support new features released in the latest version of Veeam Backup for AWS.
The following new resource collections were introduced in the Veeam Backup for AWS REST API 1.8-rev0:
/policy/ec2SlaBasedPolicies— you can view and configure EC2 SLA-based backup policies in Veeam Backup for AWS and retrieve SLA compliance results of each SLA-based backup policy./policyTemplates/slaTemplates— you can view and configure SLA templates in Veeam Backup for AWS./policyTemplates/storageTemplates— you can view and configure storage templates in Veeam Backup for AWS.
The following new operations were added to the existing resource collections in the Veeam Backup for AWS REST API 1.8-rev0:
- POST
/api/v1/accounts/amazon/create— creates an IAM role in AWS and adds the role to the Veeam Backup for AWS configuration database. - POST
/api/v1/virtualMachines/deleteBackups— removes entire backup chains of specified EC2 instances. - POST
/api/v1/rds/deleteBackups— removes entire backup chains of specified RDS resources. - POST
/api/v1/dynamoDb/deleteBackups— removes backups of specified DynamoDB tables. - POST
/api/v1/redshift/deleteBackups— removes backups of specified Redshift clusters. - POST
/api/v1/redshiftServerless/deleteBackups— removes backups of specified Redshift Serverless namespaces. - POST
/api/v1/efs/deleteBackups— removes backups of specified EFS file systems. - POST
/api/v1/fsx/deleteBackups— removes backups of specified FSx file systems.
The following endpoints were deleted in the Veeam Backup for AWS REST API 1.8-rev0:
- POST
/api/v1/accounts/amazon/{IAMRoleId}/rescan— runs the infrastructure rescanning operation for an IAM role with the specified ID. - GET
/api/v1/amazonConnections/{amazonConnectionId}/rdsSubnetGroups— retrieves a list of all DB subnet groups available for an Amazon connection with the specified ID. - GET
/api/v1/amazonConnections/{amazonConnectionId}/redshiftSubnetGroups— retrieves a list of all Redshift subnet groups available for an Amazon connection with the specified ID.