- 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
Veeam Backup for AWS REST API 1.0 (1.7-rev0)
Download OpenAPI specification:Download
Veeam Backup for AWS exposes its entities through an application programming interface (API) based on the Representational State Transfer (REST) architecture style. The REST API allows developers to query information about Veeam Backup for AWS entities and perform basic operations with these entities using HTTP requests and standard HTTP methods.
The Veeam Backup for AWS REST API is a resource-based application programming interface that uses Hypertext Application Language (HAL). HAL expresses the resources and relationships between them as hyperlinks, and enables navigation through the API. All individual resources have a JSON representation and system resource identifiers to help you locate a resource by its URL. Resources of the same entity type comprise a collection. A collection is modeled as an array of objects. Every collection includes hyperlinks that end with resource identifiers and point at its individual resources, related resources and collections.
The Veeam Backup for AWS REST API relies on the client-server model. The client makes a request to the server; the server processes the request and returns a response with a conventional HTTP response code, HTTP response headers and a response body in the JSON format (by default).
The Veeam Backup for AWS REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
For visual representation of all operations available in REST API 1.7-rev0, see the Veeam Backup for AWS REST API Reference Map.
Veeam Backup for AWS controls access to its functionality with the help of user roles. A role defines what operations users can perform and what range of data is available to them in the Veeam Backup for AWS REST API. In the REST API Reference, the x-veeam-authorize
parameter displays what user roles have permissions to perform a specific operation. For more information on user roles, see the Veeam Backup for AWS User Guide, section Managing Permissions.