This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Folders

You can get a list of Azure folders.

Request

GET https://<hostname>:4443/v5/AzureResources/containers/{containerName}/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

containerName

string

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

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 https://abc.tech.local:4443/v5/AzureResources/containers/container1/folders?accountId=db1befe9-f6cc-4e94-b473-7d6b4a52a6bf&regionType=Global

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

     {

     "path": "Veeam/Backup365/Azure Storage/",

     "_links":       {

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

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

     },

     "name": "Azure Storage"

  },

     {

     "path": "Veeam/Backup365/Folder1/",

     "_links":       {

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

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

     },

     "name": "Folder1"

  },

     {

     "path": "Veeam/Backup365/Folder2/",

     "_links":       {

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

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

     },

     "name": "Folder2"

  }

]