API

Get system information

GET/info

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get demo accounts

GET/demo-accounts

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/demo-accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Demo accounts are only available when the engine is running in development mode.

Scenarios

List scenarios

GET/scenarios

Authorization

bearer

Response

200

Success

Body

application/json

id*string

namestring

title*string

description*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/scenarios', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "title": "text",
    "description": "text"
  }
]

Store a scenario

POST/scenarios

Authorization

bearer

Body

application/jsonapplication/yaml

object

Response

201400403

Created

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/scenarios', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Get a scenario by ID

GET/scenarios/{id}

Authorization

bearer

Path parameters

id*string (uuid)

Scenario ID

Header parameters

Response

200

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/scenarios/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Disable a scenario

DELETE/scenarios/{id}

Authorization

bearer

Path parameters

id*string (uuid)

Scenario ID

Response

204403

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/scenarios/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Processes

List processes

GET/processes

Authorization

bearer

Path parameters

page*number

List page (max 100 processes per page)

all*boolean

Also return processes where user is not an actor in (admin only)

Response

200

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/processes', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Start a process

POST/processes

Authorization

bearer

Header parameters

Body

application/json

scenario*string

actorsobject

actionobject

Response

201

Created

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/processes', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "As-Actor": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scenario": "text"
    }),
});
const data = await response.json();

Get a process by ID

GET/processes/{id}

Authorization

bearer

Path parameters

id*string (uuid)

Process ID

Response

200

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/processes/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Step through a process

POST/processes/{id}/{action}

Authorization

bearer

Path parameters

id*string (uuid)

Process ID

action*string

Process action

Header parameters

Body

application/json

string

Response

204

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/processes/{id}/{action}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify("text"),
});
const data = await response.json();

API keys

List API keys

GET/apikey

Authorization

bearer

Response

200

Success

Body

application/json

id*string

token*string

name*string

descriptionobject

issued*string (date-time)

expirationDays*number

expiration*string (date-time)

lastUsed*string (date-time)

revoked*string (date-time)

privileges*enum

scenario:readscenario:writeapikey:issueapikey:revokeprocess:readprocess:startprocess:step

processes*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/apikey', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "token": "text",
    "name": "text",
    "issued": "2025-01-22T05:43:46.771Z",
    "expirationDays": 0,
    "expiration": "2025-01-22T05:43:46.771Z",
    "lastUsed": "2025-01-22T05:43:46.771Z",
    "revoked": "2025-01-22T05:43:46.771Z",
    "privileges": "scenario:read",
    "processes": [
      {
        "scenario": "123e4567-e89b-12d3-a456-426614174000",
        "actors": [
          "text"
        ],
        "actions": [
          "text"
        ]
      }
    ]
  }
]

Issue a new API key

POST/apikey

Authorization

bearer

Body

application/json

name*string

description*string

privileges*array of enum

processes*array of object

Response

201

Created

Body

application/json

id*string

token*string

name*string

descriptionobject

issued*string (date-time)

expirationDays*number

expiration*string (date-time)

lastUsed*string (date-time)

revoked*string (date-time)

privileges*enum

scenario:readscenario:writeapikey:issueapikey:revokeprocess:readprocess:startprocess:step

processes*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/apikey', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text",
      "privileges": [
        "scenario:read"
      ],
      "processes": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "token": "text",
  "name": "text",
  "issued": "2025-01-22T05:43:46.771Z",
  "expirationDays": 0,
  "expiration": "2025-01-22T05:43:46.771Z",
  "lastUsed": "2025-01-22T05:43:46.771Z",
  "revoked": "2025-01-22T05:43:46.771Z",
  "privileges": "scenario:read",
  "processes": [
    {
      "scenario": "123e4567-e89b-12d3-a456-426614174000",
      "actors": [
        "text"
      ],
      "actions": [
        "text"
      ]
    }
  ]
}

Revoke an API key

DELETE/apikey/{id}

Authorization

bearer

Path parameters

id*string

Response

204

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/apikey/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();