This section describes the latest changes and features introduced in the Veeam Backup for AWS REST API 1.6-rev0. To use this version of the REST API specification, when performing an operation, specify the 1.6-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.6-rev0 to function differently and could affect the client code.

The following change in the REST API schema was made:

• HTTP POST /api/v1/virtualMachines/{vmRestorePointId}/restoreVm request:

  • Added the InstanceProfileSpec subscheme to the VirtualMachineRestoreOptions request body schema.

The topic provides information on operation, parameter and schema changes made in the Veeam Backup for AWS REST API 1.6-rev0.

The following changes in operations were made:

• HTTP GET /api/v1/cloudBrowsers/{amazonConnectionId}/rdsSubnetGroups was replaced by the HTTP GET /api/v1/amazonConnections/{amazonConnectionId}/rdsSubnetGroups.
• HTTP GET /api/v1/cloudBrowsers/{amazonConnectionId}/rdsSecurityGroups was replaced by the HTTP GET /api/v1/amazonConnections/{amazonConnectionId}/rdsSecurityGroups.
• HTTP GET /api/v1/cloudBrowsers/{amazonConnectionId}/rdsLicense was replaced by the HTTP GET /api/v1/amazonConnections/{amazonConnectionId}/rdsLicense.
• HTTP GET /api/v1/cloudBrowsers/{amazonConnectionId}/rdsInstanceClasses was replaced by the HTTP GET /api/v1/amazonConnections/{amazonConnectionId}/rdsInstanceClasses.

The following new query parameters were added to the HTTP requests:

• Added the restorePointAwsAccountId query parameter to the following operations:

  • HTTP GET /api/v1/dynamoDb/restorePoints — Get DynamoDB Restore Points.
  • HTTP GET /api/v1/virtualMachines/restorePoints — Get EC2 Restore Points.
  • HTTP GET /api/v1/efs/restorePoints — Get EFS Restore Points.
  • HTTP GET /api/v1/fsx/restorePoints — Get FSx Restore Points.
  • HTTP GET /api/v1/rds/restorePoints — Get RDS Restore Points.
  • HTTP GET /api/v1/redshift/restorePoints — Get Redshift Restore Points.

• Added the resourceAwsAccountId query parameter to the following operations:

  • HTTP GET /api/v1/dynamoDb — Get Collection of DynamoDB Tables.
  • HTTP GET /api/v1/virtualMachines — Get Collection of EC2 Instances.
  • HTTP GET /api/v1/efs — Get Collection of EFS File Systems.
  • HTTP GET /api/v1/fsx — Get Collection of FSx File Systems.
  • HTTP GET /api/v1/rds — Get Collection of RDS Resources.
  • HTTP GET /api/v1/redshift — Get Collection of Redshift Clusters.

The following changes in the REST API schemas were made:

• HTTP POST /api/v1/vpc/restorePoints/{vpcRestorePointId}/compareWithProduction request:

  • The VpcComparsionWithProduction response body schema replaced by VpcComparisonWithProduction schema.

• HTTP GET /api/v1/cloudInfrastructure/regions request:

  • Added the EAmazonRegionOptInStatus subscheme to the Region response body schema.

• HTTP POST /api/v1/virtualMachines/policies request:

  • The EExcludedVolumesItemType response schema replaced by ExcludedVolumesItemType schema.

• HTTP POST /api/v1/virtualMachines/import request:

  • Added the tags and excludedVolumes optional parameters to the Ec2PolicyExcludedItemsExportModel schema.

• PolicyExcludedBackupItemsExportModel schema:

  • The volumes property replaced by excludedVolumes schema.

• VirtualMachine schema:

  • Added the resourceAwsAccountId required property.

• RdsPolicySpec and RdsPolicyCredentialsSpecialSpec schemes:

  • Added the databaseCredentialsId and rdsId required properties.

• PolicyVolumesExcludeExportModel schema:

  • Added the excludeSystemVolumes optional property.

• RdsPolicyBackupSettings schema:

  • Added the credentials optional property.

• RdsSpecialCredentialsExportModel schema:

  • Added the databaseCredentialsDisplayName and rds required properties.

• Rds,  Efs and DynamoDb schemes:

  • Added the resourceAwsAccountId required property.

