Install Veeam Service Provider Console License

You can install a license on the Veeam Service Provider Console server.

Required Privileges

To perform this task, a user must have the Portal Administrator role assigned.

Request

To install a license on the Veeam Service Provider Console server, send the PUT HTTP request to the URL of the /licensing/console resource.

HTTP Request

PUT https://<hostname>:1280/api/v3/licensing/console

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

application/json

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

Accept

Optional

application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Description

license

formData

file

No

License file

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 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

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 Service Provider Console returns a resource representation based on the ConsoleLicense schema.

Example Install Veeam Service Provider Console License

The following request installs a license on a Veeam Service Provider Console server.

Request:

PUT https://localhost:1280/api/v3/licensing/console

 

Request Header:

Content-type: application/json

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 OK

 

Response Body:

{

 "data": {

   "licenseId": "77712222-1111-2222-3333-111112223333",

   "edition": "Enterprise Plus",

   "package": "backup",

   "licenseeCompany": "Alpha Provider",

   "licenseeEmail": "a. smith@alpha.com",

   "licenseeAdministratorEmail": "admin@alpha.com",

   "contactPerson": "Alan Smith",

   "expirationDate": "2020-07-30T10:00:00+03:00",

   "supportExpirationDate": "2020-07-30T10:00:00+03:00",

   "supportId": "00123456",

   "status": "valid",

   "statusMessage": "Valid (145 days until expiration)",

   "cloudConnect": "yes",

   "instances": 1000.0,

   "type": "rental",

   "lastUpdateDate": null,

   "lastUpdateMessage": null,

   "lastUpdateStatus": "unknown"

 }

}

I want to report a typo

There is a misspelling right here:

 

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