Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organisationId
string
required

Your MobileBoost organisation ID. It must be the organisation your API key belongs to.

buildId
string

The build to test: the buildId that POST /uploadBuild returned. Send one of buildId, build or bundleId.

build
Build · object

Test the newest build uploaded under a name instead of naming a buildId: {"meta": {"name": "my-app"}}. When you send both, build is used.

bundleId
string

Test the app with this bundle identifier that is already installed on your reserved device, instead of an uploaded build. Requires platform, always runs on a physical device, and has to be enabled for your organisation (403 otherwise). Cannot be combined with buildId.

platform
enum<string>

The platform to run on. Taken from the build when you send buildId. Required with bundleId. With build, it picks the newest build of that name for this platform.

Available options:
ios,
android
testIds
string[]

IDs of the tests to run, as GET /tests returns them. Send testIds, tags, or both.

tags
string[]

Run every test that has at least one of these tags. Combined with testIds, the run contains both sets.

usePhysicalDevice
boolean

true runs on a real handset reserved for your organisation, false on an emulator or simulator. Omit it to use your organisation's default: a real handset when you have one reserved for this platform, otherwise an emulator or simulator. An iOS .ipa build and a bundleId run always use a real handset.

tunnelName
string

Name of a connected MobileBoost Local tunnel: the --tunnel-name you started mb-local with. The app on the device then reaches your internal hosts, such as a staging API, through it. Omit it when your app's backend is publicly reachable. An unknown or disconnected tunnel fails the run.

trigger
string

A free-form label stored on the run to say what started it, for example ci or nightly. Defaults to api.

Response

The run was created. Its tests are queued on devices in the background.

message
string
required

A human-readable message describing the result of the request.

runId
string
required

The ID of the run. Pass it to GET /runs/{runId} to follow the run and read its results.

status
string
required

Always running: the run was accepted. Read its progress from GET /runs/{runId}.