Adding Object Storage

In this article

You can add a new Amazon S3 object storage repository to the Veeam Backup for Microsoft 365 backup infrastructure.

Request

POST https://<hostname>:4443/v6/objectstoragerepositories

Request Headers

The request header must contain an authorization token of the current session.

Request Body

The request body must contain the following properties:

Property	Type	Description
name	string	Specifies the object storage name.
description	string	Specifies the object storage description.
type	string	Specifies the object storage type. The following types are available: AmazonS3 AmazonS3Glacier
accountId	string	Specifies ID of the account under which the object storage is being added.
amazonBucketS3Aws	amazonBucketS3Aws	Contains Amazon S3 bucket properties.
s3Folder	string	Specifies storage folder where backups will reside.
sizeLimitEnabled	boolean	Defines if the size limit is set.
sizeLimitGB	integer	Specifies size limit in GB.
glacierDeepArchiveEnabled	boolean	Defines that the Amazon S3 Glacier Deep Archive storage class will be enabled.
iaStorageClassEnabled	boolean	Defines that the Amazon S3 Standard-Infrequent Access storage class will be enabled for data blocks that are stored in the object storage.
useArchiverAppliance	boolean	Defines that Veeam Backup for Microsoft 365 will use the Amazon archiver appliance when transferring backed-up data to the archive object storage.
amazonArchiverAppliance	amazonArchiverAppliance	Contains a definition of the Amazon archiver appliance that Veeam Backup for Microsoft 365 will use when transferring backed-up data to the archive object storage.

amazonBucketS3Aws

Property	Type	Description
regionType	string	Specifies a region type. The following types are available: Global USGovernment China
regionName	string	Specifies a region name.
regionId	string	Specifies a region ID.
name	string	Specifies a bucket name.

amazonArchiverAppliance

Property	Type	Description
instanceType	Instance Type	Specifies an instance type that the Amazon archiver appliance will use.
virtualPrivateCloud	Virtual Private Cloud	Specifies Amazon Virtual Private Cloud (Amazon VPC).
subnet	Subnet	Specifies the Amazon archiver appliance subnet.
securityGroup	Security Group	Specifies a security group that will be associated with the Amazon archiver appliance.
appliancePort	integer	Specifies a port number that will be used to route requests between the Amazon archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components.

Request Example

Request:

POST https://abc.tech.local:4443/v6/objectstoragerepositories

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"name": "Amazon REST",

"description": "Created with REST",

"type": "AmazonS3",

"accountId": "c0f030cb-a43a-4713-8da8-717c62a0b4f7",

"amazonBucketS3Aws": {

"name": "veeam-tw",

"regionType": "Global",

"regionId": "us-east-2",

"regionName": "US East (Ohio)" },

"s3Folder": "Folder1",

"sizeLimitEnabled": true,

"sizeLimitGB": "1024",

"iaStorageClassEnabled": true,

"useArchiverAppliance": false

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 201 Created.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property	Type	Description
amazonBucketS3Aws	amazonBucketS3Aws	Contains Amazon S3 bucket properties.
s3Folder	string	Specifies storage folder where backups reside.
id	string	Specifies the object storage ID.
name	string	Specifies the object storage name.
description	string	Specifies the object storage description.
accountId	string	Specifies ID of the account under which the object storage was added.
sizeLimitEnabled	boolean	Defines if the size limit is set.
sizeLimitGB	integer	Specifies size limit in GB.
usedSpaceBytes	integer	Specifies used space in Bytes.
freeSpaceBytes	integer	Specifies free space in Bytes.
type	string	Specifies the object storage type. The following types are available: AmazonS3 AmazonS3Glacier
glacierDeepArchiveEnabled	boolean	Defines that the Amazon S3 Glacier Deep Archive storage class is enabled.
iaStorageClassEnabled	boolean	Defines that the Amazon S3 Standard-Infrequent Access storage class is enabled for data blocks that are stored in an Amazon S3 object storage.
useArchiverAppliance	boolean	Defines that Veeam Backup for Microsoft 365 uses the Amazon archiver appliance when transferring backed-up data to the archive object storage.
amazonArchiverAppliance	amazonArchiverAppliance	Contains a definition of the Amazon archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

amazonBucketS3Aws

Property	Type	Description
regionType	string	Specifies a region type. The following types are available: Global USGovernment China
regionName	string	Specifies a region name.
regionId	string	Specifies a region ID.
name	string	Specifies a bucket name.

amazonArchiverAppliance

Property	Type	Description
instanceType	Instance Type	Specifies an instance type that the Amazon archiver appliance uses.
virtualPrivateCloud	Virtual Private Cloud	Specifies Amazon Virtual Private Cloud (Amazon VPC).
subnet	Subnet	Specifies the Amazon archiver appliance subnet.
securityGroup	Security Group	Specifies a security group associated with the Amazon archiver appliance.
appliancePort	integer	Specifies a port number that is used to route requests between the Amazon archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components.

Response Example

Response:

201 Created

Response Body:

{

"s3Folder": "Folder1",

"id": "af15334e-824b-490f-90c9-a121efe51d67",

"name": "Amazon REST",

"description": "Created with REST",

"accountId": "c0f030cb-a43a-4713-8da8-717c62a0b4f7",

"sizeLimitEnabled": true,

"sizeLimitGB": 1024,

"usedSpaceBytes": 0,

"freeSpaceBytes": 1099511627776,

"type": "AmazonS3",

"_links": {

"self": {

"href": "v6/objectstoragerepositories/af15334e-824b-490f-90c9-a121efe51d67"

"account": {

"href": "v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7"

"bucket": {

"href": "v6/S3Resources/buckets/veeam-tw?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global&RegionId=us-east-2"

"folder": {

"href": "v6/S3Resources/buckets/veeam-tw/folders/Folder1?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&regionType=Global"

}

"amazonBucketS3Aws": {

"regionType": "Global",

"regionName": "US East (Ohio)",

"regionId": "us-east-2",

"name": "veeam-tw"

"iaStorageClassEnabled": true,

"useArchiverAppliance": false

}