Getting Folders

In this article

    This section explains how to get a list of S3 Compatible or IBM object storage folders.

    Getting Folders Note

    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

    GET https://<hostname>:4443/v5/S3CompatibleResources/buckets/{bucketName}/folders?accountId=<accountId>&servicePoint=<servicePoint>&customRegionId=<customRegionId>&name=<name>

    Request Headers

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

    Request Parameters

    The following parameters must be specified in the URL of the request.

    Parameter

    Type

    Description

    bucketName

    string

    A name of the bucket.

    accountId

    string

    An identification number of the account under which you can connect to object storage.

    servicePoint

    string

    An endpoint address of the host server.

    customRegionId

    string

    An identification number of the region object storage belongs.

    name

    string

    A name of the folder.

    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

    Property

    Type

    Description

    path

    string

    A folder path.

    name

    string

    A folder name.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    Request:

    GET https://abc.tech.local:4443/v5/S3CompatibleResources/buckets/bucket1/folders?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&servicePoint=abc.tech.local:9000&customRegionId=us-east-1

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

         {

         "path": "Veeam/Backup365/RESTFolder/",

         "name": "RESTFolderStorage1",

         "links":       {

            "self": {"href": "https://abc.tech.local:4443/v5/S3CompatibleResources/buckets/bucket1/folders/111?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"},

            "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"}

         }

      },

         {

         "path": "Veeam/Backup365/RESTFolderStorage/",

         "name": "RESTFolderStorage",

         "links":       {

            "self": {"href": "https://abc.tech.local:4443/v5/S3CompatibleResources/buckets/bucket1/folders/Fastest?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"},

            "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"}

         }

      }

    ]

    I want to report a typo

    There is a misspelling right here:

     

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