Veeam Backup & Replication 13
REST API Reference
Related documents

Credentials

The Credentials section defines paths and operations for managing credentials records that are added to the backup server.

Get All Credentials

The HTTP GET request to the /api/v1/credentials path allows you to get an array of credentials records that are added to the backup server.

Available to: Veeam Backup Administrator, Veeam Security Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of credentials records to skip.

limit
integer <int32>

Maximum number of credentials records to return.

orderColumn
string (ECredentialsFiltersOrderColumn)

Sorts credentials by one of the credentials parameters.

Enum: "Username" "Description"
orderAsc
boolean

If true, sorts credentials in the ascending order by the orderColumn parameter.

nameFilter
string

Filters credentials by the nameFilter pattern. The pattern can match any credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.

typeFilter
string (ECredentialsType)

Filters credentials by type.

Enum: "Standard" "Linux"
createdAfterFilter
string <date-time>

Returns credentials that are created after the specified date and time.

createdBeforeFilter
string <date-time>

Returns credentials that are created before the specified date and time.

header Parameters
x-api-version
required
string
Default: 1.2-rev0

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

Responses
200

OK

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.

get/api/v1/credentials
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Credentials Record
The HTTP POST request to the /api/v1/credentials path allows you to add a credentials record.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
username
required
string
User name.


 
type
required
string (ECredentialsType) 
Credentials type.


 
password
string
Password.


 
description
string
Description of the credentials record.


 
uniqueId
string
Unique ID that identifies the credentials record.


 
Responses 
201
Account has been added.


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/credentials
Request samples 
application/json
{
  • "username": "string",
  • "password": "string",
  • "description": "string",
  • "type": "Standard",
  • "uniqueId": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "username": "string",
  • "description": "string",
  • "type": "Standard",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "uniqueId": "string"
}
Get Credentials Record
The HTTP GET request to the /api/v1/credentials/{id} path allows you to get a credentials record that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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.


404
Not found. No object was found with the path parameter 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.


get/api/v1/credentials/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "username": "string",
  • "description": "string",
  • "type": "Standard",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "uniqueId": "string"
}
Edit Credentials Record
The HTTP PUT request to the /api/v1/credentials/{id} path allows you to edit a credentials record that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
id
required
string <uuid> 
ID of the credentials record.


 
username
required
string
User name.


 
description
required
string
Description of the credentials record.


 
type
required
string (ECredentialsType) 
Credentials type.


 
creationTime
required
string <date-time> 
Date and time when the credentials were created.


 
uniqueId
string
Unique ID that identifies the credentials record.


 
Responses 
200
Credentials record has been updated.


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.


404
Not found. No object was found with the path parameter 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.


put/api/v1/credentials/{id}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "username": "string",
  • "description": "string",
  • "type": "Standard",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "uniqueId": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "username": "string",
  • "description": "string",
  • "type": "Standard",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "uniqueId": "string"
}
Remove Credentials Record
The HTTP DELETE request to the /api/v1/credentials/{id} path allows you to remove a credentials record that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
204
Credentials record has been removed.


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.


404
Not found. No object was found with the path parameter 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.


delete/api/v1/credentials/{id}
Request samples 
Response samples 
application/json
{ }
Change Password
The HTTP POST request to the /api/v1/credentials/{id}/changepassword path allows you to change a password of the credentials record that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
password
required
string
New password.


 
Responses 
200
Password has been changed.


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.


404
Not found. No object was found with the path parameter 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/credentials/{id}/changepassword
Request samples 
application/json
{
  • "password": "string"
}
Response samples 
application/json
{ }
Change Linux Private Key
The HTTP POST request to the /api/v1/credentials/{id}/changeprivatekey path allows you to change a Linux private key of the credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
privateKey
required
string
New private key.


 
passphrase
string
Passphrase that protects the private key.


 
Responses 
200
Private key has been changed.


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.


404
Not found. No object was found with the path parameter 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/credentials/{id}/changeprivatekey
Request samples 
application/json
{
  • "privateKey": "string",
  • "passphrase": "string"
}
Response samples 
application/json
{ }
Change Linux Root Password
The HTTP POST request to the /api/v1/credentials/{id}/changerootpassword path allows you to change a Linux root password of the credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
password
required
string
New password.


 
Responses 
200
Root password has been changed.


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.


