You can view tool license usage details by calling the License Usage API. The API reads the ls_access.log.yyyy-MM-dd file stored in the DTP logs folder and returns information for the specified period. By default, logs are stored for the last 90 days. See Configuring License Server for information about changing how long logs are stored.
Accessing the API Page
You can call the API from the SwaggerUI shipped with License Server, which provides a point-and-click interface for viewing license usage information. The SwaggerUI is available after logging in. No additional authentication is required.
- Open the License Server home page.
- Go to the help menu and select Usage API Documentation to access the API.
You can right-click on an endpoint to copy the URL and use it in a script. You can also query the endpoint in your browser to quickly view the data. For example:
Paste the URL into a browser bar and add any additional queries.
http://<HOST>/licenseserver/usage/api/v1.0/toolsUsage?startDate=<yyyy-MM-dd>&endDate=<yyyy-MM-dd>
- Press RETURN to query the endpoint.
Authentication
You can use basic authentication or OIDC to authenticate. See Configuring OpenID Connect for more information about using OIDC.
Endpoints
The following endpoints are available:
/toolsUsage
This endpoint returns summary information about tool usage.
URL
<PROTOCOL>://<HOST>:<PORT>/licenseserver/usage/api/v1.0/toolsUsage
Example Request
The following example returns tool usage information for the month of March.
https://myserver:8443/licenseserver/usage/api/v1.0/toolsUsage?startDate=2025-03-01&endDate=2025-04-01
/usage
This endpoint is similar to the /toolsUsage endpoint but allows grouping multiple fields and returning a subset of usage fields.
URL
<PROTOCOL>://<HOST>:<PORT>/licenseserver/usage/api/v1.0/usage
Example Request
https://myserver:8443/licenseserver/usage/api/v1.0/usage?startDate=2025-03-01&endDate=2025-04-01&groupFields=tool,toolVersion
/featuresUsage
This endpoint returns details about feature usage.
URL
<PROTOCOL>://<HOST>:<PORT>/licenseserver/usage/api/v1.0/featuresUsage
Example Request
The following example returns feature usage information for the month of March.
https://myserver:8443/licenseserver/usage/api/v1.0/featuresUsage?startDate=2025-03-01&endDate=2025-04-01
/licenseUsage
This endpoint returns an array showing license usage, including features used, tools, and usage duration, per user.
URL
<PROTOCOL>://<HOST>:<PORT>/licenseserver/usage/api/v1.0/licenseUsage
Example Request
The following example returns license usage information for the month of March.
https://myserver:8443/licenseserver/usage/api/v1.0/licenseUsage?startDate=2025-03-01&endDate=2025-04-01
/licenseRejection
This endpoint returns an array of objects showing license requests that we were rejected by the server.
URL
<PROTOCOL>://<HOST>:<PORT>/licenseserver/usage/api/v1.0/licenseRejection
Example Request
https://myserver:8443/licenseserver/usage/api/v1.0/licenseRejection
