Skip to main content
Version: 2.20.0

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": "500G",
      "tally": 4567
    }
  },
  "anomalies": []
}

Understanding usage and enforcement​

What the limits measure​

A Halo entitlement can constrain usage along two dimensions, each reported under entitlementLimits:

FieldWhat it countsExample limit
haloProcessingFileLimitNumber of files processed in the current 24-hour period"12k"
haloProcessingDataLimitVolume of data processed in the current 24-hour period"500G"

For each limit, tally is the amount consumed so far in the current period and limit is the entitled maximum (for example, "12k" files or "500G" of data). Compare tally against limit to calculate how much headroom remains.

When the tally resets​

The tally covers a rolling 24-hour period and resets at midnight (system time) every day. Usage is therefore measured per day, against the per-day entitlement—it is not a single cumulative total for the life of the license.

What happens when you reach a limit​

When a tally reaches its entitled limit, further CDR requests may receive a 401 Unauthorized response for the remainder of the current 24-hour period. Processing resumes automatically after the daily reset (or once the license is updated to a higher entitlement).

The anomalies array is used to surface usage-related conditions (for example, approaching or exceeding a limit). Inspect it to detect issues before requests start being rejected.

Enforcement specifics depend on your license

Exact enforcement behavior—including any warning thresholds, grace/overage allowance, how a "user" is counted for user-based entitlements and differences between Enterprise and Public-Sector/Government licenses—is determined by your specific license policy (policyName) and contract, and can differ between Halo versions. Confirm the precise figures for your deployment with your Glasswall account contact or Glasswall Support rather than assuming the example values above.

For more information please refer to our API Documentation.

Last updated on