Public APIs

Usage of the FrontLine public API

The FrontLine API server also exposes a public API that you can use to trigger runs or fetch run results and metrics.

We also use this API for our Continuous Integration plugins and our Grafana datasource.

This API is protected with API tokens generated by FrontLine administrators through the API Tokens page.

You can access the Swagger documentation using the link FrontLine API documentation on the Documentation modal accessible on the sidenav (bottom left of the screen).

How to retrieve simulations, runs and artifacts IDs:

  • Simulations ID are available on the Simulations Table, at the left of the simulation name. To copy the id, click on the icon.
  • Runs ID are available on the Runs Table: Simulations > Runs history. To copy the id, click on the icon at the right of the run number.
  • Teams ID are available on the Teams Table. To copy the id, click on the icon.
  • Artifacts ID are available on the Artifacts Table. To copy the id, click on the icon.

Some information before using the public API:

  • You have to provide the run ID as a query parameter to fetch other run metadata (injectors, remotes, hostnames, scenarios, groups, requests)
  • The from and to query parameters from the /series endpoint are the lower and upper timestamp bounds of the time window you want to query. You can fetch the total run time window from the /runs endpoint (injectStart, injectEnd).

Edit this page on GitHub