Skip to main content
POST
Launch tests

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Body

Tests to launch. Omit testIds (or leave it empty) to launch every test of the agent.

agentId
string
required

Agent owning the tests

Minimum string length: 1
name
string | null

Free text naming the launch; defaults to "{n} tests"

testIds
string[] | null

Tests of the agent to launch; absent or empty launches every test of the agent

repetitions
integer<int32> | null

Runs created per test, between 1 and 5; null means 1

Response

Success

One launch: the group of runs created together for a list of tests, each repeated repetitions times. Status, counters, tests, startedAt and finishedAt are derived from the runs.

id
string | null
agentId
string | null
name
string | null

Free text given at launch ("all tests", "folder X", ...); defaults to "{n} tests"

repetitions
integer<int32>

Runs created per test (1-5)

testIds
string[] | null

Distinct tests launched, in launch order

status
enum<string>
Available options:
Queued,
Running,
Completed,
Cancelled
createdAt
string<date-time>
startedAt
string<date-time> | null

First run dispatched

finishedAt
string<date-time> | null

Last run finished, set once every run is terminal

cancelledAt
string<date-time> | null

Set when the execution was cancelled

counters
object

Runs per status; total is the sum of the others

tests
object[] | null

Per test, in testIds order: runs per status and pass rate over the repetitions