Veeam Backup & Replication 13
REST API Reference
Related documents

Deployment

The Deployment section defines paths and operations for generating and downloading a deployment kit that is used for adding Windows machines as managed servers.

Create Deployment Kit

The HTTP POST request to the /api/v1/deployment/generateKit path allows you to generate a deployment kit which can be used for adding Windows machines as managed servers.

Available to: Veeam Backup Administrator.

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

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

Request Body schema: application/json
validityPeriodHours
integer <int32>

Number of hours before the certificate in the deployment kit expires. If you do not provide a request body, the default value is 24 hours.

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"
}
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 path allows you to download the deployment kit as a ZIP file. Save the ZIP file to the Windows server you want to add as a managed server, extract its contents and run the InstalDeploymentKit.bat configuration script to install the required packages and certificates.

Available to: Veeam 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-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/deployment/{taskId}/downloadKit
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}