API

Get system information

get
Responses
200Success
No content
get
/info
GET /info HTTP/1.1
Host: 
Accept: */*
200Success
No content

Get demo accounts

get
Responses
200Success
No content
get
/demo-accounts
GET /demo-accounts HTTP/1.1
Host: 
Accept: */*
200Success
No content

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

Scenarios

List scenarios

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Success

application/json
get
/scenarios
GET /scenarios HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

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

Store a scenario

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
objectOptional
Responses
post
/scenarios
POST /scenarios HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
No content

Get a scenario by ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

Scenario ID

Header parameters
Acceptstring · enumOptionalPossible values:
Responses
200

Success

No content
get
/scenarios/{id}
GET /scenarios/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content

Disable a scenario

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

Scenario ID

Responses
delete
/scenarios/{id}
DELETE /scenarios/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Processes

List processes

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pagenumberRequired

List page (max 100 processes per page)

allbooleanRequired

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

Responses
200

Success

No content
get
/processes
GET /processes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content

Start a process

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
As-ActorstringRequired
Body
scenariostringRequired
actionobjectOptional
Responses
post
/processes
POST /processes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
As-Actor: text
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "scenario": "text",
  "actors": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "title": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "action": {}
}
201

Created

No content

Get a process by ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

Process ID

Responses
200

Success

No content
get
/processes/{id}
GET /processes/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content

Step through a process

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

Process ID

actionstringRequired

Process action

Header parameters
As-ActorstringOptional

Specify actor when multiple actors could have performed the action and actor cannot be determined based on the user

Body
stringOptional
Responses
post
/processes/{id}/{action}
POST /processes/{id}/{action} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
204

No Content

No content

API keys

List API keys

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Success

application/json
get
/apikey
GET /apikey HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

[
  {
    "id": "text",
    "token": "text",
    "name": "text",
    "description": {},
    "issued": "2025-11-16T11:51:58.626Z",
    "expirationDays": 1,
    "expiration": "2025-11-16T11:51:58.626Z",
    "lastUsed": "2025-11-16T11:51:58.626Z",
    "revoked": "2025-11-16T11:51:58.626Z",
    "privileges": "scenario:read",
    "processes": [
      {
        "scenario": "123e4567-e89b-12d3-a456-426614174000",
        "actors": [
          "text"
        ],
        "actions": [
          "text"
        ]
      }
    ]
  }
]

Issue a new API key

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
descriptionstringRequired
Responses
post
/apikey
POST /apikey HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "name": "text",
  "description": "text",
  "privileges": [
    "scenario:read"
  ],
  "processes": [
    {
      "scenario": "123e4567-e89b-12d3-a456-426614174000",
      "actors": [
        "text"
      ],
      "actions": [
        "text"
      ]
    }
  ]
}
201

Created

{
  "id": "text",
  "token": "text",
  "name": "text",
  "description": {},
  "issued": "2025-11-16T11:51:58.626Z",
  "expirationDays": 1,
  "expiration": "2025-11-16T11:51:58.626Z",
  "lastUsed": "2025-11-16T11:51:58.626Z",
  "revoked": "2025-11-16T11:51:58.626Z",
  "privileges": "scenario:read",
  "processes": [
    {
      "scenario": "123e4567-e89b-12d3-a456-426614174000",
      "actors": [
        "text"
      ],
      "actions": [
        "text"
      ]
    }
  ]
}

Revoke an API key

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
delete
/apikey/{id}
DELETE /apikey/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousAuthenticationNextServices

Last updated

Was this helpful?