Get Folder Status

You can get data on a status of the folder with the specified name.

Request

To get a status of the folder with the specified name, send the HTTP GET request to the /cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folderState endpoint. {storageAccountId} is a system ID assigned to the Azure storage account in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/storageAccounts/{storageAccountId}/container/{containerName}/folderState

Query Parameters

To control the amount and order of data in the response, you can use the following query parameters:

Query Parameter

Required/Optional

Value

Description

FolderName

required

string

Returns only folders with the specified name.

AccountId

optional

string

System ID of the Azure account whose permissions will be used to access the Azure storage account.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns information on a status of a folder with the specified name. The StorageAccount schema is used for the resource representation.

Get Folder StatusExample

The following request returns information on a status of a folder with the name backup_folder.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/storageAccounts/5i6k9o4s4tf9pfnx4rct6fqg9ruf8oyznrpmyutjrfbne3p4wjeo/containers/bootdiagnostics/folderState?FolderName=backup_folder&AccountId=1

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

"ContainsRepository"

I want to report a typo

There is a misspelling right here:

 

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