API Tokens

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

API Tokens administration is accessible in the navigation bar.

Managing API Tokens


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

Create token

There are four permissions available for API Tokens:

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

You can set a permission globally or within a specific team only.

You can edit the API Token permissions by clicking on the icon on the right part of the table. To regenerate a token, click on the icon.

Edit this page on GitHub