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 check the status of license activation for a given, unique combination of an activation key and a HostID using the End-user REST API version 2, use the following request:

GET /license-queue/(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

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

Response

The following table lists the Internet status codes that can be returned in a response by a server.

Status CodeHeader FieldDescription
200 OKLicense is being activated.
303 See Other

License activation finished and the response to the request can be found under a new location, which depends on whether the activation was successful or not.

 

403 ForbiddenLicense order has been disabled.
404 Not FoundLicense activation was not requested.

Example responses

HTTP/1.1 200 OK
Content-Type: application/hal+json
 
{
    "creationTime": "2014-07-15T06:08:39+00:00",
    "expirationDate": "2014-07-17T00:00:00+00:00",
    "maintenanceEndDate": null,
    "hostids": [
        {
            "nameRaw": "USERNAME",
            "name": "Username",
            "value": "test"
        }
    ],
    "_links": {
        "self": {
            "href": "https://license.x-formation.com/rest/v2/license-queue/UQJ7W-HFBTO-DBKH2-C4COW/VVNFUk5BTUU9dGVzdA=="
        }
    }
}
HTTP/1.1 303 See Other
Location: https://license.x-formation.com/rest/v2/license-errors/4CT1V-4T10N-K3Y1S-C000L/dHlwZTE9dmFsdWUxLHR5cGUyPXZhbHVlPTI=
HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
	"code": 1703,
    "message": "License order disabled."
}
HTTP/1.1 404 Not Found
Content-Type: application/hal+json
 
{
    "code": 1707,
    "message": "License generation was not requested."
}

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

  • No labels