This page refers to End-user REST API version 2 only. See End-user REST API for links to other versions of the End-user REST API.


To activate a license for a given, unique combination of an activation key and a HostID using the End-user REST API version 2, use the following request:

PUT /licenses/(activation_key)/(hostids)

where:

and

  • hostids (string) are Base64 encoded values. The format of HostID(s) that you can specify is a comma-separated list of types and values; for example, ETHERNET=AABBCCDDEEFF,IPADDRESS=192.168.0.5

 Note that request headers are used by default.

Example request

PUT /rest/v2/licenses/4CT1V-4T10N-K3Y1S-C000L/dHlwZTE9dmFsdWUxLHR5cGUyPXZhbHVlPTI= HTTP/1.1
Host: license.x-formation.com
Accept: application/hal+json

Response

The LAC REST API returns standard HTTP response codes described in the following table.

Status CodeHeader FieldDescription
202 Accepted

New license request has been created after successful license validation. The Location header field contains an absolute URI for automatic redirection to this resource.


400 Bad Request



Requested activation key is invalid or the format of a hostid is wrong. Response body contains more detailed information about this error.

 

 


 403 ForbiddenLicense cannot be activated, because it is not in sync with the internal configuration. Response message contains more information.

Example responses

HTTP/1.1 202 Accepted
Location: https://license.x-formation.com/rest/v2/license-queue/4CT1V-4T10N-K3Y1S-C000L/dHlwZTE9dmFsdWUxLHR5cGUyPXZhbHVlPTI=
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
 
{
    "code": 1600,
    "message": "Hostid wrong format."
}
HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
    "code": 1709,     
    "message": "License generator not uploaded."
}

For more information about HTTP methods, see Supported HTTP methods.

  • No labels