Veeam Backup for AWS 9
REST API Reference
Related documents

Infrastructure

The /cloudInfrastructure collection allows you to create IAM role templates and perform Infrastructure rescan for AWS resources within AWS Organizations.

Create IAM Role Template

The HTTP POST request to the /cloudInfrastructure/createTemplate endpoint allows you to create an IAM role template with granular permissions that will be used to create IAM roles in the AWS Management Console.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema:
required
permissions
required
Array of strings (CloudAccountPermission)

Specifies actions and resource operations that Veeam Backup for AWS will be able to perform using permissions of the IAM role.

Items Enum: "RepositoryPermissions" "BackupAccountWorkerRole" "ProductionAccountWorkerRole" "EC2BackupSnapshot" "EC2Replication" "EC2Restore" "RDSSnapshot" "RDSReplication" "RDSRestore" "EFSBackup" "EFSRestore" "VPCBackup" "VPCRestore" "DynamoDbBackup" "DynamoDbRestore" "FsxBackup" "FsxRestore" "RedshiftBackup" "RedshiftRestore" "RedshiftServerlessBackup" "RedshiftServerlessRestore" "OrganizationRescanRole"
templateType
required
string (PermissionTemplateFormat)

Defines whether Veeam Backup for AWS will create a CloudFormation template or a JSON policy document.

Enum: "Json" "CloudFormation"
object (CreateTemplateForIamRoleGranularPermissionsSpec)

Specifies details on an IAM role that will be configured for an AWS Account and assigned the specified permissions.

object (CreateTemplateForOrganizationGranularPermissionsSpec)

Specifies details on IAM roles that will be configured for an AWS Organization and assigned the specified permissions.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/cloudInfrastructure/createTemplate
Request samples
{
  • "permissions": [
    ],
  • "templateType": "Json",
  • "iamRole": {
    },
  • "organization": {
    }
}
Response samples
No sample

Perform Infrastructure Rescan for AWS Resources

The HTTP POST request to the /cloudInfrastructure/rescan endpoint runs the infrastructure rescanning operation for AWS resources protected by Veeam Backup for AWS.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
rescanType
string (RescanType)

Specifies type of resources to rescan.

Enum: "Ec2" "Rds" "Efs" "BackupVault" "DynamoDb" "Fsx" "Redshift" "RedshiftServerless" "All"
regionIds
Array of strings <uuid> unique

Specifies system IDs assigned in the Veeam Backup for AWS REST API to AWS Regions you want to rescan. By default, all available AWS Regions and Availability Zones are synchronized.

object (RescanAuthenticationSpecification)

Specifies authentication settings used to perform the rescanning operation.

object (OrganizationSpecification)

[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.

Responses
202

Accepted

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/cloudInfrastructure/rescan
Request samples
application/json
{
  • "rescanType": "Ec2",
  • "regionIds": [
    ],
  • "authenticationSpecification": {
    },
  • "organizationSettings": {
    }
}
Response samples
{}