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

The following change in the REST API schema was made:

• HTTP POST /api/v1/cloudInfrastructure/buckets/rescan/{IdentityId} request:

  • The in-path parameter IAMRoleId was replaced by the IdentityId parameter.

• HTTP POST /api/v1/repositories and HTTP POST /api/v1/repositories/{repositoryId} requests:

  • Added the Repository required parameter.

• HTTP PUT /api/v1/vpc/policy request:

  • The AccountRegionSpecification response body schema replaced by the AdditionalVpcRegionsToProtectSpecification schema.

• HTTP POST /api/v1/workers/networkConfiguration/production request:

  • Added the settingsType required body parameter.

• HTTP GET /api/v1/amazonConnetionId/rdsSecurityGroups request:

  • The NameFilter query parameter was replaced by the SearchPattern parameter.

• Ec2PolicySpec, RdsPolicySpec, EfsPolicySpecification, FsxPolicySpecification, DynamoDbPolicySpecification, RedshiftPolicySpecification request body schemes:

  • The IAMRoleId required body parameter was replaced by the IdentityId required body parameter.

• Ec2PolicyExportModel, RdsPolicyExportModel, EfsPolicyExportModel, FsxPolicyExportModel, DynamoDbPolicyExportModel, RedshiftPolicyExportModel request body schemes:

  • The amazonAccountName required body parameter was replaced by the IdentityName body parameter.

• EfsPolicyRegion, EfsPolicyBackupRegion, FsxPolicyRegion and FsxPolicyBackupRegion, DynamoDbPolicyRegion, DynamoDbPolicyBackupRegion and RedshiftPolicyBackupRegion schemes:

  • The backupVaultId required parameter was replaced by the vaultId required parameter and moved to the AwsBackupVaultByIdSpec sub-schema.

• RegionProductionSettingsAwsAccountSpec request body schema:

  • The AvailableZoneId required body parameter was replaced by the AvailabilityZoneId required body parameter.

• RepositoryCreateSpec request body schema:

  • The IAMRoleId required body parameter was replaced by the IdentityId body parameter.

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

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

• Added the resourceAwsAccountId query parameter to the following operations:

  • HTTP GET /api/v1/virtualMachines/restorePoints — Get EC2 Instance Restore Points.
  • HTTP GET /api/v1/rds/restorePoints — Get RDS Resource Restore Points.
  • HTTP GET /api/v1/dynamoDb/restorePoints — Get DynamoDB 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.
  • HTTP GET /api/v1/redshiftServerless/restorePoints — Get Redshift Serverless Restore Points.

The following changes in the REST API schemas were made:

• HTTP GET /api/v1/vpc/policy request:

  • The AccountRegion response body schema replaced by AdditionalVpcRegionsToProtectModel schema.

• HTTP PUT /api/v1/vpc/policy request:

  • Deleted the IAMRoleId optional body parameter from the VpcPolicySpecification request body schema.

• HTTP POST /api/v1/fsx/restorePoints/{restorePointId}/restore request:

  • Added the activeDirectoryServiceAccountPassword optional body parameter to the FsxRestoreSpecification request body schema.

• AuthenticationSpecification schema:

  • Added the OrganizationAccount enum value.

• VpcPolicy schema:

  • Added the protectedRegions optional property.

• RedshiftRestorePoint schema:

  • Added the resourceAwsAccountId optional property.

• Ec2Policy, RdsPolicy, EfsPolicy, FsxPolicy, DynamoDbPolicy, RedshiftPolicy schemes:

  • The IAMRoleId required parameter was replaced by the IdentityId parameter.

• Ec2PolicyExportModel, RdsPolicyExportModel, EfsPolicyExportModel, FsxPolicyExportModel, DynamoDbPolicyExportModel, RedshiftPolicyExportModel schemes:

  • The amazonAccountName required parameter was replaced by the IdentityName parameter.

• RepositoryUpdateSpec request body schema:

  • The IAMRoleId optional body parameter was replaced by the IdentityId optional body parameter.

• Repository schema:

  • The IAMRoleId required parameter was replaced by the Identity required parameter.

• DateTime schema:

  • Added the serverDateTime required property.

• VmRestorePoint, RdsRestorePoint, EfsRestorePoint, FsxRestorePoint, DynamoDbRestorePoint, RedshiftRestorePoint and RedshiftServerless schemes:

  • Added the restorePointAwsAccountId optional property.

• RegionProductionSettings schema:

  • Added the settingsType required property and the awsAccount and organization optional properties.

• AmazonAccountCreateSpec schema:

  • Deleted the accessKey optional parameter and AmazonAccountAccessKeysCreateSpec sub-schema.

• AmazonAccountUpdateSpec schema:

  • Deleted the accessKey optional parameter and AmazonAccountAccessKeysUpdateSpec sub-schema.

• AmazonAccount schema:

  • Deleted the accessKey optional property and AmazonAccountAccessKeys sub-schema.

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

• /cloudInfrastructure — you can create IAM role templates and perform infrastructure rescan for AWS resources within AWS Organizations.
• /organizations — you can view and manage AWS Organizations that can be used as a source for backup policies.
• /redshiftServerless — you can view and manage Redshift Serverless namespaces that reside in AWS Regions selected in the backup policy settings and can be protected by Veeam Backup for AWS.
• /redshiftServerless/policies — you can view and manage Redshift Serverless backup policies created in Veeam Backup for AWS.
• /redshiftServerless/restorePoints — you can view and manage restore points created for Redshift Serverless namespaces in Veeam Backup for AWS.
• /flrOperations — ou can use a set of requests to restore individual files and folders of an EC2 instance to the original location.

The following new operations were added to the existing resource collections in the Veeam Backup for AWS REST API 1.7-rev0:

• POST /api/v1/rds/restorePoints/{restorePointId}/restoreBackup — performs database recovery of a PostgreSQL DB instance to a restore point with the specified ID.
• POST /api/v1/rds/restorePoints/{restorePointId}/validateRestore — checks whether the restore settings specified for the restore operation of the RDS resource from a cloud-native snapshot are valid.