Veeam Backup for Microsoft Azure 8.1
REST API Reference
Related documents

Veeam Data Cloud Vault Connection

The /veeamVaults resource collection represents steps performed to connect the backup appliance to Veeam Data Cloud Vault.

Generate Authorization Link

The HTTP POST request to the /veeamVaults/oauth2/beginSignIn endpoint allows you to generate a link that you can use to authorize your backup appliance in Veeam Data Cloud Vault.

SecurityBearer
Request
Request Body schema: application/json
required
redirectUrl
required
string <= 255 characters

Specifies the backup appliance URL that will be used as a redirect URL in the Veeam Data Cloud Vault authorization.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8.1/veeamVaults/oauth2/beginSignIn
Request samples
application/json
{
  • "redirectUrl": "string"
}
Response samples
application/json
{
  • "location": "string",
  • "requestId": "string"
}

Get Authorization Status

The HTTP GET request to the /veeamVaults/oauth2/signInState endpoint retrieves the status of the backup appliance authorization in Veeam Data Cloud Vault.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the authentication request. To obtain the value of the id parameter, send the HTTP POST request to the Generate Authorization Link endpoint, and use the value returned in the requestId property.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

get/api/v8.1/veeamVaults/oauth2/{id}/signInState
Request samples 
Response samples 
application/json
{
  • "status": "Pending",
  • "message": "string"
}
Generate Veeam Data Cloud Vault Registration Token
The HTTP POST request to the /veeamVaults/oauth2/completeSignIn endpoint allows you to generate a token that you can use to register your backup appliance in Veeam Data Cloud Vault.


SecurityBearer 
Request 
Request Body schema: application/json
required
error
string or null  <= 255 characters 
Specifies an error returned to the authentication request.


 
errorDescription
string or null  <= 512 characters 
Specifies the error description.


 
code
string or null
Specifies the code returned to the authentication request.


 
state
string or null
Specifies the state returned to the authentication request.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


415
Client Error


post/api/v8.1/veeamVaults/oauth2/completeSignIn
Request samples 
application/json
{
  • "error": "string",
  • "errorDescription": "string",
  • "code": "string",
  • "state": "string"
}
Response samples 
application/json
{
  • "token": "string"
}
Get Veeam Data Cloud Vault Registration Information
The HTTP GET request to the /veeamVaults/registration endpoint retrieves information on whether your backup appliance is registered in Veeam Data Cloud Vault.


SecurityBearer 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8.1/veeamVaults/registration
Request samples 
Response samples 
application/json
{
  • "instanceRegistered": true,
  • "vdcManageLink": "string"
}
Register Veeam Data Cloud Vault
The HTTP POST request to the /veeamVaults/registration endpoint allows you to register your backup appliance in Veeam Data Cloud Vault. 
 
NOTE 
To complete this operation, obtain the value of the token parameter. To do that, send the HTTP POST request to the Generate Veeam Data Cloud Vault Registration Token endpoint.


SecurityBearer 
Request 
Request Body schema: application/json
required
token
required
string
Specifies a token generated by Veeam Backup for Microsoft Azure that you can use to register your backup appliance in Veeam Data Cloud Vault.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


post/api/v8.1/veeamVaults/registration
Request samples 
application/json
{
  • "token": "string"
}
Response samples 
application/json
{
  • "instanceRegistered": true,
  • "vdcManageLink": "string"
}
Get Storage Vaults List
The HTTP GET request to the /veeamVaults endpoint retrieves a list of storage vaults connected to your backup appliance in Veeam Data Cloud Vault.


SecurityBearer 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8.1/veeamVaults
Request samples 
Response samples 
application/json
[
  • {
    }
]
Import Storage Vault Data
The HTTP POST request to the /veeamVaults/importAccount endpoint imports data of a specific storage vault from Veeam Data Cloud to the Veeam Backup for Microsoft Azure configuration database. You can then use the imported data as an input in the HTTP POST request to the Add Backup Repository endpoint.


SecurityBearer 
Request 
Request Body schema: application/json
required
veeamVaultId
required
integer <int64> 
System ID assigned in the Veeam infrastructure to the storage vault whose data will be imported.


 
Responses 
200
OK


202
Accepted


400
Bad Request


401
Unauthorized


404
Not Found


409
Conflict


415
Client Error


post/api/v8.1/veeamVaults/importAccount
Request samples 
application/json
{
  • "veeamVaultId": 0
}
Response samples 
application/json
{
  • "azureAccountId": "string",
  • "azureAccountName": "string",
  • "storageAccount": {
    },
  • "storageAccountContainer": "string"
}