Client SDKTest SuitesTest Suite Runs

Create Test Suite Run

Beta
Trigger a Test Suite and create a new Test Suite Run

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
exec_configobjectRequired
Configuration that defines how the Test Suite should be run
test_suite_idstringOptionalformat: "uuid"

The ID of the Test Suite to run. Must provide either this or test_suite_id.

test_suite_namestringOptional>=1 character

The name of the Test Suite to run. Must provide either this or test_suite_id.

Response

idstringformat: "uuid"
createdstringformat: "date-time"
test_suiteobject
stateenum
The current state of this run * `QUEUED` - Queued * `RUNNING` - Running * `COMPLETE` - Complete * `FAILED` - Failed * `CANCELLED` - Cancelled
Allowed values:
exec_configobject or null
Configuration that defines how the Test Suite should be run
progressobject or null