Veeam Backup & Replication 13
REST API Reference
Related documents

Cloud Browser

The Cloud Browser section defines paths and operations for retrieving information about cloud compute and storage resources. The Cloud Browser section helps you map a cloud folder with an object storage repository.

Get Cloud Hierarchy

The HTTP POST request to the /api/v1/cloudBrowser endpoint browses cloud resources (compute or storage) available for the specified storage account.

To reduce the response time and the number of records in the response, use filters if possible.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
resetCache
boolean

If true, the cache will be reset for this request. Resetting the cache slows down request processing but it allows you to get up-to-date data.

header Parameters
x-api-version
required
string
Default: 1.3-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
credentialsId
required
string <uuid>

ID of the object storage account (for browsing either storage or compute infrastructure).

serviceType
required
string (ECloudServiceType)

Type of cloud service.

regionType
string (EAzureRegionType)

Microsoft Azure region.

Enum: "China" "Global" "Government"
folderType
string (ECloudBrowserFolderType)

Folder type.

Enum: "Backup" "Archive"
gatewayServerId
string <uuid>

ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.

Responses
200

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/cloudBrowser
Request samples
application/json
{
  • "credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed",
  • "serviceType": "AzureBlob",
  • "regionType": "China",
  • "folderType": "Backup",
  • "gatewayServerId": "39c247aa-48c5-4705-90e0-b578a615649d"
}
Response samples
application/json
{
  • "credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed",
  • "serviceType": "AzureBlob",
  • "hostId": "70e3fb2d-1cb6-4dbc-ab8d-fa7209aca5dd",
  • "regionType": "China",
  • "containers": [
    ]
}

Get Cloud Virtual Machines

The HTTP POST request to the /api/v1/cloudBrowser/virtualMachines endpoint browses cloud virtual machines available for the specified storage account.

To reduce the response time and the number of records in the response, use the available filtering in the request body.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
resetCache
boolean

If true, the cache will be reset for this request. Resetting the cache slows down request processing but it allows you to get up-to-date data.

header Parameters
x-api-version
required
string
Default: 1.3-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
serviceType
required
string (EProtectionGroupCloudAccountType)

Cloud account type.

subscriptionId
required
string <uuid>

Filters compute resources by ID that Veeam Backup & Replication assigned to the Azure subscription.

regionType
required
string (EAzureRegionType)

Microsoft Azure region.

Enum: "China" "Global" "Government"
region
required
string

Filters compute resources by Azure region name.

object (AzureMachinesBrowserFilters)

Azure machines filters. Using the filters reduces not only the number of records in the response body but also the response time.

Responses
200

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/cloudBrowser/virtualMachines
Request samples
application/json
{
  • "serviceType": "Azure",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "regionType": "China",
  • "region": "string",
  • "filters": {
    }
}
Response samples
application/json
{
  • "serviceType": "Azure",
  • "regionType": "China",
  • "region": "string",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "virtualMachines": [
    ]
}

Create New Cloud Storage Folder

The HTTP POST request to the /api/v1/cloudBrowser/newFolder endpoint creates a new folder in the cloud infrastructure.

Available to: Veeam Backup Administrator.

NOTE
The REST API does not create new containers, you can create a folder in an existing container only.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
credentialsId
required
string <uuid>

ID of a cloud credentials record required to connect to the object storage.

serviceType
required
string (ECloudServiceType)

Type of cloud service.

newFolderName
required
string

Name of the new folder.

regionType
required
string (EAzureRegionType)

Microsoft Azure region.

Enum: "China" "Global" "Government"
containerName
required
string

Name of the container where you want to store your backup data.

hostId
string <uuid>

ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.

folderType
string (ECloudBrowserFolderType)

Folder type.

Enum: "Backup" "Archive"
Responses
201

Cloud folder has been created.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/cloudBrowser/newFolder
Request samples
application/json
{
  • "credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed",
  • "serviceType": "AzureBlob",
  • "newFolderName": "string",
  • "hostId": "70e3fb2d-1cb6-4dbc-ab8d-fa7209aca5dd",
  • "regionType": "China",
  • "containerName": "string",
  • "folderType": "Backup"
}
Response samples
application/json
{ }

Add Veeam Data Cloud Vault

The HTTP POST request to the /api/v1/cloudBrowser/initializeVault endpoint generates a credential record and a certificate to access Veeam Data Cloud Vault.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
vaultId
required
string

Vault ID. For more information on getting the ID, see the Getting Started with Veeam Data Cloud Vault section in the Veeam Data Cloud User Guide.

Responses
200

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/cloudBrowser/initializeVault
Request samples
application/json
{
  • "vaultId": "81580"
}
Response samples
application/json
{
  • "account": "vdvstorageprdus002883",
  • "uniqueId": "79e61001-0c10-4f7b-88ea-0b488bee29b4",
  • "type": "AzureStorage",
  • "id": "79e61001-0c10-4f7b-88ea-0b488bee29b4",
  • "description": "Veeam Data Cloud Vault credentials",
  • "lastModified": "2025-07-18T07:55:42.647022"
}

Browse Veeam Data Cloud Vault

The HTTP POST request to the /api/v1/cloudBrowser/{vaultId} endpoint browses cloud storage resources available for the Veeam Data Cloud Vault.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
path Parameters
vaultId
required
string

Vault ID.

query Parameters
resetCache
boolean

If true, the cache will be reset for this request. Resetting the cache slows down request processing but it allows you to get up-to-date data.

header Parameters
x-api-version
required
string
Default: 1.3-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
credentialsId
required
string <uuid>

ID of the object storage account (for browsing either storage or compute infrastructure).

serviceType
required
string (ECloudServiceType)

Type of cloud service.

regionType
string (EAzureRegionType)

Microsoft Azure region.

Enum: "China" "Global" "Government"
folderType
string (ECloudBrowserFolderType)

Folder type.

Enum: "Backup" "Archive"
gatewayServerId
string <uuid>

ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.

Responses
200

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/cloudBrowser/{vaultId}
Request samples
application/json
{
  • "credentialsId": "0da2f0ce-31b7-41f3-9eba-4a8841077a64",
  • "serviceType": "VeeamDataCloudVault",
  • "gatewayServerId": "6745a759-2205-4cd2-b172-8ec8f7e60ef8"
}
Response samples
application/json
{
  • "vaults": [
    ],
  • "gatewayServerId": "6745a759-2205-4cd2-b172-8ec8f7e60ef8",
  • "serviceType": "VeeamDataCloudVault",
  • "credentialsId": "00000000-0000-0000-0000-000000000000"
}