Adding Object Storage

In this article

This section explains how to add a new Amazon S3 object storage repository to the Veeam Backup for Microsoft Office 365 backup infrastructure.

Request

POST https://<hostname>:4443/v5/ObjectStorageRepositories

Request Headers

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

Request Body

The following table lists available request properties.

Property	Type	Description
name	string	An object storage name.
description	string	An object storage description (optional).
type	string	A type of object storage. The following types are available: AmazonS3 AzureBlob AmazonS3Compatible
accountId	string	An identification number of the user account under which object storage is being added.
bucket	bucket	An Amazon bucket.
s3Folder	string	A folder in the specified bucket.
sizeLimitEnabled	boolean	Specifies if the size limit is set.
sizeLimitGB	integer	Specifies the size limit in GB.

bucket

Property	Type	Description
regionType	string	A region type.
name	string	A bucket name.
location	string	The location of the bucket.
region	string	A region.

Request Example

Request:

POST https://<hostname>:4443/v5/ObjectStorageRepositories

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"name": "Amazon REST",

"description": "Created with REST",

"type": "AmazonS3",

"accountId": "de4f0671-953c-4f88-a60f-731bc8277e3a",

"bucket": {

"name": "veeam-tw",

"regionType": "Global",

"location": "us-west-1",

"region": "USEastOhio" },

"s3Folder": "folder1",

"sizeLimitEnabled": true,

"sizeLimitGB": "1024"

}

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 contains the following information.

Property	Type	Description
bucket	bucket	Contains a container or bucket definition.
s3Folder	string	Specifies storage folder when backups reside.
id	string	Object storage identification number.
name	string	Object storage name.
description	string	Object storage description.
accountId	string	An account identification number under which object storage is added.
sizeLimitEnabled	boolean	Specifies if the size limit is set.
sizeLimitGB	string	Specifies size limit in GB.
usedSpaceGB	string	Specifies used space in GB.
type	string	A type of object storage. The following types are available: AmazonS3 AzureBlob AmazonS3Compatible
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

bucket

Property	Type	Description
regionType	string	A region type.
name	string	A bucket name.

Response Example

Response:

201 Created

Response Body:

{

"bucket": {

"name": "veeam-tw",

"regionType": "Global",

"location": "us-west-1",

"region": "USEastOhio" },

"s3Folder": "folder1",

"id": "00ae653b-4e7a-4f53-903a-416385eae29c",

"name": "Amazon REST",

"description": "Created with REST",

"accountId": "de4f0671-953c-4f88-a60f-731bc8277e3a",

"sizeLimitEnabled": true,

"sizeLimitGB": 1024,

"usedSpaceGB": 0,

"freeSpaceGB": 1024,

"type": "AmazonS3",

"_links": {

"self": {"href": "https://abc.tech.local:4443/v5/objectstoragerepositories/00ae653b-4e7a-4f53-903a-416385eae29c"},

"account": {"href": "https://abc.tech.local:4443/v5/accounts/de4f0671-953c-4f88-a60f-731bc8277e3a"},

"bucket": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&RegionType=Global"},

"folder": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw/folders/folder1?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&regionType=Global"}

}