Adding Object Storage

In this article

    You can add a new Azure 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.

    azureContainer

    azureContainer

    An Azure container.

    azureFolder

    string

    A folder in the specified container.

    sizeLimitEnabled

    boolean

    Specifies if the size limit is set.

    sizeLimitGB

    integer

    Specifies the size limit in GB.

    azureContainer

    Property

    Type

    Description

    name

    string

    A container name.

    regionType

    string

    A region type of an object storage.

    Request Example

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

    Request Body:

    {

     "name": "Azure Object Storage",

     "description": "Secondary file destination",

     "type": "AzureBlob",

     "accountId": "db1befe9-f6cc-4e94-b473-7d6b4a52a6bf",

     "azureContainer": {

         "name": "container1",

         "regionType": "Global" },

     "azureFolder": "Folder3",

     "sizeLimitEnabled": true,

     "sizeLimitGB": "10"

    }

    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

    azureContainer

    azureContainer

    Contains a container or bucket definition.

    azureFolder

    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

    string

    Specifies size limit in GB.

    usedSpaceGB

    string

    Specifies used space in GB.

    type

    string

    An object storage type.

    The following types are available:

    • AmazonS3
    • AzureBlob
    • AmazonS3Compatible

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    azureContainer

    Property

    Type

    Description

    name

    string

    A container name.

    regionType

    string

    A region type of an object storage.

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

      "azureContainer":    {

         "name": "container1",

         "regionType": "Global"

      },

      "azureFolder": "Folder3",

      "id": "e2039592-3638-48d4-9543-f4fc68be38e6",

      "name": "Azure Object Storage",

      "description": "Secondary file destination",

      "accountId": "db1befe9-f6cc-4e94-b473-7d6b4a52a6bf",

      "sizeLimitEnabled": true,

      "sizeLimitGB": 10,

      "usedSpaceGB": 0,

      "freeSpaceGB": 10,

      "type": "AzureBlob",

      "_links":    {

         "self": {"href": "https://abc.tech.local:4443/v5/objectstoragerepositories/e2039592-3638-48d4-9543-f4fc68be38e6"},

         "account": {"href": "https://abc.tech.local:4443/v5/accounts/db1befe9-f6cc-4e94-b473-7d6b4a52a6bf"},

         "container": {"href": "https://abc.tech.local:4443/v5/AzureResources/containers/container1?accountId=db1befe9-f6cc-4e94-b473-7d6b4a52a6bf&RegionType=Global"},

         "folder": {"href": "https://abc.tech.local:4443/v5/AzureResources/containers/container1/folders/Folder3?accountId=db1befe9-f6cc-4e94-b473-7d6b4a52a6bf&regionType=Global"}

      }

    }