Veeam Backup & Replication 13
REST API Reference
Related documents

Deployment

The Deployment section defines operations for generating and downloading a Veeam Deployment Kit — a package that installs the certificates and components required for certificate-based (passwordless) authentication with the backup server. The kit can include Microsoft Windows, Linux, and Unix packages. Install the kit on components that you add to the backup infrastructure, such as Microsoft Windows managed servers, Microsoft Hyper-V hosts, Guest Interaction proxies, protected Microsoft Windows VMs, and Microsoft Windows, Linux or IBM AIX Veeam Agent computers.

Create Deployment Kit

The HTTP POST request to the /api/v1/deployment/generateKit endpoint generates a Veeam Deployment Kit — a package that enables certificate-based (passwordless) authentication with the backup server. The kit can include Microsoft Windows, Linux, and Unix packages. Install the kit on components that you add to the backup infrastructure — such as Microsoft Windows managed servers, Microsoft Hyper-V hosts, Guest Interaction proxies, protected Microsoft Windows VMs, and Microsoft Windows, Linux or IBM AIX Veeam Agent computers — so that Veeam Backup & Replication can connect to them using certificates instead of a user name and password.

Available to: Backup Administrator.

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
validityPeriodHours
integer <int32> [ 1 .. 8760 ]
Default: 720

Number of hours before the certificate in the deployment kit expires. Permitted values are 1–8760.

includeWindowsPackages
boolean
Default: true

If true, the deployment kit includes Windows packages.

includeLinuxPackages
boolean
Default: false

If true, the deployment kit includes Linux packages.

includeUnixPackages
boolean
Default: false

If true, the deployment kit includes Unix packages.

Responses
201

A DeploymentKit task has been started. To check the progress, track the task 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.

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/deployment/generateKit
Request samples
application/json
{
  • "validityPeriodHours": 3,
  • "includeWindowsPackages": true,
  • "includeLinuxPackages": false
}
Response samples
application/json
{
  • "type": "DeploymentKit",
  • "state": "Starting",
  • "result": "None",
  • "id": "80e0f085-8739-4d93-991c-e007b674f0bd",
  • "name": "Create deployment kit",
  • "progressPercent": 0,
  • "creationTime": "2025-05-27T09:47:08.8751255Z"
}

Download Deployment Kit Package

The HTTP GET request to the /api/v1/deployment/{taskId}/downloadKit endpoint downloads the deployment kit as a ZIP file. Copy the ZIP file to the target machine, extract its contents and run the included configuration script to install the required packages and certificates.

Available to: Backup Administrator.

SecurityBearer
Request
path Parameters
taskId
required
string <uuid>

ID of the task used to generate the deployment kit. To get the ID, run the Get All Tasks 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.

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/deployment/{taskId}/downloadKit
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "Unauthorized. Get bearer JWT token at /api/login"
}