Skip to main content
POST
Trigger a test group run

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format

Path Parameters

groupId
string<uuid>
required

Test group ID

Body

application/json
platform
enum<string>

Run platform for the batch. Mobile tests default to ios when omitted, so Android runs must set platform: android - including when the mobile app is selected by appId or bundleId.

Available options:
web,
ios,
android
deviceModel
enum<string>

Mobile device variant within the run platform (iOS: iphone | ipad). Omit for the platform default phone-sized device; explicitly requesting the default (e.g. iphone) is equivalent to omitting it.

Available options:
iphone,
ipad
projectEnvironmentId
string<uuid>
targetUrl
string<uri>
environment
enum<string>
Available options:
production,
staging,
preview,
custom
mobile
object
commitSha
string
Minimum string length: 1
prNumber
integer
Required range: x > 0

Response

Group run queued successfully

status
enum<string>
required
Available options:
queued,
cancelled
groupId
string<uuid>
required
batchId
string<uuid>
required
runIds
string<uuid>[]
required
queuedRunIds
string<uuid>[]
required
cancelledRunIds
string<uuid>[]
required
count
integer
required
metadata
object