Getting Folders

In this article

    You can get a list of Amazon folders.

    Request

    GET https://<hostname>:4443/v5/S3Resources/buckets/{bucketName}/folders?accountId=<accountId>&regionType=<regionType>

    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

    Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets.

    accountId

    string

    Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.

    regionType

    string

    A region type of the object storage.

    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

    path

    string

    A folder path.

    name

    string

    A folder name.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    Request:

    GET /v5/S3Resources/buckets/twbucket/folders?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&regionType=Global

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [{

      "path": "Veeam/Backup365/Amazon Backups/",

      "name": "Amazon Backups",

      "links":    {

         "self": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/twbucket/folders/Amazon Backups?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&regionType=Global"},

         "account": {"href": "https://abc.tech.local:4443/v5/accounts/de4f0671-953c-4f88-a60f-731bc8277e3a"},

         "bucket": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/twbucket?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&RegionType=Global"}

      }

    }]