Adding Object Storage
You can add a new S3 Compatible or IBM object storage repository to the Veeam Backup for Microsoft 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 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 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 AmazonS3Compatible is available. Note: Use this type to add an IBM object storage repository. |
accountId | string | Specifies ID of the account under which the object storage is being added. |
amazonBucketS3Compatible | Contains S3 Compatible bucket properties. | |
s3Folder | string | Specifies storage folder where backups will reside. |
sizeLimitEnabled | boolean | Defines whether the size limit is set. |
sizeLimitGB | integer | Specifies size limit in GB. |
Property | Type | Description |
---|---|---|
servicePoint | string | Specifies an endpoint address. |
customRegionId | string | Specifies a region ID. |
name | string | Specifies a bucket name. |
Request: POST https://abc.tech.local:4443/v6/objectstoragerepositories
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "name": "New S3 Compatible Storage", "description": "Created with REST", "type": "AmazonS3Compatible", "accountId": "ed531412-7646-4fa1-bea5-986c04bcb89c", "amazonBucketS3Compatible": { "name": "d3e020df-9144-4fa3-a2ff-a83abb3f7cfa", "servicePoint" : "https://my.servicepoint.com:443", "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 body contains the following properties:
Property | Type | Description |
---|---|---|
amazonBucketS3Compatible | Contains S3 Compatible bucket properties. | |
s3Folder | string | Specifies a 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 whether 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 AmazonS3Compatible is available. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (a navigation property). |
Property | Type | Description |
---|---|---|
servicePoint | string | Specifies an endpoint address. |
customRegionId | string | Specifies a region ID. |
name | string | Specifies a bucket name. |
Response: 201 Created
Response Body: { "amazonBucketS3Compatible": { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "d3e020df-9144-4fa3-a2ff-a83abb3f7cfa" }, "s3Folder": "RESTStorageFolder", "id": "aa75a64b-149f-4b35-8b4b-e976f3ba8310", "name": "New S3 Compatible Storage", "description": "Created with REST", "accountId": "ed531412-7646-4fa1-bea5-986c04bcb89c", "sizeLimitEnabled": true, "sizeLimitGB": 1024, "usedSpaceBytes": 0, "freeSpaceBytes": 1099511627776, "type": "AmazonS3Compatible", "_links": { "self": { "href": "/v6/objectstoragerepositories/aa75a64b-149f-4b35-8b4b-e976f3ba8310" }, "account": { "href": "/v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c" }, "bucket": { "href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1" }, "folder": { "href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/RESTStorageFolder?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1" } } } |