Install License

You can upload a license file obtained from Veeam.

Note

The information in this section applies only to the BYOL edition of Veeam Backup for Microsoft Azure.

Request

To upload the license file, send the HTTP POST request to the /license endpoint.

HTTP Request

POST https://<hostname>/api/v2/license

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Content-Type

Required

multipart/form-data; boundary=--Random

Identifies a media type that is used in the body of the request.

Request Body

To upload and replace the certificate send the licenseFile.

--Random

Content-Disposition: form-data; name="licenseFile"; filename="FILE_NAME.lic"

 

<@INCLUDE *FILE_PATH\FILE_NAME.lic*@>

 

--Random--

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

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

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns new license details. The LicenseInfoV2 schema is used for the representation.

Install LicenseExample

The following request uploads the new license file.

Request:

POST https://51.11.247.127/api/v2/license

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: multipart/form-data; boundary=Random

 

Request Body:

--Random

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

 

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

 

--Random--

 

 

Response:

200

 

Response Body:

{

  "licenseType": "Subscription",

  "instancesUses": 1,

  "instances": 100,

  "company": "Veeam Software",

  "email": "rd@veeam.com",

  "licenseExpires": "2020-04-01T00:00:00",

  "licenseId": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",

  "supportId": "12345678",

  "gracePeriodDays": 30,

  "veeamOnlineStoreUrl": "https://www.veeam.com/buy-backup-for-azure.html?ad=azure-prod&buynow=eyJBcGlWZXJzaW9uIjoiMSIsIlBsYW4iOnsiTmFtZSI6IiIsIlByb2R1Y3QiOiIiLCJQcm9tb3Rpb25Db2RlIjpudWxsfSwiU3Vic2NyaXB0aW9uSWQiOiIzYTlhNDkzMC03YmJjLTRiODMtOWM2OC0xNWQ2NzRmYmM4MDMifQ==",

  "licensingServer": {

    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "hostname": "tech.local",

    "status": "Available",

    "isExpired": true

 }

}

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.