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

The Current Usage endpoint delivers current license usage metrics, as detailed below.

Obtaining information about usage on multiple hosts (Current Usage On Multiple Hosts report)

You can easily list users that are using licenses on multiple hosts by sending the following HTTP request.

 GET /api/v1/report/current-usage/on-multiple-hosts/${returnType}?(parameters, as needed)

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

ParameterRequiredTypeDescription
${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-user pair, where user has checked out licenses of feature on multiple hosts. Each row consists of the following columns.


ColumnFull nameTypeDescriptionVisible by default in export
fidFeature Idinteger

Internal License Statistics identification of the feature.

Minus (-) No
fnsFeature NamestringName of feature. Yes
fvFeature VersionstringFeature version. Yes
ftypeFeature TypeenumerationSee feature type descriptions for details. Yes
vnVendorstringName of license server vendor hosting the feature. Yes
lsidLicense Server Idinteger

Internal identification of license server hosting the feature.

Minus (-) No
lsnLicense ServerstringName of license server hosting the feature. Yes
uidUser IdintegerInternal License Statistics identification of the user.Minus (-) No
unUserstringUser name. Yes
hlHostsstringList of hosts on which the user has checked out licenses of the feature, separated by a semicolon (;). Yes
uilUser is from LDAPbooleanIndicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.Error (x) Unavailable

Note that the order in the table is the default order of the columns in the exported file.

Example

The following example shows a command that obtains information about users using features on multiple hosts.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/on-multiple-hosts/json"

Obtaining information about usage above/below n hours (report Current Usage By Time Range

You can easily list data about features currently in use for more/less than n hours by sending the following HTTP request

GET /api/v1/report/current-usage/by-time-range/${returnType}?ab=${integer}&bl=${integer}&(additional parameters, as needed)

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
${returnType}YesstringStandard format option. See Making an API request for details.
abNointegerMinimum number of hours a license has to be used to be listed. If not provided constraint not imposed.
blNointeger

Maximum number of hours a license has to be used to be listed. If not provided, this constraint is not imposed.

Value must be greater than value of 'ab' parameter.

standard report options Novarious

See Making an API request for details.

Response

On success, this report will contain one row for each license session, with length within specified range. Each row consists of the following columns.

Column
Full name
Type
Description
Visible by default in export
fidFeature IDintegerInternal License Statistics identification of the used feature.Minus (-) No
fnsFeature NamestringName of the used feature. Yes
fvFeature VersionstringVersion of the used feature. Yes
ftypeFeature TypeenumerationType of the used feature. See feature type descriptions for further details. Yes

vn

VendorstringName license server vendor hosting the used feature. Yes
lsidLicense Server IdintegerInternal License Statistics identification of license server hosting the used feature.
Minus (-) No
lsnLicense ServerstringName of license server hosting the used feature.
Yes
uidUser IdintegerInternal License Statistics identification of user that checked out licenses.Minus (-) No

un

User

string

Name of user that checked out licenses.

Yes

hn

Host

string

Host on which licenses were checked out.

Yes

lus

Used

integer

Total number of licenses used by user on host.

Yes

tu

Time Used

string

Indicates how long licenses have been in use; e.g., 1d 2h 10 min. Note that you cannot filter on this field.

Yes

uil

User is from LDAP

boolean

Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.

Error (x) Unavailable

Note that the order in the table is the default order of the columns in the exported file.


Example

The following example shows a command that downloads data in CSV format about features currently in use for at least 24 hours.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/by-time-range/csv?ab=24"