View Requests of Licenses in REST API (License Events) (version 1.0)

Use LICENSE_EVENTS to view a device's most recent request to Aternity for a monitoring license, and if rejected, it displays the reason. Aternity automatically allocates license units whenever a device requests to report its performance. By default, Aternity reserves your manually allocated licenses, then automatically grants requests from any device type until it reaches the total licenses allowed. You can also limit the number of licenses for each type of device. For example, if you purchase 1000 license units, you can set a limit of up to 300 B2E mobile devices.

For example, you can check whether a specific device does not appear in the dashboards due to insufficient licenses, and then purchase more licenses if required.

Manually allocate a license, or allow Aternity to automatically allocate from the available licenses

Each entry from LICENSE_EVENTS returns a the last request from this device for a license, the type of license, and whether Aternity accepted or rejected the request with the reason.

Note

You can access data using this API (retention) going back up to 2 days. If you do not add a relative_time filter, by default it returns data for the past day.

You can view this data and set limits for license units inside Aternity, and there you can also view these licensing events which list those granted or rejected (learn more).

License Provisioning page in Aternity

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Examples

To access this API from a browser, Excel or Power BI (learn more), enter <base_url>/LICENSE_EVENTS

If a device does not appear in Aternity's dashboards, you can check if Aternity granted a license to that device:

<base_url>/LICENSE_EVENTS?$select=license_event,license_owner,license_event_reason&$filter=license_owner eq 'hostname'

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Output

Each entry from LICENSE_EVENTS returns a the last request from this device for a license, the type of license, and whether Aternity accepted or rejected the request with the reason.

You can access data using this API (retention) going back up to 7 days. If you do not add a relative_time filter, by default it returns data for the past 7 days.

Types Columns returned

Measurements

N/A

Attributes

Account_ID,Account_Name,License_Event,License_Event_Reason,License_Last_Event_Timestamp,License_Owner,License_Type,Virtual_Server_Name