License Management API v2.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Authentication

• HTTP Authentication, scheme: basic

• HTTP Authentication, scheme: Bearer

License Management

Endpoints supporting the update and review of active licenses.

Returns a description of the currently installed license

Code samples

# You can also use wget
curl -X GET /api/v2/license \
  -H 'Accept: application/json'

GET /api/v2/license HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/license',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/api/v2/license',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/license', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v2/license', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v2/license");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v2/license", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v2/license

Returns details of the active license along with usage information against each of the licensed Entitlement Limits.

Example responses

200 Response

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "halo:license",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "licenseHolder": "glasswall",
  "daysLeft": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "timestamp": "2019-08-24T14:15:22Z",
  "status": "active",
  "entitlements": [
    "Glasswall Embedded Engine: Main",
    "Glasswall Embedded Engine: Protect",
    "Glasswall Embedded Engine: Analysis",
    "Glasswall Embedded Engine: Export / Import",
    "Glasswall Halo: File Analysis Protect"
  ],
  "entitlementLimits": {
    "haloProcessingFileLimit": {
      "limit": "12k",
      "tally": 123,
      "flexDaysUsed": 0,
      "flexDaysLimit": "2",
      "flexAmountLimit": "1k"
    },
    "haloProcessingDataLimit": {
      "limit": "unlimited",
      "tally": 4567,
      "flexDaysUsed": 1,
      "flexDaysLimit": "2",
      "flexAmountLimit": "10%"
    }
  },
  "anomalies": [
    {
      "source": "string",
      "message": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ]
}

401 Response

[
  "Unauthorised request"
]

404 Response

[
  "License not found"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Schemas

LicenseId

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Unique identity of a license.

Properties

LicenseName

"halo:license"

Name assigned to the license when issued.

Properties

ProductId

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Unique identity of the product for which the license has been issued.

Properties

LicenseHolder

"glasswall"

Identifies the license holder. Read from the name of the ‘Group’ component within the License.

Properties

LicenseDayCount

0

Records how many days remain on the license before expiry.

Properties

LicenseStatus

"active"

Identifies the operational status of a validated license.

Properties

Enumerated Values

LicenseEntitlementName

"Embedded Engine: Main"

Name of the entitlement taken from the name property in the license.

Properties

LicenseEntitlementList

[
  "Glasswall Embedded Engine: Main",
  "Glasswall Embedded Engine: Protect",
  "Glasswall Embedded Engine: Analysis",
  "Glasswall Embedded Engine: Export / Import",
  "Glasswall Halo: File Analysis Protect"
]

List of license entitlements.

Properties

DecimalSIStringValue

"12M"

Define a string value that uses Decimal SI to size an integer value.

Properties

LicenseEntitlementLimit

"Unlimited"

Properties

oneOf

xor

Enumerated Values

LicenseEntitlementTally

0

Reported value of a Entitlement Limit Tally

Properties

LicenseEntitlementLimitUsageItem

{
  "limit": "Unlimited",
  "tally": 0,
  "flexDaysUsed": 0,
  "flexDaysLimit": "Unlimited",
  "flexAmountLimit": "Unlimited"
}

Reports that tally value against the associated entitlement limit.

Properties

LicenseEntitlementLimitUsageList

{
  "haloProcessingFileLimit": {
    "limit": "12k",
    "tally": 123,
    "flexDaysUsed": 0,
    "flexDaysLimit": "2",
    "flexAmountLimit": "1k"
  },
  "haloProcessingDataLimit": {
    "limit": "unlimited",
    "tally": 4567,
    "flexDaysUsed": 1,
    "flexDaysLimit": "2",
    "flexAmountLimit": "10%"
  }
}

List reporting the tally and limit values for each license entitlement limit.

Properties

AnomalySource

"string"

Provided by the source property of the reporting event.

Properties

AnomalyMessage

"string"

Description of the detected anomaly.

Properties

Timestamp

"2019-08-24T14:15:22Z"

Properties

AnomalyItem

{
  "source": "string",
  "message": "string",
  "time": "2019-08-24T14:15:22Z"
}

Properties

LicenseAnomalyList

[
  {
    "source": "string",
    "message": "string",
    "time": "2019-08-24T14:15:22Z"
  }
]

Properties

LicenseDetails

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "halo:license",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "licenseHolder": "glasswall",
  "daysLeft": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "timestamp": "2019-08-24T14:15:22Z",
  "status": "active",
  "entitlements": [
    "Glasswall Embedded Engine: Main",
    "Glasswall Embedded Engine: Protect",
    "Glasswall Embedded Engine: Analysis",
    "Glasswall Embedded Engine: Export / Import",
    "Glasswall Halo: File Analysis Protect"
  ],
  "entitlementLimits": {
    "haloProcessingFileLimit": {
      "limit": "12k",
      "tally": 123,
      "flexDaysUsed": 0,
      "flexDaysLimit": "2",
      "flexAmountLimit": "1k"
    },
    "haloProcessingDataLimit": {
      "limit": "unlimited",
      "tally": 4567,
      "flexDaysUsed": 1,
      "flexDaysLimit": "2",
      "flexAmountLimit": "10%"
    }
  },
  "anomalies": [
    {
      "source": "string",
      "message": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ]
}

Provides detailed information of the license contents

Properties

Error

[
  "string"
]

Properties

None