License Vault API

Last modified: 16 April 2024

The License Vault API offers a set of methods for accessing license usage data programmatically and automating license management. Here's what you can do via the API:

For more information about the API methods, consult the API specification. You can access it from your License Vault by following the steps below.

  1. Log in to Toolbox Enterprise with administrator credentials.

  2. In the top menu, select Licenses.

  3. In the menu on the left, select Settings. Then scroll down to the License Vault API section and click the API specification link.

    The link to the License Vault API specification

  4. The link will take you to the Swagger-format specification.

Authorized access to the API

For authorized access to the API methods, you'll need to generate an access token that serves as a key to the License Vault data.

Once the token is generated, pass it to the Authorization parameter of your API requests. For example:

GET https://mycompany.fls.jetbrains.com
Authorization: Bearer <your-access-token-goes-here>
Accept: application/json

To generate an access token

  1. Log in to Toolbox Enterprise with administrator credentials.

  2. In the top menu, select Licenses.

  3. In the menu on the left, select Settings. Then scroll down to the API access token section.

    The interface that lets you generate an API access token in License Vault.

  4. Click Generate token. If you don't see this button, colsult the relevant section below.

  5. You will see a dialog with the access token displayed. Click Copy to copy your token to the clipboard, and be sure to save it in a secure location before closing the dialog.

    The dialog that shows you the generated API token.

    tip

    We'll show you the token only once. If you lose your token, you’ll need to generate a new one. Generating a new token invalidates the current one.

What if I don't see the Generate token button?

If you see the Generate new token and Delete token buttons instead, you or another administrator has already generated an API access token for your License Vault.

We show the token only once to the administrator who generates it. If you don't have your token, contact other License Vault administrators in your company to obtain it or consider generating a new one.

Token security and lifetime

Each License Vault can have only one unique access token. All Toolbox Enterprise administrators can generate and delete it. Once the token is generated, it remains valid until one of the administrators deletes it or generates a new one.

Store your token in a secure location and don't share it with anyone unless you want them to have full access via the API to the license usage data stored in your License Vault.

warning

If you suspect that your token has been compromised, delete it or generate a new one immediately.

  1. Go to the API access token settings by following steps 1 and 2 from the instructions above.

  2. Click Generate new token.

    The interface that lets you generate a new access token.

  3. Click Generate new token in the dialog that pops up.

    tip

    Generating a new token invalidates the current one. Any scripts or applications that use the current token lose access to the API. To restore their access, you’ll need to update the token in all such scripts and applications.

  4. Copy and save the new token as described in step 4 of the instructions above.