This is an archive version of the document. To get the most up-to-date information, see the current version.

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 AWS.

Request

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

HTTP Request

POST https://<hostname>:<port>/api/v1/licensing/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.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

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 Code

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 AWS returns new license details. The LicenseInfo schema is used for the representation.

Install LicenseExample

The following request uploads the new license file.

Request:

POST https://135.169.170.192:11005/api/v1/licensing/license

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

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": 0,

 "instances": 100,

 "licensedTo": "CompanyName",

 "licenseExpires": "2021-06-10T08:40:48.305Z",

 "licenseId": "OU7890",

 "supportId": "9C75",

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/licensing/license"

   }

 ]

}