Skip to main content
POST
Trigger a test run

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

testId
string<uuid>
required

Test ID

Body

application/json
mode
enum<string>

Deprecated and ignored. Deep mode was removed; every run uses the same mode.

Available options:
fast,
deep
platform
enum<string>

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

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
appId
string<uuid>
projectEnvironmentId
string<uuid>

Response

Test run queued successfully

status
enum<string>
required
Available options:
queued
runId
string<uuid>
required
testId
string<uuid>
required