Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following page lists the HTTP operations that need to be performed to successfully download an LAC license.

To obtain license data for a given, unique combination of an activation key and a HostID, use the following request:

Panel

GET /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

Code Block
languagejs
firstline1
linenumberstrue
GET /rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWE= HTTP/1.1
Host: license.x-formation.com
Accept: application/hal+json

Response

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

Status CodeHeader FieldDescription
200 OKLicense exists and it has been activated.
403 ForbiddenLicense order has been disabled.
404 Not FoundLicense does not exist.

   Example response

Code Block
languagejs
firstline1
linenumberstrue
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/hal+json

 {
     "activationKey": "25N8D-NC35D-WD01P-8JI4K",
     "activationTime": "2014-04-29T11:31:51+00:00",
     "expirationDate": null,
     "maintenanceEndDate": null,
     "hostids": [
         {
             "nameRaw": "CUSTOM",
             "name": "Custom",
             "value": "a"
         }
     ],
     "content": "# This license is generated using X-Formation License Activation Center
                 # Generation Time: 2014-04-29 11:31:50 GMT
                 # Activation Key: 25N8D-NC35D-WD01P-8JI4K

                 FEATURE feature-1
                 {
                 VENDOR=X-FORMATION VERSION=1.0
                 KEY=QQkUjKBGw6vPmoNM7cQIeHriCThHSD7psQSp0]YRAibvJbD]hrxC]fiZ1VyAnjb9uJuNivH67TIn7ygcOzO4AUNfVrgQ0oooFlhh \
                      tapNGT0hc1xe2UdTxxFt2y0S1Zi6uZ[JDpFc27Bjq3AIDSI7br[VrUqYGovQvkGnqwFk9ADKt9lEvTmirWz27FjEg2WIpGh[Qaatc \
                      te2tEXcIvy[iFH1e]jj18LQcHXnp8ze4zzeHyoGfXeqIL[BdELtQQ6q5oKJ8ACmrfZF2Rh2tKZOWKq4xXs4xmn0XsdRT3QDco2o9d \
                      ttwtPAh2ABimjNbrlPF8V9sabGw5]GU4poT7rq]pyDjnckbLTZ9z5f]4K[Tbb]Aa7406K8gx4dO6wFITq0NRgmmfFOLSEn6KHdwFf \
                      tERlqVXGzGjU7R490iA6cc43cnbHom[qMGboDOmIysXreBLgrWJ2wURL97U83njRQaL4qSHXXIVGTSxSvVCoWFcVq3urCHHAMhsaw
                 }",
     "filename": "license_2014_04_29-11_31.lic",
     "_links": {
         "self": {
             "href": "https://license.x-formation.com/rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWE="
         },
         "license-order": {
             "href": "https://license.x-formation.com/rest/v1/license-orders/25N8D-NC35D-WD01P-8JI4K"
         }
     },
     "_embedded": {
         "license-orders": [
             {
                 "activationKey": "25N8D-NC35D-WD01P-8JI4K",
                 "customer": {
                     "name": "customer1ó?"
                 },
                 "product": {
                     "name": "product 1",
                     "version": "2",
                     "template": "Default",
                     "licenseGeneratorType": "lm_x"
                 },
                 "licenseType": "local",
                 "creationTime": "2014-04-14T09:45:50+00:00",
                 "activatedLicenses": 7,
                 "bulkMax": 10,
                 "hostid": {
                     "types": [
                         {
                             "nameRaw": "CUSTOM",
                             "name": "Custom",
                             "min": 1,
                             "max": 1
                         }
                     ],
                     "min": 1
                 },
                 "_links": {
                     "self": {
                         "href": "https://license.x-formation.com/rest/v1/license-orders/25N8D-NC35D-WD01P-8JI4K"
                     }
                 }
             }
         ]
     }

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