• RdsCredentialsSpec schema:

  • Added the databaseCredentialsId optional property.

• UserPolicyType schema:

  • Added the Fsx and Redshift enum values.

• VmRestorePointsFilters, DynamoDbFilters and RdsFilters schemes:

  • Added the resourceAwsAccountId optional property.

• DynamoDbRestorePointsFilters schema:

  • Added the restorePointAwsAccountId optional property.

• Region schema:

  • Added the optInStatus required property.

• RdsPolicyCredentialsSpecialSpec schema:

  • Added the databaseCredentialsId and rdsId required properties.

• RdsBackupSettingsExportModel schema:

  • Added the defaultCredentials and credentials required properties.

• RdsSpecialCredentialsExportModel schema:

  • Added the databaseCredentialsDisplayName and rds required properties.

• DayNumbersInMonth schema:

  • Added the veryScheduledDay enum value.

• Error schema:

  • Added the orbidToDeleteFsxRestorePoint enum value.

• ERdsInstanceRestoreValidationProblemType schema:

  • Added the RestorePointIsCorrupted enum value.

• ExtendedSessionType schema:

  • Added the ManualRedshiftBackup, PolicyRedshiftBackup, RedshiftClusterRestore, ManualFsxBackup, PolicyFsxBackup, PolicyFsxBackupCopy and FsxInstanceRestore enum values.

• VmRestorePointsSortColumns schema:

  • Added the restorePointAwsAccountIdAsc and restorePointAwsAccountIdDesc enum values.

• RdsSortColumns schema:

  • Added the resourceAwsAccountIdAsc and resourceAwsAccountIdDesc enum values.

• RdsRestorePointSortColumns schema:

  • Added the restorePointAwsAccountIdAsc and restorePointAwsAccountIdDesc enum values.

• LicenseWorkloadTypes schema:

  • Added the DynamoDB, FSx and Redshift enum values.

• CloudAccountPermission schema:

  • Added the FsxBackup, FsxRestore, RedshiftBackup and RedshiftRestore enum values.

• RescanType and PolicyType schemes:

  • Added the Fsx and Redshift enum values.

• EVpcItemType schema:

  • Added the awsAccountIdAsc and awsAccountIdDesc enum values.

• EfsThroughputMode schema:

  • Added the Unknown and Elastic enum values.

• EfsSortColumns and DynamoDbSortColumns schemes:

  • Added the resourceAwsAccountIdAsc and resourceAwsAccountIdDesc enum values.

• VirtualMachinesSortColumns, EfsRestorePointSortColumns and DynamoDbRestorePointSortColumns schemes:

  • Added the restorePointAwsAccountIdAsc and restorePointAwsAccountIdDesc enum values.

• DeleteSnapshotType schema:

  • Added the Manual enum value.

The following changes in response codes of HTTP requests were made:

• Response code 202 Accepted was replaced by response code 200 OK in the POST /rds/restorePoints/{restorePointId}/validateRestoreBackup request.
• Response code 202 Accepted was replaced by response code 200 OK in the GET /api/v1/rds/restorePoints/{restorePointId}/databases request.

The REST API 1.6-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.6-rev0:

• /flrOperations — you can restore individual files and folders of an EC2 instance to the original location.
• /redshift — you can view and manage Redshift clusters that reside in AWS Regions selected in the backup policy settings and can be protected by Veeam Backup for AWS.
• /redshift/policies — you can view and manage Redshift backup policies created in Veeam Backup for AWS.
• /redshift/restorePoints — you can view and manage restore points created for Redshift clusters 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.6-rev0:

• GET /api/v1/amazonConnections/{amazonConnectionId}/cloudRouteTables — retrieves a list of all route tables available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/cloudDirectories — retrieves a list of all AWS Managed Microsoft ADs available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/redshiftSubnetGroups — etrieves a list of all Redshift subnet groups available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/redshiftParameterGroups — etrieves a list of all Redshift parameter groups available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/redshiftNodeOptions/{restorePointId} — retrieves a list of all possible Redshift node configurations available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/iamRoles — retrieves a list of all IAM roles available for an Amazon connection with the specified ID.
• GET /api/v1/amazonConnections/{amazonConnectionId}/instanceProfiles — retrieves a list of all instance profiles available for an Amazon connection with the specified ID.