404
Not found. No object was found with the path parameter 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/credentials/{id}/changerootpassword
Request samples 
application/json
{
  • "password": "string"
}
Response samples 
application/json
{ }
Get All Cloud Credentials
The HTTP GET request to the /api/v1/cloudCredentials path allows you to get an array of credentials records used to connect to cloud services.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of cloud credentials records to skip.


 
limit
integer <int32> 
Maximum number of cloud credentials records to return.


 
orderColumn
string (ECloudCredentialsFiltersOrderColumn) 
Sorts cloud credentials by one of the cloud credentials parameters.


 Enum: "Name" "Description"  
orderAsc
boolean
If true, sorts cloud credentials in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters cloud credentials by the nameFilter pattern. The pattern can match any cloud credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.


 
typeFilter
string (ECloudCredentialsType) 
Cloud credentials type.


 Enum: "AzureStorage" "AzureCompute" "Amazon" "Google" "GoogleService"  
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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.


get/api/v1/cloudCredentials
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Cloud Credentials Record
The HTTP POST request to the /api/v1/cloudCredentials path allows you to add a credentials record used to connect to cloud services.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
type
required
string (ECloudCredentialsType) 
Cloud credentials type.


 
account
required
string
Name of the Azure storage account.


 
sharedKey
required
string
Shared key of the Azure storage account.


 
description
string
Description of the cloud credentials record.


 
uniqueId
string
Unique ID that identifies the cloud credentials record.


 
Responses 
201
Cloud credentials record 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/cloudCredentials
Request samples 
application/json
{
  • "description": "Azure storage account",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "secretKey": "string",
  • "uniqueId": "createdbysheiladcory",
  • "account": "williamfox",
  • "sharedKey": "0sF53pZ/c8cVk+sEMby1lGZzA4SJezapyrFysdjlfLlUwMESTW6dEnkC3x62USr4cwHgPxarsBCE+ASt1Zjmwg=="
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Get Microsoft Entra ID Verification Code
The HTTP POST request to the /api/v1/cloudCredentials/appRegistration path allows you to get a single-use verification code required to register a new Microsoft Entra ID application.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
type
required
string (ECloudCredentialsType) 
Cloud credentials type.


 
region
required
string (EAzureRegionType) 
Microsoft Azure region.


 Enum: "China" "Germany" "Global" "Government"  
Responses 
201
Verification code has been received.


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/cloudCredentials/appRegistration
Request samples 
application/json
{
  • "type": "AzureCompute",
  • "region": "China"
}
Response samples 
application/json
{
  • "type": "AzureCompute",
  • "url": "string",
  • "verificationCode": "string",
  • "expirationTime": "2019-08-24T14:15:22Z"
}
Register Microsoft Entra ID Application
The HTTP POST request to the /api/v1/cloudCredentials/appRegistration/{verificationCode} path allows you to register a new Microsoft Entra ID application using the specified verificationCode.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
verificationCode
required
string
Verification code. To obtain the code, use the Get Microsoft Entra ID Verification Code request.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
Microsoft Entra ID application has been registered.


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/cloudCredentials/appRegistration/{verificationCode}
Request samples 
Response samples 
application/json
{
  • "type": "AzureCompute",
  • "applicationId": "string",
  • "secret": "string",
  • "tenantId": "string"
}
Get Google Authentication Information
The HTTP POST request to the /api/v1/cloudCredentials/authenticate path allows you to get authentication information required to sign in to Google Cloud.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
Authentication information has been received.


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/cloudCredentials/authenticate
Request samples 
Response samples 
application/json
{
  • "url": "string",
  • "verificationCode": "string",
  • "expirationTime": "2019-08-24T14:15:22Z"
}
Get Cloud Credentials Record
The HTTP GET request to the /api/v1/cloudCredentials/{id} path allows you to get a cloud credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the cloud credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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.


404
Not found. No object was found with the path parameter 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.


get/api/v1/cloudCredentials/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Edit Cloud Credentials Record
The HTTP PUT request to the /api/v1/cloudCredentials/{id} path allows you to edit a cloud credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the cloud credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
id
required
string <uuid> 
ID of the cloud credentials record.


 
type
required
string (ECloudCredentialsType) 
Cloud credentials type.


 
account
required
string
Name of the Azure storage account.


 
description
string
Description of the cloud credentials record.


 
uniqueId
string
Unique ID that identifies the cloud credentials record.


 
Responses 
200
Cloud credentials record has been updated.


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.


404
Not found. No object was found with the path parameter 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.


put/api/v1/cloudCredentials/{id}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Remove Cloud Credentials Record
The HTTP DELETE request to the /api/v1/cloudCredentials/{id} path allows you to remove a cloud credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the cloud credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
204
Cloud credentials record has been removed.


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.


404
Not found. No object was found with the path parameter 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.


delete/api/v1/cloudCredentials/{id}
Request samples 
Response samples 
application/json
{ }
Change Secret Key
The HTTP POST request to the /api/v1/cloudCredentials/{id}/changeSecretKey path allows you to change a secret key of a cloud credentials record that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the cloud credentials record.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
newSecretKey
required
string
New secret key.


 
Responses 
201
Secret key has been changed.


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/cloudCredentials/{id}/changeSecretKey
Request samples 
application/json
{
  • "newSecretKey": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Change Google Service Account
The HTTP POST request to the /api/v1/cloudCredentials/{id}/changeAccount path allows you to set a new Google Cloud service account associated with the same credentials id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Google service account.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
keyFile
required
string
Base64-encoded string of the content of a JSON key file containing a service account key.


 
Responses 
201
Service account has been changed.


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/cloudCredentials/{id}/changeAccount
Request samples 
application/json
{
  • "keyFile": "string"
}
Response samples 
application/json
{ }
Change Certificate
The HTTP POST request to the /api/v1/cloudCredentials/{id}/changeCertificate path allows you to change a certificate used for authentication in your Microsoft Entra ID application associated with an Azure compute account that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Azure compute account.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
certificate
required
string
Base64-encoded string of the content of a PFX certificate file.


 
formatType
required
string (ECertificateFileFormatType) 
Certificate file format.


 Value: "pfx"  
password
string
Decryption password for the certificate file.


 
Responses 
204
Certificate has been changed.


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/cloudCredentials/{id}/changeCertificate
Request samples 
application/json
{
  • "certificate": "string",
  • "formatType": "pfx",
  • "password": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "type": "AzureStorage",
  • "accessKey": "string",
  • "uniqueId": "string",
  • "account": "string"
}
Get All Helper Appliances
The HTTP GET request to the /api/v1/cloudCredentials/{id}/helperAppliances path allows you to get an array of Linux-based helper appliances of a Microsoft Azure compute account that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Azure compute account.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
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.


get/api/v1/cloudCredentials/{id}/helperAppliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add or Edit Helper Appliance
The HTTP POST request to the /api/v1/cloudCredentials/{id}/helperAppliances path allows you to create a new Linux-based helper appliance or edit settings of an existing one for a Microsoft Azure compute account that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Azure compute account.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
type
required
string (ECloudCredentialsType) 
Cloud credentials type.


 
subscriptionId
required
string <uuid> 
ID that Veeam Backup & Replication assigned to the Azure subscription.


 
location
string
Storage account location where you want to configure the helper appliance.


 
storageAccount
string
Name of the Azure storage account whose resources are used to store the helper appliance.


 
resourceGroup
string
Resource group associated with the helper appliance.


 
virtualNetwork
string
Network to which the helper appliance is connected.


 
subnet
string
Subnet for the helper appliance.


 
SSHPort
integer
Port over which Veeam Backup & Replication communicates with the helper appliance.


 
Responses 
201
An AzureApplianceDeploy session has been created. To check the progress, track the session state.


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/cloudCredentials/{id}/helperAppliances
Request samples 
application/json
{
  • "type": "AzureCompute",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "location": "string",
  • "storageAccount": "string",
  • "resourceGroup": "string",
  • "virtualNetwork": "string",
  • "subnet": "string",
  • "SSHPort": 0
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23"
}
Get Helper Appliance
The HTTP GET request to the /api/v1/cloudCredentials/{id}/helperAppliances/{applianceId} path allows you to get a Linux-based helper appliance with the applianceId of a Microsoft Azure compute account that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Azure compute account.


 
applianceId
required
string <uuid> 
ID of the helper appliance.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
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.


get/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}
Request samples 
Response samples 
application/json
{
  • "type": "AzureCompute",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "vmName": "string",
  • "location": "string",
  • "storageAccount": "string",
  • "resourceGroup": "string",
  • "virtualNetwork": "string",
  • "subnet": "string",
  • "SSHPort": 0
}
Remove Helper Appliance
The HTTP DELETE request to the /api/v1/cloudCredentials/{id}/helperAppliances/{applianceId} path allows you to remove a Linux-based helper appliance with the applianceId of a Microsoft Azure compute account that has the specified id.
Available to: Veeam Backup Administrator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Azure compute account.


 
applianceId
required
string <uuid> 
ID of the helper appliance.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
An AzureApplianceDeploy session has been created to remove the helper appliance. To check the progress, track the session state.


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.


404
Not found. No object was found with the path parameter 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.


delete/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23"
}