The following page lists the HTTP operations that need to be performed to successfully download an LAC license. The client can successfully use the methods described below if the server is configured to support a given combination of methods.
Each web service that a client wishes to interact with has two parts: request parameters and the response, as described below.
To obtain license data for a given, unique combination of an activation key and a HostID, use the following request:
GET /licenses/(activation_key)/(hostids)
where:
- The activation_key (string) is your product activation key.
- The values of hostids are encoded in Base64 format.
Note that request headers are used by default.
Example request
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 Code | Header Field | Description |
|---|---|---|
| 200 OK | The license exists and it has been activated. | |
| 403 Forbidden | The license order has been disabled. | |
| 404 Not Found | The license does not exist. |
Example response
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.