Groups

Trigger a test group run

View as Markdown

Trigger all runnable tests in a group using API-key authentication. Returns the batch ID plus queuedRunIds (runs accepted onto the worker) and cancelledRunIds (runs the server immediately cancelled, e.g. duplicates or quota cancellations). status is queued when at least one run is queued and cancelled when every run was rejected.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

groupIdstringRequiredformat: "uuid"
Test group ID

Request

This endpoint expects an object.
platformenumOptional
Allowed values:
projectEnvironmentIdstringOptionalformat: "uuid"
targetUrlstringOptionalformat: "uri"
environmentenumOptional
Allowed values:
mobileobjectOptional
commitShastringOptional>=1 character
prNumberintegerOptional

Response

Group run queued successfully
statusenum
groupIdstringformat: "uuid"
batchIdstringformat: "uuid"
runIdslist of strings
queuedRunIdslist of strings
cancelledRunIdslist of strings
countinteger
metadataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error