Start test run

Execute a run for a given project. Supports API or GITHUB trigger. When using GITHUB trigger, provide actor, branch, commitHash, commitMessage, and repository. Use applications to override environment or device preset per run.

POST /v1/run

Start test run

cURL

curl --request POST \
  --url https://api.qa.tech/v1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": "<string>",
  "branch": "<string>",
  "commitHash": "<string>",
  "commitMessage": "<string>",
  "repository": "<string>",
  "testPlanShortId": "<string>",
  "testCaseIds": [
    "<string>"
  ],
  "applications": [
    {
      "applicationShortId": "<string>",
      "devicePresetShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      }
    }
  ],
  "notifications": [
    {
      "type": "slack",
      "channel": "<string>"
    }
  ],
  "parameters": {
    "configs": {},
    "configsByEnvironment": {}
  },
  "projectShortId": "<string>"
}
'

200

{
  "success": true,
  "run": {
    "id": "<string>",
    "shortId": "<string>",
    "url": "<string>",
    "testCount": 123,
    "testPlan": {
      "name": "<string>",
      "shortId": "<string>"
    }
  }
}

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[]

Show child attributes

notifications · object[]

Show child attributes

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

Show child attributes

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

Show child attributes