The Currently Borrowed Licenses endpoint delivers license usage metrics specific to the Currently Borrowed Licenses report, allowing you to monitor borrowed licenses for all servers or for a selected server.
Obtaining information about borrowed licenses
You can easily list currently borrowed licenses by sending the following HTTP request.
GET /api/v1/report/license-server/${licenseServerId}/borrowed-licenses/${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 |
|---|---|---|---|
| ${licenseServerId} | Yes | integer/string | Internal License Statistics identification of the license server for which you want to gather data about currently borrowed licenses. You can set this parameter to 'all' to gather data from all license servers. |
| ${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, the report will contain one row for each borrow on specified server or servers. Each row consists of the following columns:
Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| lsid | License Server ID | integer | Internal License Statistics identification of the server hosting the borrowed feature. |  No |
| lsn | License Server | string | Name of the server hosting the borrowed feature. |  Yes |
| fid | Feature ID | integer | Internal License Statistics identification of the borrowed feature. | No |
| fns | Feature Name | string | Name of the borrowed feature. | Yes |
| fv | Feature Version | string | Version of the borrowed feature. | Yes |
| ftype | Feature Type | enumeration | Type of the borrowed feature. See feature type descriptions for further details. | Yes |
lus | Licenses used | integer | Total number of licenses borrowed by user on host. | Yes |
lco | Checked Time | date and time | Time when licenses were checked out. | Yes |
lbe | Borrow Expiration | date and time | Time when the borrow expires. | Yes |
| uid | User ID | integer | Internal License Statistics identification of user that borrowed licenses. | No |
un | Username | string | Name of user that borrowed licenses. | Yes |
hn | Hostname | string | Name of host where licenses are borrowed to. | 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. |  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 about currently borrowed licenses on all servers, in CSV format.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/all/borrowed-licenses/csv