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 /repositories collection in the Veeam Backup for AWS REST API. Properties included in schemas represent S3 repository details. Some of the properties can be used in POST and PUT requests as well as for query parameter values in GET requests.

Schemas Repository

Property	Type	Description
id	string($uuid)	System ID assigned to an S3 repository in the Veeam Backup for AWS REST API.
name	string	Name of the S3 repository in Veeam Backup for AWS.
description	string	Description of the S3 repository.
amazonAccountId	string($uuid)	System ID assigned in the Veeam Backup for AWS REST API to an IAM role used to connect to the S3 repository.
amazonStorageFolder	string	Name of the folder in the selected Amazon S3 bucket used to store EC2 instance backups.
amazonBucketId	string($uuid)	System ID assigned to an Amazon S3 bucket where the S3 repository is located.
hint	string	[Applies only if encryption is enabled] Hint for the specified password.
enableEncryption	boolean	Defines whether encryption is enabled for backup files stored in the created S3 repository.
_embedded	RepositoryEmbedded	A list of methods and operations used to get information on the S3 repository settings in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.
_links	array	A list of methods and operations available for the S3 Repository in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.

RepositoryEmbedded

Property	Type	Description
amazonAccount	string	Name of the IAM role used to connect to the S3 repository.
amazonAccountLink	link	Request URL used to get information on the IAM role.
region	string	Name of the AWS region where Amazon S3 bucket is located.
regionLink	link	Request URL used to get information on the AWS region.
bucket	string	Name of the Amazon S3 bucket where the S3 repository is located.
bucketLink	link	Request URL used to get information on the Amazon S3 bucket.