This is an archive version of the document. To get the most up-to-date information, see the current version.Adding Object Storage
You can add a new S3 Compatible or IBM object storage repository to the Veeam Backup for Microsoft Office 365 backup infrastructure.
|
If an object storage uses a self-signed SSL certificate, you must add this certificate to the trusted root of the server that runs Veeam Backup for Microsoft Office 365 REST API service. Otherwise, this method will not work. |
Request
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 | An object storage type. The following types are available:
|
accountId | string | An identification number of the user account under which object storage is being added. |
bucket | An S3 Compatible 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. |
Property | Type | Description |
|---|---|---|
name | string | A bucket name. |
servicePoint | string | An endpoint address of a host server. |
customRegionId | string | A region type of an object storage. |
Request: POST https://<hostname>:4443/v5/ObjectStorageRepositories
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "name": "New S3 Compatible Storage", "description": "S3 Compatible Storage added through REST", "type": "AmazonS3Compatible", "accountId": "ebacce24-e6a3-494b-b29c-24d0d588f35e", "bucket": { "name": "bucket1", "servicePoint" : "172.17.186.13:9000", "customRegionId": "us-east-1" }, "s3Folder": "RESTStorageFolder", "sizeLimitEnabled": true, "sizeLimitGB": "1024" } |
The server returns the following response to the client.
A successfully completed operation returns a response code 201 Created.
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 |
The response contains the following information:
Property | Type | Description |
|---|---|---|
bucket | Contains a container or bucket definition. | |
s3Folder | string | Specifies a storage folder where backups reside. |
id | string | An object storage identification number. |
name | string | An object storage name. |
description | string | An 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 | integer | Specifies size limit in GB. |
usedSpaceBytes | integer | Specifies used space in Bytes. |
freeSpaceBytes | integer | Specifies free space in Bytes. |
type | string | An object storage type. The following types are available:
|
_links | Dictionary of string [key] and Object [value] | Links to related resources (a navigation property). |
Property | Type | Description |
|---|---|---|
servicePoint | string | An endpoint address of a host server. |
customRegionId | string | A region type of an object storage. |
name | string | A bucket name. |
Response: 201 Created
Response Body: { "bucket": { "servicePoint": "172.17.186.13:9000", "customRegionId": "us-east-1", "name": "bucket1", }, "s3Folder": "RESTStorageFolder", "id": "2a4bcacd-1288-45f4-a30e-d6b1b938cde5", "name": "New S3 Compatible Storage", "description": "S3 Compatible Storage added through REST", "accountId": "ebacce24-e6a3-494b-b29c-24d0d588f35e", "sizeLimitEnabled": true, "sizeLimitGB": 1024, "usedSpaceBytes": 0, "freeSpaceBytes": 1099511627776, "type": "AmazonS3Compatible", "_links": { "self": {"href": "https://abc.tech.local:4443/v5/objectstoragerepositories/2a4bcacd-1288-45f4-a30e-d6b1b938cde5"}, "account": {"href": "https://abc.tech.local:4443/v5/accounts/ebacce24-e6a3-494b-b29c-24d0d588f35e"}, "bucket": {"href": "https://abc.tech.local:4443/v5/S3CompatibleResources/buckets/bucket1?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"}, "folder": {"href": "https://abc.tech.local:4443/v5/S3CompatibleResources/buckets/bucket1/folders/RESTStorageFolder?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"} } } |
