Changelog

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

Breaking changes cause REST API 1.8-rev0 to function differently and could affect the client code.

Schema Changes Causing Compatibility Issues

The following change in the REST API schema was made:

  • OrganizationSettingsExportModel schema:

    • The limitedScopeId property was replaced by the limitedScopeName, and the property type has changed from UUID to string.

Resource Changes

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

Schema Changes

The following changes in the REST API schemas were made:

  • HTTP POST /api/v1/accounts/amazon request:

    • The AmazonAccountCreateSpec schema was replaced by the AmazonAccountAddExistingSpec.
  • HTTP GET /api/v1/sessions request:

    • The optional VmId parameter was removed.
  • FlrSession schema:

    • Added the result and status required properties.
  • RdsRestorePointsPage schema:

    • The required property totalCount now appears first, followed by the results required property.
  • NoKeyPairAuthenticationType schema:

    • The CloudAccount enum value was replaced by the IamRole.
  • RdsJobTypes schema:

    • The RemoteSnapshot enum value was replaced by the Replica.
  • SessionsFilters schema:

    • Added the ToUtc property.
  • VmRestorePoint schema:

    • The pointInTime, publishState and publishUntil response properties are returned in UTC date and time.
  • NotificationSettings schema:

    • The supressNotificationsUntilLastTry response property was replaced by the suppressNotificationsUntilLastRetry.
  • VirtualMachineSnapshotSpec schema:

    • The CopyTagsFromVolumeEnabled parameter was replaced by the CopyTagsFromVolume.
  • RdsSnapshotSpec schema:

    • The CopyTagsFromInstanceEnabled parameter was replaced by the CopyTagsFromInstance.
  • DynamoDbBackupSpecification schema:

    • The CopyTagsFromTableEnabled parameter was replaced by the CopyTagsFromTable.
  • RedshiftBackupSpecification schema:

    • The CopyTagsFromInstanceEnabled parameter was replaced by the CopyTagsFromCluster.
  • EfsBackupSpecification schema:

    • The CopyTagsFromVolumeEnabled parameter was replaced by the CopyTagsFromFileSystem.
  • FsxBackupSpecification schema:

    • The CopyTagsFromInstanceEnabled parameter was replaced by the CopyTagsFromFileSystem.

New Resources

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.

New Resource Collections

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.

New Operations

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.

Deleted Resources

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.