Changelog

Versions


Changes from 1.0-rev0 to 1.1-rev0.

What's New


  1. POST/api/v1/virtualMachines/rescan Infrastructure Rescan for EC2 Instances
  2. GET/api/v1/virtualMachines/volumes Get EBS Volumes
  3. GET/api/v1/rds Get Collection of RDS Instances
  4. POST/api/v1/rds/rescan Infrastructure Rescan for RDS Instances
  5. GET/api/v1/rds/{rdsId} Get RDS Instance Data
  6. POST/api/v1/rds/{rdsId}/takeSnapshot Create Snapshot of RDS Instance
  7. GET/api/v1/rds/restorePoints Get RDS Instance Restore Points
  8. GET/api/v1/rds/restorePoints/{restorePointId} Get RDS Instance Restore Point Data
  9. DELETE/api/v1/rds/restorePoints/{restorePointId} Remove RDS Instance Restore Point
  10. POST/api/v1/rds/restorePoints/{restorePointId}/restore Perform RDS Instance Restore
  11. GET/api/v1/vpc/policy Get VPC Configuration Backup Policy
  12. PUT/api/v1/vpc/policy Modify VPC Configuration Backup Policy
  13. POST/api/v1/vpc/policy/start Start VPC Configuration Backup Policy
  14. POST/api/v1/vpc/policy/stop Stop VPC Configuration Backup Policy
  15. POST/api/v1/vpc/policy/enable Enable VPC Configuration Backup Policy
  16. POST/api/v1/vpc/policy/disable Disable VPC Configuration Backup Policy
  17. GET/api/v1/vpc/restorePoints/{vpcRestorePointId}/items Get Backed-Up VPC Configuration Items
  18. GET/api/v1/vpc/restorePoints Get VPC Configuration Restore Points
  19. GET/api/v1/vpc/restorePoints/{vpcRestorePointId} Get VPC Configuration Restore Point Data
  20. GET/api/v1/vpc/restorePoints/{vpcRestorePointId}/vpcs Get Collection of Backed-Up VPCs
  21. POST/api/v1/vpc/restorePoints/{vpcRestorePointId}/validateVpcRole Check IAM Role Permissions
  22. POST/api/v1/vpc/restorePoints/{vpcRestorePointId}/compareWithProduction Compare VPC Configuration
  23. POST/api/v1/vpc/restorePoints/{vpcRestorePointId}/restore Perform VPC Configuration Restore
  24. POST/api/v1/vpc/restorePoints/{vpcRestorePointId}/validateRestore Validate VPC Configuration Restore
  25. POST/api/v1/vpc/restorePoints/{vpcRestorePointId}/export Export Backed-Up VPC Configuration
  26. POST/api/v1/amazonConnections/{amazonConnectionId}/checkRestorePermissions Check Permissions for Performing Restore
  27. POST/api/v1/amazonConnections/{amazonConnectionId}/checkEc2InstanceExists Verify EC2 Instance Details
  28. POST/api/v1/amazonConnections/{amazonConnectionId}/checkRdsInstanceExists Verify RDS Instance Details
  29. GET/api/v1/amazonConnections/{amazonConnectionId}/outposts Get Collection of AWS Outposts
  30. GET/api/v1/amazonConnections/{amazonConnectionId}/rdsOptionGroups Get Collection of Option Groups
  31. GET/api/v1/amazonConnections/{amazonConnectionId}/rdsParameterGroups Get Collection of Parameter Groups
  32. GET/api/v1/amazonConnections/{amazonConnectionId}/rdsEngine Get Collection of RDS Engines
  33. POST/api/v1/amazonConnections/{amazonConnectionId}/validateWorker Validate Worker Settings
  34. GET/api/v1/users/roles Get Collection of User Roles
  35. GET/api/v1/settings/certificate Get Current Security Certificate Data
  36. GET/api/v1/settings/workertags Get Tags Assigned to Worker Instances
  37. PUT/api/v1/settings/workertags Modify Tags Assigned to Worker Instances
  38. POST/api/v1/saml2/registerProvider Import Identity Provider Settings
  39. GET/api/v1/saml2 Export Service Provider Settings
  40. GET/api/v1/identityProvider/signOnUrl Get SSO URL
  41. POST/api/v1/identityProvider/token Request Authorization Tokens

What's Deprecated


  1. GET/api/v1/settings/certificates

