The License Server Current Usage endpoint delivers license usage metrics specific to the License Server Current Usage, allowing you to monitor all the features for the currently selected license server.
Obtaining information about usage for a single license server or usage for a license server group
You can easily fetch metrics about current usage by sending one of the following HTTP requests.
GET /api/v1/report/license-server/${lsid}/current-usage/${returnType}
GET /api/v1/report/license-server-group/${lsgid}/current-usage/${returnType}
where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${lsid} | Yes | integer | Internal License Statistics identification of license server to show usage on. |
| ${lsgid} | Yes | integer | Internal License Statistics identification of license server group to show usage on. |
| ${returnType} | Yes | string | Standard format option. See Making an API request for details. |
| standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each feature hosted on the license server, or one of the license server groups, that currently has checked out licenses. Each row consists of the following columns.
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| fid | Feature Id | integer | Internal License Statistics identification of the feature. |  No |
| fns | Feature Name | string | Feature name. |  Yes |
| fv | Feature Version | string | Feature version. | Yes |
| ftype | Feature Type | enumeration | See feature type descriptions for details. | Yes |
| fu | Used | integer | Number of used licenses. | Yes |
| fbrwd | Borrowed | integer | Number of borrowed licenses. | Yes |
| frvd | Reserved | integer/string | Number of reserved licenses, or "N/A" if License Reservations are not supported by the license server. | Yes |
| ft | Total | integer/string | Total licenses for a feature or "Unlimited" if an unlimited license. | Yes |
| futil | Utilization | integer | Percentage of feature utilization. | Yes |
| fexp | Feature Expires | date | Feature expiration date. | Yes |
flu | Last Update | date and time | Time of last update. For realtime, the time the feature was last seen on the license server. | Yes |
fiexp | Expired | boolean | Indicates whether the feature has expired. | No |
Note that the order in the table is the default order of the columns in the exported file.
Note: Data returned for a license server group consists of a summary of all features of all license servers in the group, including hidden ones. (See License server groups for more information.)
Example 1
The following example shows a command that downloads data about current usage for license server "7" in XLSX format.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/7/current-usage/xlsx"
Example 2
The following example shows a command that obtains information about features with current usage higher than 90% for license server "13."
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/13/current-usage/json" --data-urlencode 'filters=[{"type":"numeric","comparison":"gt","field":"futil","value":"90"}]'
Example 3
The following example shows a command that downloads data about current usage for license server group "1" in CSV format.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server-group/1/current-usage/csv"