The information on this page refers to License Statistics v6.7 and newer, which introduced an Agent token scope to support the introduction of License Statistics Agent. If you are using a version previous to v6.7, see documentation for previous versions.

License Statistics users can integrate reports generated by License Statistics with their custom external applications by using the License Statistics API. The API can be used with a variety of different applications, across a number of programming languages and tools. The License Statistics API is the best choice for system integrators and advanced users who want flexible, on-demand access to License Statistics data.

Making an API request

In order to make API requests, you must use a token, which you can generate as described below. API tokens cannot be shared between users. You can create as many API tokens as you need.

  1. Go to API under your logged in username, shown in the upper right corner of the application window.
  2. Click Add to create a new API token.
  3. From the dialog that opens, choose the scope type for the token.

    API scopeAccess to all endpoints (dependent on role). 
    Agent scopeAvailable for License Statistics administrators only. Used to authorize data access by License Statistics Agent.

  4. Optionally, add a description to identify the token.
  5. Click Save to create the token.

    The token is automatically generated and added to the API tokens grid.

  6. You can add/edit an existing token's description by clicking the edit icon in the Action column. (Note that Agent scope tokens can be edited only by License Statistics administrators.)
  7. You can delete a token using the delete icon in the Action column.

Note that:

  • API tokens do not expire.
  • API tokens inherit the permissions of the user who created them.
  • API tokens cannot be shared with other users; they may be used only by the user who created them.