Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Install a Veeam Backup & Replication License

You can install a new Veeam Backup & Replication server license with the specified system ID.

Request

To install a license, send the PUT HTTPS request to the URL of its resource.

HTTP Request

PUT https://<Availability-Console>:1281/v2/licensing/backupserverLicenses/{ID}

Request Headers

The request must contain the following headers:

Header

Value

Authorization

Bearer <Access-Token>

Content-Type

multipart/form-data; boundary=Random

Request Body

In the request body, the client must send the path and name of a license file in the following format:

--Random

Content-Disposition: form-data; name="file"; filename="FILE_NAME"

 

<@INCLUDE *FILE_PATH\FILE_NAME*@>

--Random--

 

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a message for an action.

Example Install a Veeam Backup & Replication License

The following example installs a backup license with ID c5aba79e-2ebf-4f7f-815c-33088d622cc5.

Request:

PUT https://localhost:1281/v2/licensing/backupserverLicenses/c5aba79e-2ebf-4f7f-815c-33088d622cc5

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

--Random

Content-Disposition: form-data; name="file"; filename="license.lic"

 

<@INCLUDE *C:\Users\administrator\license.lic*@>

--Random--

 

Response Code:

200 Success

 

Response Body:

"Backup server license key has been installed."

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference