Sign in
groups

Trigger a test group run

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.

post/v1/groups/{groupId}/runs

Path parameters

groupIdstring uuid required

Test group ID

Headers

Authorizationstring required

API key authentication using Bearer token format

Request body

platform'web' | 'ios' | 'android'

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.

deviceModel'iphone' | 'ipad'

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.

projectEnvironmentIdstring uuid
targetUrlstring uri
environment'production' | 'staging' | 'preview' | 'custom'
commitShastring
prNumberinteger

Response

Group run queued successfully

status'queued' | 'cancelled' required
groupIdstring uuid required
batchIdstring uuid required
runIdsstring[] required
queuedRunIdsstring[] required
cancelledRunIdsstring[] required
countinteger required

Changes

Changed in 1 of the 19 revisions of this API.41

  • bf198f94879a41See the full diff
    • ▲

      the commitSha request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the mobile/artifactFilename request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the mobile/buildId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the mobile/bundleId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ●

      the prNumber request property's exclusiveMinimum was set to 0.00

      request-property-exclusive-min-set