This is an archive version of the document. To get the most up-to-date information, see the current version.

Schemas

The following JSON schemas are used to represent resources in the /settings collection in the Veeam Backup for AWS REST API. Properties included in schemas can be used in POST and PUT requests.

Schemas ServiceAccountSettings

Property	Type	Description
serviceAmazonAccountId	string($uuid)	System ID assigned in the Veeam Backup for AWS REST API to an IAM role used to launch worker instances.
serviceAmazonAccountName	string	Name of the IAM role in Veeam Backup for AWS.
serviceAmazonAccountRegionType	string	Region type of the AWS account (Global, Emulator, Government, China).
serviceRegion	string	AWS region where the Veeam Backup for AWS server is located.
_links	array	A list of methods and operations available for the /settings/serviceAccount collection in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.

Schemas RegionSettings

Property	Type	Description
regionId	string($uuid)	System ID assigned in the Veeam Backup for AWS REST API to an Availability Zone of an AWS region where worker instances are launched.
regionName	string	Name of the Availability Zone.
parentRegionId	string($uuid)	System ID assigned to the AWS region in the Veeam Backup for AWS REST API.
parentRegionName	string	Name of the AWS region.
cloudNetworkId	string	AWS ID of an Amazon VPC (a virtual private cloud dedicated to an AWS account).
cloudNetworkName	string	AWS name of the Amazon VPC.
cloudSubnetworkId	string	AWS ID of a subnet (a range of IP addresses in your VPC).
cloudSubnetworkName	string	AWS name of the subnet.
cloudSecurityGroupId	string	AWS ID of a security group.
cloudSecurityGroupName	string	AWS Name of the security group.
_links	array	A list of methods and operations available for the /settings/region collection in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.