Skip to main content
POST
Start test run

Body

application/json

Request body for triggering a test run. Supports GitHub trigger fields, application overrides, and optional parameters for config overrides (merged into the blueprint).

trigger
enum<string>
Available options:
API,
GITHUB
actor
string
branch
string
commitHash
string
commitMessage
string
repository
string
testPlanShortId
string
Pattern: ^pln(-.+_.+|_.+)$
testCaseIds
string[]
applications
object[]
notifications
object[]
parameters
object

Optional run-time parameter overrides merged into the blueprint (after test plan defaults). Use configs to replace full config payloads by config short id (map keys are strings such as cfg_... or human-readable slugs); use configsByEnvironment for environment-specific overrides (outer key is environment UUID).

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
run
object
required