License Management API v1.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 digitally signed usage report

Code samples

# You can also use wget
curl -X GET /api/v1/license-usage/{licenseId} \
  -H 'Accept: application/json'

GET /api/v1/license-usage/{licenseId} HTTP/1.1

Accept: application/json

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

fetch('/api/v1/license-usage/{licenseId}',
{
  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/v1/license-usage/{licenseId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/license-usage/{licenseId}', 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/v1/license-usage/{licenseId}', 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/v1/license-usage/{licenseId}");
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/v1/license-usage/{licenseId}", data)
    req.Header = headers

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

GET /api/v1/license-usage/{licenseId}

Returns a digitally signed report that details the system usage associated with the specified license

Parameters

Example responses

200 Response

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

401 Response

[
  "Unauthorised request"
]

404 Response

[
  "License not found"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Returns a digitally signed usage report for the currently active license

Code samples

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

GET /api/v1/license-usage/active HTTP/1.1

Accept: application/json

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

fetch('/api/v1/license-usage/active',
{
  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/v1/license-usage/active',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/license-usage/active', 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/v1/license-usage/active', 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/v1/license-usage/active");
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/v1/license-usage/active", data)
    req.Header = headers

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

GET /api/v1/license-usage/active

Returns a digitally signed report that details the system usage associated with the currently active license

Example responses

200 Response

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

401 Response

[
  "Unauthorised request"
]

404 Response

[
  "License not found"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Enables the insertion of new license certificate file

Code samples

# You can also use wget
curl -X POST /api/v1/license \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/v1/license HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '-----BEGIN LICENSE FILE-----
  eyJlbmMiOiJleUprWVhSaElqcDdJbWxrSWpvaU1EYzFZV05sT1RFdFlUaGtP
  UzAwTVdObUxXRmtNMk10TTJJd01EWXpOakF5WTJRMUlpd2lkSGx3WlNJNklt
...
YithdmN6WmVTMitrZGxrKzNwZ0RGTXhueHVpWkNYQUI3RlRrYnB5MkRRPT0i
LCJhbGciOiJiYXNlNjQrZWQyNTUxOSJ9
-----END LICENSE FILE-----
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/license',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/api/v1/license',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v1/license', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','/api/v1/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/v1/license");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

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

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

POST /api/v1/license

This endpoint facilitates requests to store a new active Glasswall License. It’s important to note that only a single license can be saved at any given time, and uploading a new license will overwrite the existing one.

The submitted license undergoes validation before being distributed through the system. Currently, the validation process includes checking the license signature and verifying the expiry date. In case either of these checks fails, the specific failure is reported in the response.

Body parameter

"-----BEGIN LICENSE FILE-----\n  eyJlbmMiOiJleUprWVhSaElqcDdJbWxrSWpvaU1EYzFZV05sT1RFdFlUaGtP\n  UzAwTVdObUxXRmtNMk10TTJJd01EWXpOakF5WTJRMUlpd2lkSGx3WlNJNklt\n...\nYithdmN6WmVTMitrZGxrKzNwZ0RGTXhueHVpWkNYQUI3RlRrYnB5MkRRPT0i\nLCJhbGciOiJiYXNlNjQrZWQyNTUxOSJ9\n-----END LICENSE FILE-----\n"

Parameters

Example responses

200 Response

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "licenseHolder": "license_inc",
  "daysLeft": 0,
  "startDate": "2019-08-24",
  "expirationDate": "2019-08-24",
  "status": "active",
  "entitlements": [
    "haloProcessingFileLimit",
    "haloProcessingDataLimit"
  ],
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

400 Response

[
  "Invalid license content"
]

401 Response

[
  "Unauthorised request"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Returns a description of the currently installed license.

Code samples

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

GET /api/v1/license HTTP/1.1

Accept: application/json

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

fetch('/api/v1/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/v1/license',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/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/v1/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/v1/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/v1/license", data)
    req.Header = headers

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

GET /api/v1/license

This endpoint facilitates requests to retrieve the up-to-date active Glasswall license from Glasswall Halo. The response body comprises a summary that includes essential details about the license, such as the remaining number of days and a list of the associated software entitlements.

Example responses

200 Response

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "licenseHolder": "license_inc",
  "daysLeft": 0,
  "startDate": "2019-08-24",
  "expirationDate": "2019-08-24",
  "status": "active",
  "entitlements": [
    "haloProcessingFileLimit",
    "haloProcessingDataLimit"
  ],
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

401 Response

[
  "Unauthorised request"
]

404 Response

[
  "License not found"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Enables the currently installed license to be deleted

Code samples

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

DELETE /api/v1/license HTTP/1.1

Accept: application/json

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

fetch('/api/v1/license',
{
  method: 'DELETE',

  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.delete '/api/v1/license',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('/api/v1/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('DELETE','/api/v1/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/v1/license");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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("DELETE", "/api/v1/license", data)
    req.Header = headers

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

DELETE /api/v1/license

This endpoint facilitates a request to remove the active license from the Glasswall Halo. If the license is successfully deleted a response is returned confirming deletion. The changes will propagate throughout the system within a few seconds. However the processing of in-flight transactions will be completed.

Example responses

401 Response

[
  "Unauthorised request"
]

403 Response

{
  "errors": [
    {
      "errorCode": 4033,
      "errorDescription": "Access denied, Admin role is required"
    }
  ]
}

5XX Response

[
  "System error processing request"
]

Responses

Returns list of available licenses

Code samples

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

GET /api/v1/license-usage HTTP/1.1

Accept: application/json

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

fetch('/api/v1/license-usage',
{
  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/v1/license-usage',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/license-usage', 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/v1/license-usage', 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/v1/license-usage");
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/v1/license-usage", data)
    req.Header = headers

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

GET /api/v1/license-usage

Returns a list of currently active and previous licenses. If none are available, an empty list is returned.

Example responses

200 Response

[
  {
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "licenseName": "license_inc:001",
    "active": true
  }
]

401 Response

[
  "Unauthorised request"
]

5XX Response

[
  "System error processing request"
]

Responses

Response Headers

Schemas

LicenseId

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

Properties

LicenseName

"license_inc:001"

Properties

LicenseActiveState

true

Identifies whether the specified License is the currently active license, or not.

Properties

ProductId

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

Properties

LicenseHolder

"license_inc"

Properties

LicenseDayCount

0

Properties

LicenseDate

"2019-08-24"

Properties

LicenseStatus

"active"

Properties

Enumerated Values

LicenseEntitlementName

"processingFeature"

Properties

LicenseEntitlementList

[
  "haloProcessingFileLimit",
  "haloProcessingDataLimit"
]

Properties

LicenseEntitlementLimitItem

"string"

Properties

LicenseEntitlementLimitList

{
  "haloProcessingFileLimit": "12k",
  "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
}

Each License Entitlement Limit consists of a unique name and an associated threshold value.

Properties

LicenseUsageAvailabilityList

[
  {
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "licenseName": "license_inc:001",
    "active": true
  }
]

Properties

LicenseUsageReportDetails

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

Summary of license and its entitlement limits

Properties

LicenseDetails

{
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseName": "license_inc:001",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "licenseHolder": "license_inc",
  "daysLeft": 0,
  "startDate": "2019-08-24",
  "expirationDate": "2019-08-24",
  "status": "active",
  "entitlements": [
    "haloProcessingFileLimit",
    "haloProcessingDataLimit"
  ],
  "entitlementLimits": {
    "haloProcessingFileLimit": "12k",
    "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
  }
}

Provides detailed information of the license contents

Properties

ErrorCodeResponse

{
  "errors": [
    {
      "errorCode": 4033,
      "errorDescription": "Access denied, Admin role is required"
    }
  ]
}

Properties

ErrorResponse

[
  "string"
]

Properties

None

LicenseFileBody

"-----BEGIN LICENSE FILE-----\n  eyJlbmMiOiJleUprWVhSaElqcDdJbWxrSWpvaU1EYzFZV05sT1RFdFlUaGtP\n  UzAwTVdObUxXRmtNMk10TTJJd01EWXpOakF5WTJRMUlpd2lkSGx3WlNJNklt\n...\nYithdmN6WmVTMitrZGxrKzNwZ0RGTXhueHVpWkNYQUI3RlRrYnB5MkRRPT0i\nLCJhbGciOiJiYXNlNjQrZWQyNTUxOSJ9\n-----END LICENSE FILE-----\n"

Supplied License Certificate File

Properties

EntitlementLimitName

"string"

Properties

LicenseMetadataList

{
  "haloProcessingFileLimit": "12k",
  "haloSomeFutureLimitThatDoesNotExistYet": "Unlimited"
}

Properties

None