Getting Object Storage Repositories

In this article

    You can get a list of all object storage repositories added to Veeam Backup for Microsoft Office 365.

    Request

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

    Request Headers

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

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    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/bucket

    The following data types are available depending on the storage type:

    Contains a container or bucket definition.

    azureFolder/s3Folder

    string

    Specifies storage folder when 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 the size limit in GB.

    usedSpaceGB

    integer

    Specifies used space in GB.

    type

    string

    Object storage type.

    _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.

    bucket (Amazon)

    Property

    Type

    Description

    regionType

    string

    A region type.

    name

    string

    A bucket name.

    location

    string

    The location of the bucket.

    region

    string

    A region.

    bucket (S3 Compatible)

    Property

    Type

    Description

    servicePoint

    string

    An endpoint address.

    customRegionId

    string

    A region identification number.

    name

    string

    A bucket name.

    Examples

    Example 1

    The following request returns a resource representation of all repositories created on a backup proxy.

    Request:

    GET https://abc.tech.local:4443/v5/ObjectStorageRepositories/

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

         {

         "bucket":       {

            "servicePoint": "s3.us-west-1.wasabisys.com:443",

            "customRegionId": "us-east-1",

            "name": "twbucket"

         },

         "s3Folder": "OSRv1",

         "id": "f04bcf4b-ff4d-49d8-9e62-c6ec6422260a",

         "name": "S3 Compatible Object Storage",

         "description": "Created by TECH\\Administrator at 10/31/2019 4:39:03 AM",

         "accountId": "3c97259a-8de0-47ee-b729-718462ace87d",

         "sizeLimitEnabled": false,

         "usedSpaceGB": 0,

         "type": "AmazonS3Compatible",

         "_links":       {

            "self": {"href": "https://epsilon.tech.local:4443/v5/objectstoragerepositories/f04bcf4b-ff4d-49d8-9e62-c6ec6422260a"},

            "account": {"href": "https://epsilon.tech.local:4443/v5/accounts/3c97259a-8de0-47ee-b729-718462ace87d"},

            "bucket": {"href": "https://epsilon.tech.local:4443/v5/S3CompatibleResources/buckets/twbucket?accountId=3c97259a-8de0-47ee-b729-718462ace87d&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"},

            "folder": {"href": "https://epsilon.tech.local:4443/v5/S3CompatibleResources/buckets/twbucket/folders/OSRv1?accountId=3c97259a-8de0-47ee-b729-718462ace87d&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"}

         }

      },

         {

         "bucket":       {

            "servicePoint": "s3.us-west-1.wasabisys.com:443",

            "customRegionId": "us-east-1",

            "name": "twbucket"

         },

         "s3Folder": "OSRv3",

         "id": "1db2b7c9-f9db-4ed2-8bae-86107ee42e64",

         "name": "IBM Cloud Object Storage",

         "description": "Created by TECH\\Administrator at 10/31/2019 12:43:22 AM",

         "accountId": "3c97259a-8de0-47ee-b729-718462ace87d",

         "sizeLimitEnabled": false,

         "usedSpaceGB": 77705650,

         "type": "AmazonS3Compatible",

         "_links":       {

            "self": {"href": "https://epsilon.tech.local:4443/v5/objectstoragerepositories/1db2b7c9-f9db-4ed2-8bae-86107ee42e64"},

            "account": {"href": "https://epsilon.tech.local:4443/v5/accounts/3c97259a-8de0-47ee-b729-718462ace87d"},

            "bucket": {"href": "https://epsilon.tech.local:4443/v5/S3CompatibleResources/buckets/twbucket?accountId=3c97259a-8de0-47ee-b729-718462ace87d&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"},

            "folder": {"href": "https://epsilon.tech.local:4443/v5/S3CompatibleResources/buckets/twbucket/folders/OSRv3?accountId=3c97259a-8de0-47ee-b729-718462ace87d&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"}

         }

      },

         {

         "bucket":       {

            "regionType": "Global",

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

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

            "name": "twbucket"

         },

         "s3Folder": "OSRv4",

         "isStorageClassEnabled": false,

         "id": "f3055bab-f90e-4896-ba8c-674378793c59",

         "name": "Amazon S3 Object Storage",

         "description": "Created by TECH\\Administrator at 10/31/2019 4:41:39 AM",

         "accountId": "cdd7f508-4b72-4271-9388-9a0d716c64ff",

         "sizeLimitEnabled": false,

         "usedSpaceGB": 0,

         "type": "AmazonS3",

         "_links":       {

            "self": {"href": "https://epsilon.tech.local:4443/v5/objectstoragerepositories/f3055bab-f90e-4896-ba8c-674378793c59"},

            "account": {"href": "https://epsilon.tech.local:4443/v5/accounts/cdd7f508-4b72-4271-9388-9a0d716c64ff"},

            "bucket": {"href": "https://epsilon.tech.local:4443/v5/S3Resources/buckets/twbucket?accountId=cdd7f508-4b72-4271-9388-9a0d716c64ff&RegionType=Global&RegionId=us-east-2"},

            "folder": {"href": "https://epsilon.tech.local:4443/v5/S3Resources/buckets/twbucket/folders/OSRv4?accountId=cdd7f508-4b72-4271-9388-9a0d716c64ff&regionType=Global"}

         }

      },

         {

         "azureContainer":       {

            "name": "container1",

            "regionType": "Global"

         },

         "azureFolder": "OSRv1",

         "id": "cd561f62-9399-485b-860e-443b1a4646ad",

         "name": "Azure Blob Storage",

         "description": "Created by TECH\\Administrator at 10/31/2019 4:45:20 AM",

         "accountId": "ea98aa3c-bc82-43ed-902c-ec3db1d5fb81",

         "sizeLimitEnabled": false,

         "usedSpaceGB": 0,

         "type": "AzureBlob",

         "_links":       {

            "self": {"href": "https://epsilon.tech.local:4443/v5/objectstoragerepositories/cd561f62-9399-485b-860e-443b1a4646ad"},

            "account": {"href": "https://epsilon.tech.local:4443/v5/accounts/ea98aa3c-bc82-43ed-902c-ec3db1d5fb81"},

            "container": {"href": "https://epsilon.tech.local:4443/v5/AzureResources/containers/container1?accountId=ea98aa3c-bc82-43ed-902c-ec3db1d5fb81&RegionType=Global"},

            "folder": {"href": "https://epsilon.tech.local:4443/v5/AzureResources/containers/container1/folders/OSRv1?accountId=ea98aa3c-bc82-43ed-902c-ec3db1d5fb81&regionType=Global"}

         }

      }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.