Skip to main content
POST
Generate test automation

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.

testIds
string[]
required

IDs of existing test cases to write automation for. Each test must already have a description, since generation writes code for the described behaviour rather than inventing one.

uploadId
string

Write the automation against a specific uploaded build instead of the organisation's newest one.

bundleId
string

Write the automation against the app already installed on your reserved device, instead of an uploaded build. May omit platform, which is then taken from the reserved device.

platform
string

Restrict generation to one platform (ios or android). Taken from the upload when omitted with uploadId; with neither uploadId nor bundleId, omitting this generates against every platform the organisation has a build for.

testsRepo
string

Override the organisation's managed test repository. Normally left unset, since generation resolves the repo automatically and creates one if the organisation doesn't have one yet.

usePhysicalDevice
boolean

Run the generation on a physical device instead of a simulator/emulator. Forced on automatically for iOS .ipa builds and for bundle-only (buildless) generation.

verificationRounds
integer

How many consecutive passing runs the generated test must produce before it is committed. Defaults to 3. Raising this increases confidence at the cost of one full test run per extra round.

tunnelName
string

Name of the tunnel to route the device through, for apps whose flow touches an internal/non-public host.

Response

Successful response

started
object[]

The generation run that was dispatched immediately, for the first platform.

queued
string[]

Platforms queued to start once the first platform's generation finishes (only present when a test needs automation on more than one platform).