curl --request POST \
  --url https://api.mobileboost.io/tests/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organisationId": "org123",
  "buildId": "JbUOAOHLx99O2MYJc0LC",
  "testIds": [
    "xMIt964RUpAB95b6YI2F",
    "teXiuNg4TLL9ioHIct5H"
  ]
}
'

{
  "message": "Autotest run created",
  "runId": "b1111111df174791a93e560390ea7e65",
  "status": "running",
  "scheduledTests": 12,
  "skippedTests": [],
  "warnings": []
}

Tests

Execute tests

Start a run of your tests on MobileBoost devices. Each test runs the automation code MobileBoost wrote and verified for it (see POST /tests/generate).

The call returns as soon as the run is created. Take runId from the response and pass it to GET /runs/{runId} to follow the run until its status is completed or cancelled.

Choose the tests with testIds, tags, or both. A test is runnable on the run’s platform once its automation has been written and verified, which GET /tests shows as platforms.<platform>.runnable.

A test you name in testIds must be runnable. If it is not, the request is refused with 400.
A test that only matches tags and is not runnable yet is skipped, and the rest of the run starts. The response lists each skipped test in skippedTests with the reason, and warnings says how many were left out. If none of the tests matching tags is runnable, the request is refused with 400 and the message lists them.

Skipped tests are not part of the run: they are not counted in totalTests and never change the run’s status.

Name the app with one of:

buildId: the buildId that POST /uploadBuild returned.
build.meta.name: the newest build uploaded under that name. Add platform if you upload your iOS and Android apps under the same name.
bundleId and platform: an app that is already installed on your reserved device, with no build uploaded. This has to be enabled for your organisation.

Choose the device with usePhysicalDevice. MobileBoost picks the device itself, so deviceConfigs, deviceProviderSettings, launchParams, testInputs, tagsQuery, iterations, metaData, stealthMode, dependencyTestIds and the ephemeralTest* fields are not supported. A request that sends any of them is refused with 400 rather than run on a device you did not ask for.

Pass values to your tests with variables: NAME: value pairs, such as the backend a canary test signs in against. Each test in the run reads them as environment variables, and a value here wins over your organisation’s environment variable of the same name for this run only. variables replaces testInputs. It is not for passwords or keys: the values are kept with the run for 14 days, so keep credentials in your organisation’s environment variables (ENV Variables in the web app).

Authenticate with your API key: Authorization: Bearer mb_live_.... organisationId must be the organisation the key belongs to. A request that sends variables or tunnelName needs the key even if your organisation does not otherwise require one.

POST

tests

execute

curl --request POST \
  --url https://api.mobileboost.io/tests/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organisationId": "org123",
  "buildId": "JbUOAOHLx99O2MYJc0LC",
  "testIds": [
    "xMIt964RUpAB95b6YI2F",
    "teXiuNg4TLL9ioHIct5H"
  ]
}
'

{
  "message": "Autotest run created",
  "runId": "b1111111df174791a93e560390ea7e65",
  "status": "running",
  "scheduledTests": 12,
  "skippedTests": [],
  "warnings": []
}

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.

Show child attributes

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.

variables

Run variables · object

Values for this run's tests, as NAME: value pairs, for example the backend a canary test signs in against. Each test reads them as environment variables, and a value here wins over your organisation's environment variable of the same name for this run only. Names use upper case letters, digits and underscores and start with a letter; names the test runner relies on, such as PATH or anything starting with PYTHON, are refused. Values must be strings. Up to 20 per run. Requires your API key even if your organisation does not otherwise require one. Not for passwords or keys: values are kept with the run for 14 days, so keep credentials in your organisation's environment variables. Replaces testInputs.

Show child attributes

Example:

{
  "API_BASE_URL": "https://canary-api.example.com"
}

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}.

scheduledTests

integer

Number of tests the run started with.

skippedTests

SkippedTest · object[]

Tests that matched tags but are not runnable on this platform yet, so the run does not include them. Empty when every selected test was scheduled.

Show child attributes

warnings

string[]

Human-readable notes about the request, such as how many tests were skipped. Print them in your CI log. Empty when there is nothing to report.

variables

string[]

The names of the variables the run received, sorted. Never their values. Present only when the request sent variables.

Getting started

Tests

Folders

Runs

Builds

Native Runners

Audit

Usage

Execute tests

Authorizations

Body

Response