API Tokens

API Tokens allow you to authenticate your requests to the public API.

Managing API Tokens

To access the API Tokens administration, click on the icon in the navigation bar.


To create an API token, click on the Create button. Once the API token is created, copy the token, as you won’t be able to retrieve it again.

Create token

There are three permissions available for an API Token:

  • The Start permission, allowing to start simulations
  • The Read permission, allowing to read all the data from runs (typically useful in Grafana)
  • The Artifacts permission, allowing to upload artifacts
  • The All permission, combining all three of the previous permissions

You can edit the API Token permissions by clicking on the icon on the right part of the table. A permission can be set globally or to a specific team. To regenerate a token, click on the icon.

Edit this page on GitHub