Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure Storage Accounts

The /cloudInfrastructure/storageAccounts resource collection represents Azure storage accounts configured in the Microsoft Azure environment.

Get Collection of Storage Accounts

The HTTP GET request to the /cloudInfrastructure/storageAccounts endpoint retrieves a list of Azure storage accounts to which Veeam Backup for Microsoft Azure has permissions.

SecurityBearer
Request
query Parameters
subscriptionId
string or null <uuid>

Returns only storage accounts that belong to a subscription with the specified ID.

x-veeam-parameter-group: StorageAccountOptions
accountId
string or null

Returns only a storage account with the specified ID.

x-veeam-parameter-group: StorageAccountOptions
regionIds
Array of strings or null

Returns only storage accounts that reside in Azure regions with the specified IDs.

x-veeam-parameter-group: StorageAccountOptions
name
string or null

Returns only a storage account with the specified name.

x-veeam-parameter-group: StorageAccountOptions
resourceGroupName
string or null

Returns only storage accounts associated with the specified resource group.

x-veeam-parameter-group: StorageAccountOptions
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: StorageAccountOptions
repositoryCompatible
boolean
Default: false

Defines whether to return only storage accounts in which a backup repository can be created.

x-veeam-parameter-group: StorageAccountOptions
vhdCompatible
boolean
Default: false

Defines whether to return only storage accounts in which snapshot creation is enabled for virtual disks that are stored in the accounts.

x-veeam-parameter-group: StorageAccountOptions
offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
serviceAccountId
string or null
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/storageAccounts
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts?subscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&accountId=string&regionIds=string&name=string&resourceGroupName=string&sync=true&repositoryCompatible=false&vhdCompatible=false&offset=0&limit=-1&serviceAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Storage Account Data

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{storageAccountId} endpoint retrieves information on Azure storage account with the specified ID.

SecurityBearer
Request
path Parameters
storageAccountId
required
string or null

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

query Parameters
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

serviceAccountId
string or null
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{storageAccountId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{storageAccountId}?sync=true&serviceAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "resourceId": "string",
  • "name": "string",
  • "skuName": "string",
  • "performance": "Standard",
  • "redundancy": "Unknown",
  • "accessTier": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "resourceGroupName": "string",
  • "removedFromAzure": true,
  • "supportsTiering": true,
  • "isImmutableStorage": true,
  • "isImmutableStoragePolicyLocked": true,
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "tenantId": "string",
  • "_links": {}
}

Get Storage Account Capabilities

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{storageAccountId}/capabilities endpoint verifies whether a specific storage account supports archive tier.

SecurityBearer
Request
path Parameters
storageAccountId
required
string

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

query Parameters
accountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to access the storage account.

sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{storageAccountId}/capabilities
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{storageAccountId}/capabilities?accountId=string&sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "supportsArchive": true,
  • "recommendedConcurrency": 0
}

Get Collection of Blob Containers

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{azureStorageId}/containers endpoint retrieves a list of blob containers that reside in the Azure storage account with the specified ID.

SecurityBearer
Request
path Parameters
azureStorageId
required
string or null

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

query Parameters
accountId
required
string <uuid>

Returns only storage accounts to which the service account with the specified ID has access.

x-veeam-parameter-group: AzureStorageContainerOptions
searchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: AzureStorageContainerOptions
offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08&searchPattern=string&offset=0&limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{}

Create Blob Container in Storage Account

The HTTP POST request to the /cloudInfrastructure/storageAccounts/{azureStorageId}/containers endpoint creates a new blob container in a storage account with the specified ID.

SecurityBearer
Request
path Parameters
azureStorageId
required
string or null

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
name
required
string non-empty

Specifies a name for the created item.

accountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to create the item.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

post/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers
Request samples
application/json
{
  • "name": "string",
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9"
}
Response samples
application/json
{
  • "name": "string",
  • "supportsVersioning": true,
  • "ImmutabilityPolicyState": "NotPresent",
  • "_links": {}
}

Get Blob Container Data

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{storageAccountId}/container/{containerName} endpoint retrieves information on a blob container with the specified name.

SecurityBearer
Request
path Parameters
azureStorageId
required
string

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

containerName
required
string or null

Specifies the name of a blob container.

query Parameters
accountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to access the storage account.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}?accountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "name": "string",
  • "supportsVersioning": true,
  • "ImmutabilityPolicyState": "NotPresent",
  • "_links": {}
}

Get Collection of Folders

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders endpoint retrieves a list of folders created in a blob container with the specified name.

SecurityBearer
Request
path Parameters
azureStorageId
required
string or null

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

containerName
required
string or null

Specifies the name of a blob container.

query Parameters
accountId
required
string

Returns only folders to which the service account with the specified ID has permissions.

x-veeam-parameter-group: AzureStorageFolderOptions
searchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: AzureStorageFolderOptions
offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders?accountId=string&searchPattern=string&offset=0&limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{}

Get Folder Data

The HTTP GET request to the /cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders/{folderName} endpoint retrieves information on a folder with the specified name.

SecurityBearer
Request
path Parameters
azureStorageId
required
string or null

Specifies the system ID assigned to a storage account in the Veeam Backup for Microsoft Azure REST API.

containerName
required
string or null

Specifies the name of a blob container.

folderName
required
string or null

Specifies the name of a folder.

query Parameters
accountId
required
string

Specifies a service account whose permissions are used to access the folder.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders/{folderName}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folders/{folderName}?accountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "name": "string",
  • "supportsVersioning": true,
  • "ImmutabilityPolicyState": "NotPresent",
  • "_links": {}
}