Veeam Backup & Replication 13
REST API Reference
Related documents

Helper Appliance Templates

The Helper Appliance Templates section defines operations for deploying, retrieving and removing helper appliance templates. Helper appliances are temporary appliances that Veeam Backup & Replication deploys in a public cloud to perform restore operations to that cloud.

Get All Helper Appliance Templates

The HTTP GET request to the /api/v1/backupInfrastructure/helperApplianceTemplates endpoint gets an array of all helper appliance templates that are added to the backup infrastructure.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of helper appliance templates to skip.

limit
integer <int32>
Default: 200

Maximum number of helper appliance templates to return.

orderColumn
string (EHelperApplianceTemplatesFiltersOrderColumn)

Sorts helper appliance templates by one of the helper appliance template parameters.

Enum: "Location" "ResourceGroup"
orderAsc
boolean

If true, sorts helper appliance templates in the ascending order by the orderColumn parameter.

locationFilter
string

Filters helper appliance templates by the locationFilter pattern. The pattern can match any helper appliance template parameter.

resourceGroupFilter
string

Filters helper appliance templates by the resourceGroupFilter pattern. The pattern can match any helper appliance template parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

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

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/backupInfrastructure/helperApplianceTemplates
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Deploy Helper Appliance Templates
The HTTP POST request to the /api/v1/backupInfrastructure/helperApplianceTemplates endpoint deploys an array of helper appliance templates to the backup infrastructure.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
Array of objects (AzureHelperApplianceTemplateSpec) 
Array of Azure helper appliance templates to deploy.


 
Responses 
201
An Infrastructure session has been created to deploy helper appliance templates. 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/backupInfrastructure/helperApplianceTemplates
Request samples 
application/json
{
  • "templates": [
    ]
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get Helper Appliance Template
The HTTP GET request to the /api/v1/backupInfrastructure/helperApplianceTemplates/{id} endpoint gets a helper appliance template that has the specified id.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Helper appliance template ID. To get the ID, run the Get All Helper Appliance Templates request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/backupInfrastructure/helperApplianceTemplates/{id}
Request samples 
Response samples 
application/json
{
  • "id": "5b8c2a14-3d7e-4f91-8a2b-1c6d9e0f4a73",
  • "spec": {
    }
}
Get Helper Appliance Template State
The HTTP GET request to the /api/v1/backupInfrastructure/helperApplianceTemplates/{id}/state endpoint gets the state of the helper appliance template that has the specified id. The state shows where the template is deployed (its Microsoft Azure subscription and region) and its current status, for example whether the template is up to date or must be upgraded.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Helper appliance template ID. To get the ID, run the Get All Helper Appliance Templates request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/backupInfrastructure/helperApplianceTemplates/{id}/state
Request samples 
Response samples 
application/json
{
  • "id": "5b8c2a14-3d7e-4f91-8a2b-1c6d9e0f4a73",
  • "subscriptionId": "0e6b9aa2-1f2b-4c1c-9a3e-7c2d8f5a6b10",
  • "location": "East US",
  • "status": "OK"
}
Remove Helper Appliance Templates
The HTTP POST request to the /api/v1/backupInfrastructure/helperApplianceTemplates/remove endpoint removes an array of helper appliance templates from the backup infrastructure.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
templateIds
required
Array of strings <uuid> 
Array of Azure helper appliance template IDs.


 
Responses 
201
An Infrastructure session has been created to remove helper appliance templates. 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/backupInfrastructure/helperApplianceTemplates/remove
Request samples 
application/json
{
  • "templateIds": [
    ]
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}