Page tree
Skip to end of metadata
Go to start of metadata

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.

Current usage for a single license server
GET /api/v1/report/license-server/${lsid}/current-usage/${returnType}


Current usage for a license server group
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.

ParameterRequiredTypeDescription
${lsid}YesintegerInternal License Statistics identification of license server to show usage on.
${lsgid}YesintegerInternal License Statistics identification of license server group to show usage on.
${returnType}YesstringStandard format option. See Making an API request for details.
standard report options Novarious

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.

ColumnFull nameTypeDescriptionVisible by default in export
fidFeature IdintegerInternal License Statistics identification of the feature.
Minus (-) No
fnsFeature NamestringFeature name. Yes
fvFeature VersionstringFeature version. Yes
ftypeFeature TypeenumerationSee feature type descriptions for details. Yes
fuUsedintegerNumber of used licenses. Yes
fbrwdBorrowedintegerNumber of borrowed licenses. Yes
frvdReservedinteger/stringNumber of reserved licenses, or "N/A"  if License Reservations are not supported by the license server. Yes
ftTotalinteger/stringTotal licenses for a feature or "Unlimited" if an unlimited license.
Yes
futilUtilizationintegerPercentage of feature utilization. Yes
fexpFeature ExpiresdateFeature expiration date. Yes

flu

Last Updatedate and timeTime of last update. For realtime, the time the feature was last seen on the license server.
Yes

fiexp

ExpiredbooleanIndicates whether the feature has expired.Minus (-) 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"