Retrieving License Usage Data

The License Management subdomain facilitates the retrieval of usage data for the current day, encompassing details on license entitlement limits and a tally of requests made within a 24-hour period against those limits.

License Management API

Retrieving your usage data

The API can be reached through Glasswall Halo's entry point. This entry point shares the same IP address/URL as the Halo Portal.

To obtain usage data for the past 24 hours against the presently installed license and to view details of the current active license, initiate a GET request to the /api/v2/license endpoint.

This will include the details of your current license. To ensure the correctness of the license, please verify the license details. Specifically, confirm that the daysLeft, startDate, and entitlements align with your expectations for the purchased license. If you suspect that the license provided is invalid or contains inaccuracies, please contact us.

You should now be able to review your usage data over the current 24 hour period. This resets at midnight (system time) every day.

Example Response body:

{
  "licenseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "licenseName": "halo:glasswall:1",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "policyName": "halo:bronze_level:contract",
  "licenseHolder": "glasswall",
  "daysLeft": 100,
  "startDate": "2023-12-19",
  "expirationDate": "2023-12-19",
  "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
    },
    "haloProcessingDataLimit": {
      "limit": "unlimited",
      "tally": 4567
    }
  },
  "anomalies": []
}

Note: please be aware that when your tallies reach the designated limits, your CDR requests may result in an Unauthorized response for the current 24-hour period.

For more information please refer to our API Documentation.