POST
/
projects
/
{projectId}
/
runs
Start the tests
curl --request POST \
  --url https://app.qa.tech/api/projects/{projectId}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "integrationName": "CircleCI",
  "testPlanShortId": "abc123",
  "applications": {
    "app-short-id-1": {
      "environment": {
        "url": "https://preview-123-frontend.vercel.app",
        "name": "PR-123-Frontend"
      }
    },
    "app-short-id-2": {
      "environment": {
        "url": "https://preview-123-backend.vercel.app",
        "name": "PR-123-Backend"
      }
    }
  }
}'
{
  "runId": "abc123",
  "status": "created"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Content-Type
string
required

The media type of the request body. Should be set to application/json

Example:

"application/json"

​
Authorization
string
required

Bearer token for API authentication

Example:

"Bearer your-api-token"

Path Parameters

​
projectId
string
required

The ID of the project

Body

application/json
​
testPlanShortId
string
required

The short ID of the test plan to run

Example:

"abc123"

​
integrationName
string
default:API

Human readable name of what triggered this test, can be the name of the CI/CD tool. Defaults to 'API' if not provided.

Example:

"CircleCI"

​
applications
object

Optional application environment overrides

Example:
{
  "app-short-id-1": {
    "environment": {
      "url": "https://preview-123-frontend.vercel.app",
      "name": "PR-123-Frontend"
    }
  },
  "app-short-id-2": {
    "environment": {
      "url": "https://preview-123-backend.vercel.app",
      "name": "PR-123-Backend"
    }
  }
}

Response

Successfully created run

​
runId
string
Example:

"abc123"

​
status
string
Example:

"created"