What's Changed


  1. POST/api/v1/test Test Connection
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  2. POST/api/v1/accounts/standard Add SMTP Account
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change standardAccount.name
      • Change standardAccount.description
      • Change standardAccount.username
      • Change standardAccount.password
  3. GET/api/v1/accounts/standard Get Collection of SMTP Accounts
    • Parameter

      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Change Offset
      • Change Limit
      • Change SearchPattern
      • Change x-api-version
      • Change Sort
    • Return Type

      • Change results.id
      • Change results.name
      • Change results.username
      • Change results.description
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change totalCount
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  4. DELETE/api/v1/accounts/standard/{standardAccountId} Remove SMTP Account
    • Parameter

      • standardAccountId Notes null change into System ID assigned to the SMTP account in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change standardAccountId
      • Change x-api-version
  5. GET/api/v1/accounts/standard/{standardAccountId} Get SMTP Account Data
    • Parameter

      • standardAccountId Notes null change into System ID assigned to the SMTP account in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change standardAccountId
      • Change x-api-version
    • Return Type

      • Change id
      • Change name
      • Change username
      • Change description
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  6. PUT/api/v1/accounts/standard/{standardAccountId} Modify SMTP Account
    • Parameter

      • standardAccountId Notes null change into System ID assigned to the SMTP account in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change standardAccountId
      • Change standardAccount.name
      • Change standardAccount.description
      • Change standardAccount.username
      • Change standardAccount.password
      • Change x-api-version
    • Return Type

      • Change id
      • Change name
      • Change username
      • Change description
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  7. POST/api/v1/accounts/standard/validateName Validate SMTP Account Name
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change validationSpec.name
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  8. POST/api/v1/accounts/standard/export Export Collection of SMTP Accounts
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  9. POST/api/v1/accounts/amazon Add IAM Role
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change amazonAccount.name
      • Change amazonAccount.description
      • Change amazonAccount.accessKeys.accessKey
      • Change amazonAccount.accessKeys.secretKey
      • Change amazonAccount.IAMRole.roleName
      • Change amazonAccount.IAMRoleFromAnotherAccount.accountId
      • Change amazonAccount.IAMRoleFromAnotherAccount.roleName
      • Change amazonAccount.IAMRoleFromAnotherAccount.externalId
      • Change x-api-version
  10. GET/api/v1/accounts/amazon Get Collection of IAM Roles
    • Parameter

      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Change Offset
      • Change Limit
      • Change x-api-version
      • Change SearchPattern
      • Change Sort
    • Return Type

      • Change results.id
      • Change results.name
      • Change results.description
      • Change results.awsid
      • Change results.accessKeys.accessKey
      • Change results.IAMRole.parentAmazonAccountId
      • Change results.IAMRole.roleName
      • Change results.IAMRole.isDefault
      • Change results.IAMRoleFromAnotherAccount.parentAmazonAccountId
      • Change results.IAMRoleFromAnotherAccount.accountId
      • Change results.IAMRoleFromAnotherAccount.roleName
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change totalCount
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  11. POST/api/v1/accounts/amazon/validateName Validate IAM Role Name
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change validationSpec.name
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  12. POST/api/v1/accounts/amazon/{amazonAccountId}/validateDelete Validate Removing of IAM Role
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonAccountId
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  13. DELETE/api/v1/accounts/amazon/{amazonAccountId} Remove IAM Role
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonAccountId
  14. GET/api/v1/accounts/amazon/{amazonAccountId} Get IAM Role Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonAccountId
    • Return Type

      • Change id
      • Change name
      • Change description
      • Change awsid
      • Change accessKeys.accessKey
      • Change IAMRole.parentAmazonAccountId
      • Change IAMRole.roleName
      • Change IAMRole.isDefault
      • Change IAMRoleFromAnotherAccount.parentAmazonAccountId
      • Change IAMRoleFromAnotherAccount.accountId
      • Change IAMRoleFromAnotherAccount.roleName
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  15. PUT/api/v1/accounts/amazon/{amazonAccountId} Modify IAM Role
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonAccount.name
      • Change amazonAccount.description
      • Change amazonAccount.accessKeys.accessKey
      • Change amazonAccount.accessKeys.secretKey
      • Change amazonAccount.IAMRole.roleName
      • Change amazonAccount.IAMRoleFromAnotherAccount.accountId
      • Change amazonAccount.IAMRoleFromAnotherAccount.roleName
      • Change amazonAccount.IAMRoleFromAnotherAccount.externalId
      • Change amazonAccountId
    • Return Type

      • Change id
      • Change name
      • Change description
      • Change awsid
      • Change accessKeys.accessKey
      • Change IAMRole.parentAmazonAccountId
      • Change IAMRole.roleName
      • Change IAMRole.isDefault
      • Change IAMRoleFromAnotherAccount.parentAmazonAccountId
      • Change IAMRoleFromAnotherAccount.accountId
      • Change IAMRoleFromAnotherAccount.roleName
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  16. POST/api/v1/accounts/amazon/{amazonAccountId}/rescan Infrastructure Rescan for IAM Role
    • Parameter

      • Add rescanCloudAccountSpec.rescanType
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change rescanCloudAccountSpec.regionIds
      • Change amazonAccountId
  17. POST/api/v1/accounts/amazon/export Export Collection of IAM Roles
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  18. GET/api/v1/cloudInfrastructure/tags Get Collection of AWS Tags
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change Limit
      • Change SearchPattern
      • Change x-api-version
      • Change Sort
      • Change Offset
    • Return Type

      • Change results.id
      • Change results.key
      • Change results.value
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change totalCount
      • Change _links.rel
      • Change _links.href
      • Change _links.method
    • Produces

      • Deletetext/plain
      • Deletetext/json
  19. GET/api/v1/cloudInfrastructure/tags/{tagId} Get AWS Tag Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • tagId Notes null change into System ID assigned to the AWS tag in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change tagId
    • Return Type

      • Change id
      • Change key
      • Change value
      • Change _links.rel
      • Change _links.href
      • Change _links.method
    • Produces

      • Deletetext/plain
      • Deletetext/json
  20. GET/api/v1/virtualMachines Get Collection of EC2 Instances
    • Parameter

      • Add BackupDestination//Returns only EC2 instances with the specified backup destination. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • BackupState Notes null change into Returns only EC2 instances with the specified backup state. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • ProtectionStatus Notes null change into Returns only EC2 instances with the specified protection status. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Change BackupState
      • Change x-api-version
      • Change Offset
      • Change ProtectionStatus
      • Change Limit
      • Change Sort
      • Change SearchPattern
      • DeleteBuckupDestination
    • Return Type

      • Add results.instanceSizeGigabytes//Size of all EBS volumes attached to the EC2 instance.
      • Add results.instanceType//Type of the EC2 instance.
      • Add results.instanceDnsName//DNS name of the EC2 instance.
      • Add results.policiesCount//Number of backup policies where the EC2 instance is selected.
      • Add results.region
      • Change results.id
      • Change results.name
      • Change results.awsResourceId
      • Change results.location (Data Type)
      • Change results.isDeleted
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change totalCount
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  21. GET/api/v1/virtualMachines/{virtualMachineId} Get EC2 Instance Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • virtualMachineId Notes null change into System ID assigned to the EC2 instance in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change virtualMachineId
    • Return Type

      • Add instanceSizeGigabytes//Size of all EBS volumes attached to the EC2 instance.
      • Add instanceType//Type of the EC2 instance.
      • Add instanceDnsName//DNS name of the EC2 instance.
      • Add policiesCount//Number of backup policies where the EC2 instance is selected.
      • Add region
      • Change id
      • Change name
      • Change awsResourceId
      • Change location (Data Type)
      • Change isDeleted
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  22. POST/api/v1/virtualMachines/{virtualMachineId}/takeSnapshot Create Snapshot of EC2 Instance
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • virtualMachineId Notes null change into System ID assigned to the EC2 instance in the Veeam Backup for AWS REST API.
      • Change snapshotSpec.amazonAccountId
      • Change snapshotSpec.targetAmazonAccountIdToCopySnapshots
      • Change snapshotSpec.targetRegionIdToCopySnapshots
      • Change snapshotSpec.encryptionKey
      • Change snapshotSpec.copyTagsFromVolumeEnabled
      • Change x-api-version
      • Change virtualMachineId
  23. POST/api/v1/virtualMachines/{virtualMachineId}/deleteSnapshots Remove Snapshots of EC2 Instance
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • virtualMachineId Notes null change into System ID assigned to the EC2 instance in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change virtualMachineId
  24. POST/api/v1/virtualMachines/{virtualMachineId}/deleteBackups Remove Backups of EC2 Instance
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • virtualMachineId Notes null change into System ID assigned to the EC2 instance in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change virtualMachineId
  25. POST/api/v1/virtualMachines/export Export Collection of EC2 Instances
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  26. GET/api/v1/cloudInfrastructure/buckets Get Collection of Amazon S3 Buckets
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • AmazonAccountId Notes null change into Returns only Amazon S3 buckets to which has permissions an IAM role with the specified ID. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Change Limit
      • Change SearchPattern
      • Change AmazonAccountId
      • Change x-api-version
      • Change Offset
      • Change Sort
    • Return Type

      • Change results.id
      • Change results.name
      • Change results.location
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change totalCount
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  27. GET/api/v1/cloudInfrastructure/buckets/{bucketId} Get Amazon S3 Bucket Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • bucketId Notes null change into System ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change bucketId
    • Return Type

      • Change id
      • Change name
      • Change location
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  28. POST/api/v1/cloudInfrastructure/buckets/rescan/{amazonAccountId} Infrastructure Rescan for Amazon S3 Buckets
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonAccountId Notes null change into System ID assigned to the IAM role in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonAccountId
  29. GET/api/v1/cloudInfrastructure/buckets/{bucketId}/folders Get Amazon S3 Bucket Folders
    • Parameter

      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • bucketId Notes null change into System ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change Sort
      • Change x-api-version
      • Change bucketId
      • Change Limit
      • Change Offset
    • Return Type

      • Change totalCount
      • Change results.name
      • Change results.folderId
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  30. GET/api/v1/cloudInfrastructure/buckets/{bucketId}/folders/{folderName} Get Amazon S3 Bucket Folder Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • folderName Notes null change into Name of a folder in the Amazon S3 bucket.
      • bucketId Notes null change into System ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change folderName
      • Change bucketId
    • Return Type

      • Change name
      • Change folderId
  31. GET/api/v1/cloudInfrastructure/regions Get Collection of AWS Regions
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change SearchPattern
      • Change Limit
      • Change x-api-version
      • Change Sort
      • Change Offset
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  32. GET/api/v1/cloudInfrastructure/regions/{regionId} Get AWS Region Data
    • Parameter

      • regionId Notes null change into System ID assigned to an AWS Region in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change regionId
      • Change x-api-version
    • Return Type

      • Change id
      • Change name
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  33. GET/api/v1/cloudInfrastructure/regions/{regionId}/zones Get AWS Region Availability Zones
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • regionId Notes null change into System ID assigned to an AWS Region in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change SearchPattern
      • Change Limit
      • Change regionId
      • Change x-api-version
      • Change Sort
      • Change Offset
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  34. GET/api/v1/cloudInfrastructure/regions/{regionId}/instancesTypes Get Instance Types Available in AWS Region
    • Parameter

      • virtualizationTypes Notes null change into Returns only EC2 instances with the specified AMI virtualization type. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • regionId Notes null change into System ID assigned to an AWS Region in the Veeam Backup for AWS REST API.
      • limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • isArm64 Notes null change into Returns only EC2 instances powered by Arm-based AWS Graviton Processor. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change virtualizationTypes
      • Change regionId
      • Change limit
      • Change isArm64
      • Change x-api-version
      • Change offset
    • Return Type

      • Change totalCount
      • Change results.name
      • Change results.cpuCount
      • Change results.ram
      • Change results.isArm64
      • Change results.virtualizationType
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  35. POST/api/v1/repositories Add S3 Repository
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repository.name
      • Change repository.description
      • Change repository.amazonAccountId
      • Change repository.amazonBucketId
      • Change repository.amazonStorageFolder
      • Change repository.password
      • Change repository.hint
      • Change repository.enableEncryption
  36. GET/api/v1/repositories Get Collection of S3 Repositories
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Change SearchPattern
      • Change Sort
      • Change x-api-version
      • Change Offset
      • Change Limit
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results.description
      • Change results.amazonAccountId
      • Change results.amazonStorageFolder
      • Change results.amazonBucketId
      • Change results.hint
      • Change results.enableEncryption
      • Change results._embedded.amazonAccount
      • Change results._embedded.amazonAccountLink.rel
      • Change results._embedded.amazonAccountLink.href
      • Change results._embedded.amazonAccountLink.method
      • Change results._embedded.region
      • Change results._embedded.regionLink.rel
      • Change results._embedded.regionLink.href
      • Change results._embedded.regionLink.method
      • Change results._embedded.bucket
      • Change results._embedded.bucketLink.rel
      • Change results._embedded.bucketLink.href
      • Change results._embedded.bucketLink.method
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  37. DELETE/api/v1/repositories/{repositoryId} Remove S3 Repository
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • repositoryId Notes null change into System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repositoryId
  38. GET/api/v1/repositories/{repositoryId} Get S3 Repository Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • repositoryId Notes null change into System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repositoryId
    • Return Type

      • Change id
      • Change name
      • Change description
      • Change amazonAccountId
      • Change amazonStorageFolder
      • Change amazonBucketId
      • Change hint
      • Change enableEncryption
      • Change _embedded.amazonAccount
      • Change _embedded.amazonAccountLink.rel
      • Change _embedded.amazonAccountLink.href
      • Change _embedded.amazonAccountLink.method
      • Change _embedded.region
      • Change _embedded.regionLink.rel
      • Change _embedded.regionLink.href
      • Change _embedded.regionLink.method
      • Change _embedded.bucket
      • Change _embedded.bucketLink.rel
      • Change _embedded.bucketLink.href
      • Change _embedded.bucketLink.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  39. PUT/api/v1/repositories/{repositoryId} Modify S3 Repository Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • repositoryId Notes null change into System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repositoryId
      • Change repository.name
      • Change repository.description
      • Change repository.amazonAccountId
      • Change repository.password
      • Change repository.hint
      • Change repository.enableEncryption
    • Return Type

      • Change id
      • Change name
      • Change description
      • Change amazonAccountId
      • Change amazonStorageFolder
      • Change amazonBucketId
      • Change hint
      • Change enableEncryption
      • Change _embedded.amazonAccount
      • Change _embedded.amazonAccountLink.rel
      • Change _embedded.amazonAccountLink.href
      • Change _embedded.amazonAccountLink.method
      • Change _embedded.region
      • Change _embedded.regionLink.rel
      • Change _embedded.regionLink.href
      • Change _embedded.regionLink.method
      • Change _embedded.bucket
      • Change _embedded.bucketLink.rel
      • Change _embedded.bucketLink.href
      • Change _embedded.bucketLink.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  40. POST/api/v1/repositories/{repositoryId}/rescan Infrastructure Rescan for S3 Repository
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • repositoryId Notes null change into System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repositoryId
  41. POST/api/v1/repositories/settings/validate Validate S3 Repository Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change repository.name
      • Change repository.description
      • Change repository.amazonAccountId
      • Change repository.amazonBucketId
      • Change repository.amazonStorageFolder
      • Change repository.password
      • Change repository.hint
      • Change repository.enableEncryption
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  42. POST/api/v1/repositories/{repositoryId}/checkPassword Validate Password Used for Data Encryption
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • repositoryId Notes null change into System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change repositoryId
      • Change repositoryPassword.password
    • Return Type

      • Change isSuccess
  43. POST/api/v1/repositories/export Export Collection of S3 Repositories
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  44. POST/api/v1/policies Create Backup Policy
    • Parameter

      • Add policy.type
      • Add policy.snapshotSettings.snapshotScripts
      • Add policy.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Deletepolicy.selectedItems.virtualMachineIds
      • Deletepolicy.selectedItems.tagIds
      • Deletepolicy.excludedItems.virtualMachineIds
      • Deletepolicy.excludedItems.tagIds
      • Change x-api-version
  45. GET/api/v1/policies Get Collection of EC2 and RDS Backup Policies
    • Parameter

      • VirtualMachineId Notes null change into Returns only backup policies that protect an EC2 instance with the specified ID.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • LastPolicySessionStatus Notes null change into Returns only backup policies with the specified most recent backup session status.
      • PolicyStatus Notes null change into Returns only enabled or disabled backup policies.
      • Usn Notes null change into Returns only backup policies with the specified update sequence number.
      • RepositoryId Notes null change into Returns only backup policies that stores backups in an S3 repository the specified ID.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Change VirtualMachineId
      • Change Limit
      • Change Offset
      • Change x-api-version
      • Change SearchPattern
      • Change LastPolicySessionStatus
      • Change PolicyStatus
      • Change Usn
      • Change RepositoryId
      • Change Sort
    • Return Type

      • Add results.type
      • Add results.snapshotSettings.snapshotScripts
      • Add results.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • Deleteresults.selectedItems.virtualMachineIds
      • Deleteresults.selectedItems.tagIds
      • Deleteresults.excludedItems.virtualMachineIds
      • Deleteresults.excludedItems.tagIds
      • Change results._embeddedResources.lastBackupSession.rel
      • Change results._embeddedResources.lastBackupSession.href
      • Change results._embeddedResources.lastBackupSession.method
      • Change results._embeddedResources.lastFinishedBackupSession.rel
      • Change results._embeddedResources.lastFinishedBackupSession.href
      • Change results._embeddedResources.lastFinishedBackupSession.method
      • Change results._embeddedResources.targetRepository.rel
      • Change results._embeddedResources.targetRepository.href
      • Change results._embeddedResources.targetRepository.method
      • Change results._embeddedResources.protectedResources.rel
      • Change results._embeddedResources.protectedResources.href
      • Change results._embeddedResources.protectedResources.method
      • Change results._embeddedResources.excludedResources.rel
      • Change results._embeddedResources.excludedResources.href
      • Change results._embeddedResources.excludedResources.method
      • Change results._embeddedResources.regions.rel
      • Change results._embeddedResources.regions.href
      • Change results._embeddedResources.regions.method
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  46. DELETE/api/v1/policies/{policyId} Delete Backup Policy
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
  47. GET/api/v1/policies/{policyId} Get Backup Policy Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
    • Return Type

      • Add type
      • Add snapshotSettings.snapshotScripts
      • Add replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • DeleteselectedItems.virtualMachineIds
      • DeleteselectedItems.tagIds
      • DeleteexcludedItems.virtualMachineIds
      • DeleteexcludedItems.tagIds
      • Change _embeddedResources.lastBackupSession.rel
      • Change _embeddedResources.lastBackupSession.href
      • Change _embeddedResources.lastBackupSession.method
      • Change _embeddedResources.lastFinishedBackupSession.rel
      • Change _embeddedResources.lastFinishedBackupSession.href
      • Change _embeddedResources.lastFinishedBackupSession.method
      • Change _embeddedResources.targetRepository.rel
      • Change _embeddedResources.targetRepository.href
      • Change _embeddedResources.targetRepository.method
      • Change _embeddedResources.protectedResources.rel
      • Change _embeddedResources.protectedResources.href
      • Change _embeddedResources.protectedResources.method
      • Change _embeddedResources.excludedResources.rel
      • Change _embeddedResources.excludedResources.href
      • Change _embeddedResources.excludedResources.method
      • Change _embeddedResources.regions.rel
      • Change _embeddedResources.regions.href
      • Change _embeddedResources.regions.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  48. PUT/api/v1/policies/{policyId} Modify Backup Policy
    • Parameter

      • Add policy.type
      • Add policy.snapshotSettings.snapshotScripts
      • Add policy.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Deletepolicy.selectedItems.virtualMachineIds
      • Deletepolicy.selectedItems.tagIds
      • Deletepolicy.excludedItems.virtualMachineIds
      • Deletepolicy.excludedItems.tagIds
      • Change x-api-version
      • Change policy._embeddedResources.lastBackupSession.rel
      • Change policy._embeddedResources.lastBackupSession.href
      • Change policy._embeddedResources.lastBackupSession.method
      • Change policy._embeddedResources.lastFinishedBackupSession.rel
      • Change policy._embeddedResources.lastFinishedBackupSession.href
      • Change policy._embeddedResources.lastFinishedBackupSession.method
      • Change policy._embeddedResources.targetRepository.rel
      • Change policy._embeddedResources.targetRepository.href
      • Change policy._embeddedResources.targetRepository.method
      • Change policy._embeddedResources.protectedResources.rel
      • Change policy._embeddedResources.protectedResources.href
      • Change policy._embeddedResources.protectedResources.method
      • Change policy._embeddedResources.excludedResources.rel
      • Change policy._embeddedResources.excludedResources.href
      • Change policy._embeddedResources.excludedResources.method
      • Change policy._embeddedResources.regions.rel
      • Change policy._embeddedResources.regions.href
      • Change policy._embeddedResources.regions.method
      • Change policy._links.rel
      • Change policy._links.href
      • Change policy._links.method
      • Change policyId
    • Return Type

      • Add type
      • Add snapshotSettings.snapshotScripts
      • Add replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • DeleteselectedItems.virtualMachineIds
      • DeleteselectedItems.tagIds
      • DeleteexcludedItems.virtualMachineIds
      • DeleteexcludedItems.tagIds
      • Change _embeddedResources.lastBackupSession.rel
      • Change _embeddedResources.lastBackupSession.href
      • Change _embeddedResources.lastBackupSession.method
      • Change _embeddedResources.lastFinishedBackupSession.rel
      • Change _embeddedResources.lastFinishedBackupSession.href
      • Change _embeddedResources.lastFinishedBackupSession.method
      • Change _embeddedResources.targetRepository.rel
      • Change _embeddedResources.targetRepository.href
      • Change _embeddedResources.targetRepository.method
      • Change _embeddedResources.protectedResources.rel
      • Change _embeddedResources.protectedResources.href
      • Change _embeddedResources.protectedResources.method
      • Change _embeddedResources.excludedResources.rel
      • Change _embeddedResources.excludedResources.href
      • Change _embeddedResources.excludedResources.method
      • Change _embeddedResources.regions.rel
      • Change _embeddedResources.regions.href
      • Change _embeddedResources.regions.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  49. GET/api/v1/policies/{policyId}/selectedItems Get AWS Resources Protected by Backup Policy
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Change SearchPattern
      • Change Sort
      • Change x-api-version
      • Change policyId
      • Change Offset
      • Change Limit
    • Return Type

      • Change results.tag.rel
      • Change results.tag.href
      • Change results.tag.method
      • Change results.virtualMachine.rel
      • Change results.virtualMachine.href
      • Change results.virtualMachine.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  50. GET/api/v1/policies/{policyId}/regions Get AWS Regions Selected for Backup Policy
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change SearchPattern
      • Change Limit
      • Change x-api-version
      • Change Sort
      • Change policyId
      • Change Offset
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  51. GET/api/v1/policies/{policyId}/excludedItems Get AWS Resources Excluded from Backup Policy
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Change SearchPattern
      • Change Sort
      • Change x-api-version
      • Change policyId
      • Change Offset
      • Change Limit
    • Return Type

      • Change results.tag.rel
      • Change results.tag.href
      • Change results.tag.method
      • Change results.virtualMachine.rel
      • Change results.virtualMachine.href
      • Change results.virtualMachine.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  52. POST/api/v1/policies/{policyId}/enable Enable Backup Policy
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
  53. POST/api/v1/policies/{policyId}/disable Disable Backup Policy
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
  54. POST/api/v1/policies/{policyId}/start Start Backup Policy
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
  55. POST/api/v1/policies/{policyId}/stop Stop Backup Policy
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
  56. GET/api/v1/policies/{policyId}/export Export Backup Policy Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
    • Return Type

      • Add snapshotSettings.snapshotScripts
      • Add replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • DeleteselectedItems.virtualMachines
      • DeleteselectedItems.tags
      • DeleteexcludedItems.virtualMachines
      • DeleteexcludedItems.tags
  57. POST/api/v1/policies/import Import Backup Policy Settings
    • Parameter

      • Add policySpec.snapshotSettings.snapshotScripts
      • Add policySpec.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • DeletepolicySpec.selectedItems.virtualMachines
      • DeletepolicySpec.selectedItems.tags
      • DeletepolicySpec.excludedItems.virtualMachines
      • DeletepolicySpec.excludedItems.tags
      • Change x-api-version
  58. POST/api/v1/policies/validate Validate Backup Policy Settings
    • Parameter

      • Add validationSpec.type
      • Add validationSpec.snapshotSettings.snapshotScripts
      • Add validationSpec.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • DeletevalidationSpec.selectedItems.virtualMachineIds
      • DeletevalidationSpec.selectedItems.tagIds
      • DeletevalidationSpec.excludedItems.virtualMachineIds
      • DeletevalidationSpec.excludedItems.tagIds
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  59. POST/api/v1/policies/orderPriorities Set Backup Policy Priority
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  60. POST/api/v1/policies/export Export Collection of Backup Policies
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  61. GET/api/v1/policies/{policyId}/cost Get Backup Policy Estimated Cost
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • policyId Notes null change into System ID assigned to an EC2 or RDS backup policy in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change policyId
    • Return Type

      • Change totalCount
      • Change items.virtualMachineId
      • Change items.virtualMachineName
      • Change items.snapshotCost
      • Change items.replicaCost
      • Change items.backupCost
      • Change items.trafficCost
      • Change items.transactionCost
      • Change items.totalCost
      • Change isEmpty
      • Change totalSnapshotCost
      • Change totalReplicaCost
      • Change totalBackupCost
      • Change totalTrafficCost
      • Change totalTransactionCost
      • Change totalCost
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  62. POST/api/v1/costEstimation Calculate Estimated Cost of Backup Policy
    • Parameter

      • Add policySpec.type
      • Add policySpec.snapshotSettings.snapshotScripts
      • Add policySpec.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • VirtualMachineNameFilter Notes null change into Returns only estimated cost of backing up an instance with the specified name. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Filter Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/filter.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • DeletepolicySpec.selectedItems.virtualMachineIds
      • DeletepolicySpec.selectedItems.tagIds
      • DeletepolicySpec.excludedItems.virtualMachineIds
      • DeletepolicySpec.excludedItems.tagIds
      • Change VirtualMachineNameFilter
      • Change x-api-version
      • Change Limit
      • Change Offset
      • Change Sort
    • Return Type

      • Change totalCount
      • Change items.virtualMachineId
      • Change items.virtualMachineName
      • Change items.snapshotCost
      • Change items.replicaCost
      • Change items.backupCost
      • Change items.trafficCost
      • Change items.transactionCost
      • Change items.totalCost
      • Change isEmpty
      • Change totalSnapshotCost
      • Change totalReplicaCost
      • Change totalBackupCost
      • Change totalTrafficCost
      • Change totalTransactionCost
      • Change totalCost
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  63. POST/api/v1/costEstimation/export Export Estimation Cost Report
    • Parameter

      • Add policySpec.type
      • Add policySpec.snapshotSettings.snapshotScripts
      • Add policySpec.replicaSettings.mapping.encryptOnlyEncryptedVolumes
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • DeletepolicySpec.selectedItems.virtualMachineIds
      • DeletepolicySpec.selectedItems.tagIds
      • DeletepolicySpec.excludedItems.virtualMachineIds
      • DeletepolicySpec.excludedItems.tagIds
      • Change x-api-version
  64. GET/api/v1/sessions Get Collection of Sessions
    • Parameter

      • Types Notes null change into Returns only sessions of the specified session type.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Status Notes null change into Returns only sessions with the specified session status.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • FromUtc Notes null change into Returns only sessions run after the specified date and time.
      • VmId Notes null change into Returns only sessions where an EC2 instance with the specified ID is processed.
      • PolicyId Notes null change into Returns only sessions of a backup policy with the specified ID.
      • ToUtc Notes null change into Returns only sessions run before the specified date and time.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Usn Notes null change into Returns only sessions with the specified update sequence number.
      • Change Types
      • Change Offset
      • Change Limit
      • Change Status
      • Change x-api-version
      • Change FromUtc
      • Change VmId
      • Change PolicyId
      • Change ToUtc
      • Change Sort
      • Change Usn
    • Return Type

      • Add results.extendedSessionType
      • Change totalCount
      • Change results.id
      • Change results.executionStartTime
      • Change results.executionStopTime
      • Change results.executionDuration
      • Change results.reason
      • Change results.usn
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change results._embedded.backupJobInfo.rel
      • Change results._embedded.backupJobInfo.href
      • Change results._embedded.backupJobInfo.method
      • Change results._embedded.restoreJobInfo.rel
      • Change results._embedded.restoreJobInfo.href
      • Change results._embedded.restoreJobInfo.method
      • Change results._embedded.retentionJobDeletedRestorePoints.rel
      • Change results._embedded.retentionJobDeletedRestorePoints.href
      • Change results._embedded.retentionJobDeletedRestorePoints.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  65. GET/api/v1/sessions/{retentionSessionId}/deletedItems Get Items Removed During Session
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • retentionSessionId Notes null change into System ID assigned to the retention activity session in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change Offset
      • Change Limit
      • Change SearchPattern
      • Change Sort
      • Change retentionSessionId
    • Return Type

      • Change totalCount
      • Change results.name
      • Change results.region
      • Change results._embedded.region.rel
      • Change results._embedded.region.href
      • Change results._embedded.region.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  66. GET/api/v1/sessions/{backupSessionId}/protectedItems Get Items Protected During Session
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • backupSessionId Notes null change into System ID assigned to the backup activity session in the Veeam Backup for AWS REST API.
      • Change Limit
      • Change Sort
      • Change Offset
      • Change x-api-version
      • Change SearchPattern
      • Change backupSessionId
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results.region
      • Change results._embedded.virtualMachine.rel
      • Change results._embedded.virtualMachine.href
      • Change results._embedded.virtualMachine.method
      • Change results._embedded.region.rel
      • Change results._embedded.region.href
      • Change results._embedded.region.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  67. GET/api/v1/sessions/{restoreSessionId}/restoredItems Get Items Restored During Session
    • Parameter

      • restoreSessionId Notes null change into System ID assigned to the restore activity session in the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Change restoreSessionId
      • Change Limit
      • Change SearchPattern
      • Change x-api-version
      • Change Offset
      • Change Sort
    • Return Type

      • Change totalCount
      • Change results.name
      • Change results.regionName
      • Change results._embedded.virtualMachine.rel
      • Change results._embedded.virtualMachine.href
      • Change results._embedded.virtualMachine.method
      • Change results._embedded.region.rel
      • Change results._embedded.region.href
      • Change results._embedded.region.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  68. GET/api/v1/sessions/{sessionId} Get Session Data
    • Parameter

      • sessionId Notes null change into System ID assigned to a session in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change sessionId
      • Change x-api-version
    • Return Type

      • Add extendedSessionType
      • Change id
      • Change executionStartTime
      • Change executionStopTime
      • Change executionDuration
      • Change reason
      • Change usn
      • Change _links.rel
      • Change _links.href
      • Change _links.method
      • Change _embedded.backupJobInfo.rel
      • Change _embedded.backupJobInfo.href
      • Change _embedded.backupJobInfo.method
      • Change _embedded.restoreJobInfo.rel
      • Change _embedded.restoreJobInfo.href
      • Change _embedded.restoreJobInfo.method
      • Change _embedded.retentionJobDeletedRestorePoints.rel
      • Change _embedded.retentionJobDeletedRestorePoints.href
      • Change _embedded.retentionJobDeletedRestorePoints.method
  69. GET/api/v1/sessions/{sessionId}/log Get Session Log Details
    • Parameter

      • sessionId Notes null change into System ID assigned to a session in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change sessionId
      • Change x-api-version
    • Return Type

      • Change log.logTime
      • Change log.status
      • Change log.message
      • Change log.executionStartTime
      • Change log.executionDuration
  70. POST/api/v1/sessions/{sessionId}/stop Stop Session Processing
    • Parameter

      • sessionId Notes null change into System ID assigned to a session in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change sessionId
      • Change x-api-version
  71. POST/api/v1/sessions/export Export Collection of Sessions
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  72. POST/api/v1/amazonConnections Add Amazon Connection
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  73. GET/api/v1/amazonConnections Get Collection of Amazon Connections
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  74. DELETE/api/v1/amazonConnections/{amazonConnectionId} Remove Amazon Connection
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonConnectionId
  75. GET/api/v1/amazonConnections/{amazonConnectionId} Get Amazon Connection Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonConnectionId
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  76. GET/api/v1/amazonConnections/{amazonConnectionId}/cloudNetworks Get Collection of VPCs
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change Limit
      • Change Offset
      • Change x-api-version
      • Change amazonConnectionId
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  77. GET/api/v1/amazonConnections/{amazonConnectionId}/cloudSubnetworks Get Collection of Subnets
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • cloudNetworkId Notes null change into Returns only subnet that belongs to an Amazon VPC with the specified AWS ID.
      • availabilityZone Notes null change into Returns only subnet that placed in an Availability Zone with the specified ID.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change Offset
      • Change cloudNetworkId
      • Change availabilityZone
      • Change Limit
      • Change amazonConnectionId
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  78. GET/api/v1/amazonConnections/{amazonConnectionId}/cloudSecurityGroups Get Collection of Security Groups
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • cloudNetworkId Notes null change into Returns only security groups that belongs to an Amazon VPC with the specified AWS ID.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change Limit
      • Change cloudNetworkId
      • Change x-api-version
      • Change amazonConnectionId
      • Change Offset
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  79. GET/api/v1/amazonConnections/{amazonConnectionId}/availabilityZones Get Collection of Availability Zones
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change amazonConnectionId
    • Return Type

      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  80. GET/api/v1/amazonConnections/{amazonConnectionId}/validateS3endpoint Validate S3 Endpoint
    • Parameter

      • subnetId Notes null change into AWS ID of the subnet.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change subnetId
      • Change x-api-version
      • Change amazonConnectionId
  81. GET/api/v1/amazonConnections/{amazonConnectionId}/cloudEncryptionKeys Get Collection of Encryption Keys
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change Limit
      • Change Offset
      • Change amazonConnectionId
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  82. GET/api/v1/amazonConnections/{amazonConnectionId}/browseBucketFolders/{bucketId} Get Collection of Amazon S3 Bucket Folders
    • Parameter

      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • bucketId Notes null change into System ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • amazonConnectionId Notes null change into System ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
      • Change Sort
      • Change x-api-version
      • Change bucketId
      • Change Limit
      • Change Offset
      • Change amazonConnectionId
    • Return Type

      • Change totalCount
      • Change results.name
      • Change results.folderId
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  83. GET/api/v1/vmRestorePoints Get EC2 Instance Restore Points
    • Parameter

      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • VirtualMachineId Notes null change into Returns only restore points of an EC2 instance with the specified ID.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Change Offset
      • Change x-api-version
      • Change Sort
      • Change VirtualMachineId
      • Change Limit
    • Return Type

      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  84. GET/api/v1/vmRestorePoints/{vmRestorePointId} Get EC2 Instance Restore Point Data
    • Parameter

      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
    • Return Type

      • Change _links.rel
      • Change _links.href
      • Change _links.method
  85. POST/api/v1/vmRestorePoints/{vmRestorePointId}/restoreDisk Perform Volume-Level Restore
    • Parameter

      • Add options.outpost
      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
  86. POST/api/v1/vmRestorePoints/{vmRestorePointId}/validateRestoreDisk Validate Volume-Level Restore
    • Parameter

      • Add validationConfig.outpost
      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  87. POST/api/v1/vmRestorePoints/{vmRestorePointId}/restoreVm Perform EC2 Instance Restore
    • Parameter

      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
  88. POST/api/v1/vmRestorePoints/{vmRestorePointId}/validateRestoreVm Validate EC2 Instance Restore
    • Parameter

      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  89. POST/api/v1/vmRestorePoints/{vmRestorePointId}/restoreFile Perform File-Level Restore
    • Parameter

      • Add flrSpec.countShards
      • Add flrSpec.keepRtoTools
      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
  90. GET/api/v1/vmRestorePoints/{vmRestorePointId}/defaultNetworkSettings Get Default Network Settings of Restore Point
    • Parameter

      • vmRestorePointId Notes null change into System ID assigned to a restore point of an EC2 instance in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change vmRestorePointId
      • Change x-api-version
  91. POST/api/v1/users Add User Account
    • Parameter

      • Add user.accountType
      • Add user.roleIds
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change user.name
      • Change user.description
      • Change user.password
      • Change x-api-version
  92. GET/api/v1/users Get Collection of Users
    • Parameter

      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change SearchPattern
      • Change x-api-version
      • Change Limit
      • Change Sort
      • Change Offset
    • Return Type

      • Add results.id//System ID used for internal purposes.
      • Add results.roles//Role assigned to the user. Defines user permissions in Veeam Backup for AWS.
      • Add results.accountType
      • Add results.isDefaultAdmin//Defines whether the user is the Default Administrator.
      • Deleteresults.isDefault
      • Change totalCount
      • Change results.name
      • Change results.description
      • Change results.mfaEnabled
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  93. DELETE/api/v1/users/{userId} Remove User Account
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into User name of the Veeam Backup for AWS user.
      • Change x-api-version
      • Change userId
  94. GET/api/v1/users/{userId} Get User Data
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into Name of the Veeam Backup for AWS user.
      • Change x-api-version
      • Change userId
    • Return Type

      • Add id//System ID used for internal purposes.
      • Add roles//Role assigned to the user. Defines user permissions in Veeam Backup for AWS.
      • Add accountType
      • Add isDefaultAdmin//Defines whether the user is the Default Administrator.
      • DeleteisDefault
      • Change name
      • Change description
      • Change mfaEnabled
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  95. PUT/api/v1/users/{userId} Modify User Account
    • Parameter

      • Add user.roleIds//Specifies an ID of the role that must be assigned to the user.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into Name of the Veeam Backup for AWS user.
      • Change user.description
      • Change user.password
      • Change user.oldPassword
      • Change x-api-version
      • Change userId
    • Return Type

      • Add id//System ID used for internal purposes.
      • Add roles//Role assigned to the user. Defines user permissions in Veeam Backup for AWS.
      • Add accountType
      • Add isDefaultAdmin//Defines whether the user is the Default Administrator.
      • DeleteisDefault
      • Change name
      • Change description
      • Change mfaEnabled
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  96. POST/api/v1/users/validateName Validate User Name
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change user.name
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  97. POST/api/v1/users/validateDescription Validate User Description
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change user.description
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  98. POST/api/v1/users/validatePassword Validate User Password
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change user.password
      • Change x-api-version
    • Return Type

      • Change severity
      • Change message
      • Change contextId
  99. POST/api/v1/users/{userId}/enableMfa Get MFA Secret Key
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into Name of the user you want to enable MFA for.
      • Change x-api-version
      • Change userMfaSetup.recreate
      • Change userId
    • Return Type

      • Change userName
      • Change qrString
      • Change secretKey
      • Change scratchCodes
      • Change token
  100. POST/api/v1/users/{userId}/disableMfa Disable MFA for User
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into Name of the user you want to disable MFA for.
      • Change x-api-version
      • Change userId
  101. POST/api/v1/users/{userId}/acceptMfa Enable MFA for User
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • userId Notes null change into Name of the user you want to enable MFA for.
      • Change x-api-version
      • Change userId
      • Change userMfaAccept.code
      • Change userMfaAccept.token
  102. GET/api/v1/users/isFirstLogin Verify First Login
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change isFirstLogin
  103. POST/api/v1/users/checkInstanceId Validate Backup Applience Instance ID
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change instance.instanceId
    • Return Type

      • Change isValid
  104. POST/api/v1/users/createDefaultUser Create Default Admin
    • Parameter

      • Add defaultUserSpec.userSpec.accountType
      • Add defaultUserSpec.userSpec.roleIds
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change defaultUserSpec.instance.instanceId
      • Change defaultUserSpec.userSpec.name
      • Change defaultUserSpec.userSpec.description
      • Change defaultUserSpec.userSpec.password
  105. POST/api/v1/users/export Export Collection of Users
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  106. GET/api/v1/settings/serviceAccount Get IAM Role Used to Launch Worker Instances
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change serviceAmazonAccountId
      • Change serviceAmazonAccountName
      • Change serviceRegion
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  107. PUT/api/v1/settings/serviceAccount Change IAM Role Used to Launch Worker Instances
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change configurationSpec.serviceAmazonAccountId
      • Change configurationSpec.serviceAmazonAccountName
      • Change configurationSpec.serviceRegion
      • Change configurationSpec._links.rel
      • Change configurationSpec._links.href
      • Change configurationSpec._links.method
      • Change x-api-version
    • Return Type

      • Change serviceAmazonAccountId
      • Change serviceAmazonAccountName
      • Change serviceRegion
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  108. POST/api/v1/settings/regions Configure AWS Region Network Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change regionConfigurationSpec.availableZoneId
      • Change regionConfigurationSpec.cloudNetworkId
      • Change regionConfigurationSpec.cloudSubnetworkId
      • Change regionConfigurationSpec.cloudSecurityGroupId
  109. GET/api/v1/settings/regions Get AWS Regions Used to Launch Worker Instances
    • Parameter

      • limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • offset Notes null change into Excludes from a response the first N items of a resource collection.
      • Change limit
      • Change x-api-version
      • Change offset
    • Return Type

      • Change totalCount
      • Change results.regionId
      • Change results.regionName
      • Change results.parentReiognId
      • Change results.parentRegionName
      • Change results.cloudNetworkId
      • Change results.cloudNetworkName
      • Change results.cloudSubnetworkId
      • Change results.cloudSubnetworkName
      • Change results.cloudSecurityGroupId
      • Change results.cloudSecurityGroupName
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  110. DELETE/api/v1/settings/regions/{regionId} Remove Worker Instance Settings
    • Parameter

      • regionId Notes null change into System ID assigned to the Availability Zone in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change regionId
      • Change x-api-version
  111. GET/api/v1/settings/regions/{regionId} Get AWS Region Network Settings
    • Parameter

      • regionId Notes null change into System ID assigned to the Availability Zone of the AWS Region in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change regionId
      • Change x-api-version
    • Return Type

      • Change regionId
      • Change regionName
      • Change parentReiognId
      • Change parentRegionName
      • Change cloudNetworkId
      • Change cloudNetworkName
      • Change cloudSubnetworkId
      • Change cloudSubnetworkName
      • Change cloudSecurityGroupId
      • Change cloudSecurityGroupName
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  112. PUT/api/v1/settings/regions/{regionId} Modify AWS Region Network Settings
    • Parameter

      • regionId Notes null change into System ID assigned to the Availability Zone of the AWS Region in the Veeam Backup for AWS REST API.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change regionId
      • Change locationConfigurationSpec.regionId
      • Change locationConfigurationSpec.regionName
      • Change locationConfigurationSpec.parentReiognId
      • Change locationConfigurationSpec.parentRegionName
      • Change locationConfigurationSpec.cloudNetworkId
      • Change locationConfigurationSpec.cloudNetworkName
      • Change locationConfigurationSpec.cloudSubnetworkId
      • Change locationConfigurationSpec.cloudSubnetworkName
      • Change locationConfigurationSpec.cloudSecurityGroupId
      • Change locationConfigurationSpec.cloudSecurityGroupName
      • Change locationConfigurationSpec._links.rel
      • Change locationConfigurationSpec._links.href
      • Change locationConfigurationSpec._links.method
      • Change x-api-version
    • Return Type

      • Change regionId
      • Change regionName
      • Change parentReiognId
      • Change parentRegionName
      • Change cloudNetworkId
      • Change cloudNetworkName
      • Change cloudSubnetworkId
      • Change cloudSubnetworkName
      • Change cloudSecurityGroupId
      • Change cloudSecurityGroupName
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  113. POST/api/v1/settings/emailNotifications Configure Email Notification Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change smtpSpec.enabled
      • Change smtpSpec.server
      • Change smtpSpec.port
      • Change smtpSpec.useSsl
      • Change smtpSpec.timeout
      • Change smtpSpec.useCredentials
      • Change smtpSpec.credentialsId
      • Change smtpSpec.from
      • Change smtpSpec.to
      • Change smtpSpec.subject
      • Change smtpSpec.onSuccess
      • Change smtpSpec.onWarning
      • Change smtpSpec.onFailure
      • Change smtpSpec.enableScheduledNotification
      • Change smtpSpec.notifyTime
    • Return Type

      • Change enabled
      • Change server
      • Change port
      • Change useSsl
      • Change timeout
      • Change useCredentials
      • Change credentialsId
      • Change from
      • Change to
      • Change subject
      • Change onSuccess
      • Change onWarning
      • Change onFailure
      • Change enableScheduledNotification
      • Change notifyTime
  114. GET/api/v1/settings/emailNotifications Get Email Notification Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change enabled
      • Change server
      • Change port
      • Change useSsl
      • Change timeout
      • Change useCredentials
      • Change credentialsId
      • Change from
      • Change to
      • Change subject
      • Change onSuccess
      • Change onWarning
      • Change onFailure
      • Change enableScheduledNotification
      • Change notifyTime
  115. POST/api/v1/settings/emailNotifications/sendTestMessage Send Test Message
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change EmailNotifications.enabled
      • Change EmailNotifications.server
      • Change EmailNotifications.port
      • Change EmailNotifications.useSsl
      • Change EmailNotifications.timeout
      • Change EmailNotifications.useCredentials
      • Change EmailNotifications.credentialsId
      • Change EmailNotifications.from
      • Change EmailNotifications.to
      • Change EmailNotifications.subject
      • Change EmailNotifications.onSuccess
      • Change EmailNotifications.onWarning
      • Change EmailNotifications.onFailure
      • Change EmailNotifications.enableScheduledNotification
      • Change EmailNotifications.notifyTime
      • Change x-api-version
    • Return Type

      • Change success
      • Change message
  116. POST/api/v1/settings/certificates/regenerate Recreate Security Certificate
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change recreateCertificateSpec.validBy
  117. POST/api/v1/settings/certificates/upload Upload Own Security Certificate
    • Parameter

      • certificatePassword Notes .PFX certificate password change into Password used to protect the security certificate file.
      • certificateFile Notes The .PFX certificate to upload. change into Security certificate file in the `.pfx` format.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change certificatePassword
      • Change certificateFile
      • Change x-api-version
  118. POST/api/v1/settings/retentionSettings Configure Global Retention Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change retentionSpec.lingeringSnapshotRetentionDisabled
      • Change retentionSpec.lingeringSnapshotRetention.timeRetentionDuration
      • Change retentionSpec.lingeringSnapshotRetention.retentionDurationType
      • Change retentionSpec.sessionsRetention.timeRetentionDuration
      • Change retentionSpec.sessionsRetention.retentionDurationType
      • Change retentionSpec.keepAllSessions
      • Change retentionSpec._links.rel
      • Change retentionSpec._links.href
      • Change retentionSpec._links.method
      • Change x-api-version
    • Return Type

      • Change lingeringSnapshotRetentionDisabled
      • Change lingeringSnapshotRetention.timeRetentionDuration
      • Change lingeringSnapshotRetention.retentionDurationType
      • Change sessionsRetention.timeRetentionDuration
      • Change sessionsRetention.retentionDurationType
      • Change keepAllSessions
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  119. GET/api/v1/settings/retentionSettings Get Global Retention Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change lingeringSnapshotRetentionDisabled
      • Change lingeringSnapshotRetention.timeRetentionDuration
      • Change lingeringSnapshotRetention.retentionDurationType
      • Change sessionsRetention.timeRetentionDuration
      • Change sessionsRetention.retentionDurationType
      • Change keepAllSessions
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  120. POST/api/v1/settings/retentionSettings/reset Reset Global Retention Settings
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change lingeringSnapshotRetentionDisabled
      • Change lingeringSnapshotRetention.timeRetentionDuration
      • Change lingeringSnapshotRetention.retentionDurationType
      • Change sessionsRetention.timeRetentionDuration
      • Change sessionsRetention.retentionDurationType
      • Change keepAllSessions
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  121. POST/api/v1/settings/dateTime Set Time Zone
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change datetimeSettingsSpec.timezone.name
      • Change datetimeSettingsSpec.timezone.displayName
      • Change datetimeSettingsSpec.useCustomSettings
      • Change x-api-version
    • Return Type

      • Change timezone.name
      • Change timezone.displayName
      • Change useCustomSettings
  122. GET/api/v1/settings/dateTime Get Current Time Zone
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change timezone.name
      • Change timezone.displayName
      • Change useCustomSettings
  123. GET/api/v1/settings/dateTime/timeZones Get Available Time Zones
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change items.name
      • Change items.displayName
  124. POST/api/v1/settings/dateTime/setDefault Reset Time Zone to Default Value
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change timezone.name
      • Change timezone.displayName
      • Change useCustomSettings
  125. GET/api/v1/settings/dateTime/getDefault Get Default Time Zone
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change timezone.name
      • Change timezone.displayName
      • Change useCustomSettings
  126. GET/api/v1/userStatus Get Overview
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change connectionsCount
      • Change repositoryCount
      • Change policiesCount
      • Change workerLocationsCount
  127. GET/api/v1/system/version Get Current Veeam Backup for AWS Version
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change about
      • Change version
  128. GET/api/v1/system/version/productId Get AWS Account ID and Veeam Support ID
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change awsid
      • Change supportid
  129. POST/api/v1/licensing/license Install License
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • licenseFile Notes The .lic license to upload. change into License file in the `.lic` format.
      • Change x-api-version
      • Change licenseFile
    • Return Type

      • Change licenseType
      • Change instancesUses
      • Change instances
      • Change licensedTo
      • Change licenseExpires
      • Change licenseId
      • Change supportId
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  130. DELETE/api/v1/licensing/license Remove License
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  131. GET/api/v1/licensing/license Get License Details
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change licenseType
      • Change instancesUses
      • Change instances
      • Change licensedTo
      • Change licenseExpires
      • Change licenseId
      • Change supportId
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  132. POST/api/v1/licensing/license/export Export License Usage Report
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  133. GET/api/v1/licensing/licensedWorkloads Get Instances Consuming License Units
    • Parameter

      • Limit Notes null change into Specifies the maximum number of items of a resource collection to return in a response.
      • Sort Notes null change into Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section [Sort Parameter](https://helpcenter.veeam.com/docs/vbaws/rest/search_pattern.html?ver=30).
      • Offset Notes null change into Excludes from a response the first N items of a resource collection.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • SearchPattern Notes null change into Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
      • Change Limit
      • Change Sort
      • Change Offset
      • Change x-api-version
      • Change SearchPattern
    • Return Type

      • Add results.type
      • Change totalCount
      • Change results.id
      • Change results.name
      • Change results.lastBackupTime
      • Change results._links.rel
      • Change results._links.href
      • Change results._links.method
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  134. GET/api/v1/licensing/alerts Get License Alerts
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change results.message
      • Change results.replies.replyId
      • Change results.replies.replyText
      • Change _links.rel
      • Change _links.href
      • Change _links.method
  135. POST/api/v1/licensing/alerts/resolve Resolve License Alerts
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
      • Change resolveNotificationsModel.selectedReplies.replyId
      • Change resolveNotificationsModel.selectedReplies.replyText
  136. GET/api/v1/system/logs Download Veeam Backup for AWS Logs
    • Parameter

      • FromDateUtc Notes null change into \[Applies to the *BetweenDates* interval type\] Specifies a date from which to collect the logs.
      • ToDateUtc Notes null change into \[Applies to the *BetweenDates* interval type\] Specifies a date up to which to collect the logs.
      • ExportLogsType Notes null change into Specifies an interval type used to collect the logs.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Days Notes null change into \[Applies to the *LastDays* interval type\] Specifies a number of days for which to collect the logs.
      • Change FromDateUtc
      • Change ToDateUtc
      • Change ExportLogsType
      • Change x-api-version
      • Change Days
  137. GET/api/v1/system/time Get System Date and Time
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change utcDateTime
  138. GET/api/v1/statistics/summary Get Statistics
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change alarmsCount
      • Change instancesCount
      • Change protectedInstancesCount
      • Change policiesCount
      • Change repositoriesCount
  139. GET/api/v1/licenseAgreement Get License Agreement
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change items.checksum
      • Change items.content
  140. GET/api/v1/licenseAgreement/accepted Check Licence Agreement Acceptance
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change accepted
  141. POST/api/v1/licenseAgreement/accept Accept License Agreement
    • Parameter

      • thirdPartyLicenseAgreementChecksum Notes null change into Checksum for accepting terms of the 3rd party components license agreement.
      • eulaChecksum Notes null change into Checksum for accepting terms of the Veeam license agreement.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change thirdPartyLicenseAgreementChecksum
      • Change eulaChecksum
      • Change x-api-version
  142. GET/api/v1/licenseAgreement/download Download License Agreement
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • licenseAgreementType Notes null change into Type of the license agreement that you want to download.
      • Change x-api-version
      • Change licenseAgreementType
  143. POST/api/v1/token Request Authorization Tokens
    • Parameter

      • username Notes User name (required for the 'password' grant type) change into \[Required if the `grant_type` paramenter value is *password*\] User name.
      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • refresh_token Notes Refresh token (required for the 'refresh_token' grant type) change into \[Required if the `grant_type` paramenter value is *refresh_token*\] Refresh token.
      • grant_type Notes Authentication grant type change into Grant type that will be used to authenticate a user.
      • mfa_token Notes MFA token (required for the 'mfa' grant type) change into \[Required if the `grant_type` paramenter value is *mfa*\] MFA token.
      • mfa_code Notes Verification code (required for the 'mfa' grant type) change into \[Required if the `grant_type` paramenter value is *mfa*\] Verification code.
      • password Notes Password (required for the 'password' grant type) change into \[Required if the `grant_type` paramenter value is *password*\] Password of the user.
      • code Notes Authorization code (required for the 'authorization_code' grant type) change into \[Required if the `grant_type` paramenter value is *authorization_code*\] Authorization code.
      • Change username
      • Change x-api-version
      • Change refresh_token
      • Change grant_type
      • Change mfa_token
      • Change mfa_code
      • Change password
      • Change code
    • Return Type

      • Change access_token
      • Change token_type
      • Change refresh_token
      • Change expires_in
      • Change .issued
      • Change .expires
      • Change username
      • Change roleName
      • Change mfa_enabled
      • Change mfa_token
  144. DELETE/api/v1/token Logout
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
  145. POST/api/v1/token/authorizationCode Get Authorization Code
    • Parameter

      • x-api-version Notes null change into Specifies the current revision of the Veeam Backup for AWS REST API.
      • Change x-api-version
    • Return Type

      • Change code