Getting Folder by Name

You can get information about an Azure storage folder with the specified name.

Request

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

containerName

string

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

Name

string

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

accountId

string

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

RegionType

string

Specifies a region type. The following types are available:

  • Global
  • Germany
  • China
  • Government

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 body contains the following properties:

Property

Type

Description

path

string

Specifies the folder path.

name

string

Specifies the folder name.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example shows how to get information about the Azure storage folder with the specified name that was created in the container1 container by the specified cloud account in the region with the Global region type.

Request:

GET https://abc.tech.local:4443/v6/AzureResources/containers/container1/folders/Folder4?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&RegionType=Global

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "path": "Veeam/Backup365/Folder4/",

 "_links": {

   "self": {

     "href": "/v6/AzureResources/containers/container1/folders/Folder4?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&regionType=Global"

   },

   "account": {

     "href": "/v6/accounts/b59af548-3406-4681-a56b-3dfc6c379e96"

   },

   "container": {

     "href": "/v6/AzureResources/containers/container1?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&RegionType=Global"

   }

 },

 "name": "Folder4"

}