API Setup Guide

The License Management subdomain makes it easy to manage licenses, allowing you to upload new license files, retrieve information about the current active license, and delete the existing license.

To obtain a valid license, please contact us.

License Management API Setup

1. Upload an active license

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

To submit the license file, send a POST request to the /api/v1/license endpoint. Include a JSON Request body that contains the license file in the .lic format.

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

Assuming the license is valid and within its expiration date, the API will respond with a JSON body that contains the license details, providing a summary of the license file structure. You can find more information about the license details here.

Note: please be aware that only a single active license is allowed at any given time.

An unsuccessful response from the License API typically indicates an invalid or expired license. The response body will include an error message specifying the reason for the license's failure to pass validation checks. If you encounter this situation, please reach out to us, and our team will assist you in obtaining a valid license file to retry the process successfully.

2. Verify the correct license is installed

Upon uploading your active license, the response will contain the license details. To retrieve these license details again, send a GET request to /api/v1/license using the same entry point mentioned in Step 1. You can find more information about the license details here.

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.

Please also refer to our API Documentation for more information.

Updating the Active License

To update a license, simply follow the same steps as mentioned earlier for installing a new license. Uploading a new license will automatically replace the previous one, ensuring that the new license takes effect.

Please allow 60 seconds for the new license to take affect.

Removing the Active License

To remove the currently active license, send a DELETE request to /api/v1/license using the same entry point from the previous steps. This action will remove the license and cannot be undone.