API

The steadybit Web API allows interfacing with the platform to create, start, stop experiments, etc.

Tokens

In order to use the API you need to create an API access token via the user interface. API access tokens are managed by the admin and team owners and is bound to a single team.

API token management can be found in Access Control → API Access Tokens.

OpenApi Specification

We provide a OpenApi 3.0 Specification for the API as well as an interactive documentation. In case you are using our on-prem variant you can access it at http://<your-installation-url>/api/spec.

Example: Create Experiment

This is how you can create an experiment (json is supported as well):

curl \
  -i \
  -H 'Content-Type: application/x-yaml' \
  -H 'Authorization: accessToken XXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
  https://platform.steadybit.io/api/experiments \
  --data '
---
name: "Experiment API Test"
type: "infrastructure"
team: "TEST"
environment:
  - "Global"
attack:
  type: "host-cpu-attack"
  parameters:
    duration: "30s"
    cpuLoad: 80
  radius:
    targetType: "host"
    list:
      - "host-1.test"
    maximum: 1
'

The Location header of the response indicates the url of the newly created experiment:

location: https://platform.steadybit.io/api/experiments/TEST-1

Example: Run Experiment

You can then run the experiment:

curl \
  -i \
  -X POST \
  -H 'Authorization: accessToken XXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
  https://platform.steadybit.io/api/experiments/TEST-1/execute