Skip to main content
POST
/
v1
/
testSuite
/
{testSuiteId}
/
run
Start a test suite run
curl --request POST \
  --url https://api.stably.ai/v1/testSuite/{testSuiteId}/run \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "numberOfWorkers": 64,
  "retries": 123,
  "repeats": 123,
  "operationDelayMs": 123,
  "testTimeoutMs": 123,
  "testMatch": {
    "glob": "<string>",
    "regex": "<string>"
  },
  "setupTestId": "<string>",
  "teardownTestId": "<string>",
  "beforeEachTestId": "<string>",
  "afterEachTestId": "<string>",
  "notificationProfile": "PROJECT",
  "environment": "PRODUCTION",
  "variableOverrides": {
    "TEST_VAR": "test",
    "TEST_VAR_2": {
      "value": "test",
      "sensitive": true
    },
    "JSON_VAR": {
      "value": {
        "attribute": "value",
        "anotherAttribute": "anotherValue"
      }
    }
  },
  "metadata": {
    "git": {
      "branch": "<string>"
    },
    "note": "This is a note"
  },
  "urlReplacements": [
    {
      "original": "<string>",
      "replacement": "<string>"
    }
  ]
}'
{
  "projectId": "<string>",
  "testSuiteRunId": "<string>",
  "testSuiteName": "<string>",
  "options": {
    "numberOfWorkers": 64,
    "retries": 123,
    "repeats": 123,
    "operationDelayMs": 123,
    "testTimeoutMs": 123,
    "testMatch": {
      "glob": "<string>",
      "regex": "<string>"
    },
    "setupTestId": "<string>",
    "teardownTestId": "<string>",
    "beforeEachTestId": "<string>",
    "afterEachTestId": "<string>",
    "notificationProfile": "PROJECT",
    "environment": "ALL",
    "variableOverrides": {},
    "metadata": {
      "git": {
        "branch": "<string>"
      },
      "note": "This is a note"
    }
  }
}

Authorizations

​
authorization
string
header
required

Path Parameters

​
testSuiteId
string
required

Test suite id

Body

application/json
​
numberOfWorkers
number
Required range: 0 <= x <= 128
​
retries
number
​
repeats
number
​
operationDelayMs
number
​
testTimeoutMs
number
​
testMatch
object
​
setupTestId
string
​
teardownTestId
string
​
beforeEachTestId
string
​
afterEachTestId
string
​
notificationProfile
enum<string>
Available options:
PROJECT,
SUITE,
DISABLED
​
environment
enum<string>

Environment used to run the test suite

Available options:
PRODUCTION,
STAGING,
DEVELOPMENT
Example:

"PRODUCTION"

​
variableOverrides
object

Variable overrides for the test suite

Example:
{
  "TEST_VAR": "test",
  "TEST_VAR_2": { "value": "test", "sensitive": true },
  "JSON_VAR": {
    "value": {
      "attribute": "value",
      "anotherAttribute": "anotherValue"
    }
  }
}
​
metadata
object
​
urlReplacements
object[]

Response

200 - application/json

Default Response

Test suite run was started

​
projectId
string
required

Id of the project that contains the test suite

​
testSuiteRunId
string
required

Id of the suite run

​
testSuiteName
string
required

Name of the test suite

​
options
object
required

Applied options