Test suites API

By names

/api/v1/testsuites

Returns test suite info with results

Request parameters

{
  "names": [
    "example"
  ]
}

Responses

[
  {
    "id": 96,
    "name": "example",
    "owner": "example",
    "lastExecBy": "example",
    "execTime": "example",
    "execEndTime": "example",
    "duration": "example",
    "nextExecutionTime": "example",
    "schedule": "example",
    "passed": 96,
    "failed": 96,
    "error": 96,
    "notExecuted": 96,
    "testCount": 96,
    "directory": "example",
    "tags": [
      "example"
    ],
    "passedResult": 16.0,
    "failedResult": 16.0,
    "errorResult": 16.0,
    "notExecutedResult": 16.0
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Execute

/api/v1/testsuites/execute

Executes test suite and returns results. Like a scheduled run, it sends the suite's alerts and the failure alerts of its test cases; a run started in the UI does not.

Request parameters

Responses

{
  "id": 96,
  "name": "example",
  "owner": "example",
  "lastExecBy": "example",
  "execTime": "example",
  "execEndTime": "example",
  "duration": "example",
  "nextExecutionTime": "example",
  "schedule": "example",
  "passed": 96,
  "failed": 96,
  "error": 96,
  "notExecuted": 96,
  "testCount": 96,
  "directory": "example",
  "tags": [
    "example"
  ],
  "passedResult": 16.0,
  "failedResult": 16.0,
  "errorResult": 16.0,
  "notExecutedResult": 16.0
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

An execution started through this endpoint sends the suite's alerts and the failure alerts of its test cases, just like a scheduled run. A run started from the UI sends none, see When alerts are sent.

Request example:

{
  "name": "bike_store",
  "variables": {
    "environment": "STAGING",
    "countryCode": "EN"
  }
}

All

/api/v1/testsuites/all

Returns test suite info with results for all test suites

Responses

[
  {
    "id": 96,
    "name": "example",
    "owner": "example",
    "lastExecBy": "example",
    "execTime": "example",
    "execEndTime": "example",
    "duration": "example",
    "nextExecutionTime": "example",
    "schedule": "example",
    "passed": 96,
    "failed": 96,
    "error": 96,
    "notExecuted": 96,
    "testCount": 96,
    "directory": "example",
    "tags": [
      "example"
    ],
    "passedResult": 16.0,
    "failedResult": 16.0,
    "errorResult": 16.0,
    "notExecutedResult": 16.0
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Public

/api/v1/testsuites/public

Returns test suite info with results for public test suites

Responses

[
  {
    "id": 96,
    "name": "example",
    "owner": "example",
    "lastExecBy": "example",
    "execTime": "example",
    "execEndTime": "example",
    "duration": "example",
    "nextExecutionTime": "example",
    "schedule": "example",
    "passed": 96,
    "failed": 96,
    "error": 96,
    "notExecuted": 96,
    "testCount": 96,
    "directory": "example",
    "tags": [
      "example"
    ],
    "passedResult": 16.0,
    "failedResult": 16.0,
    "errorResult": 16.0,
    "notExecutedResult": 16.0
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

User

/api/v1/testsuites/user

Returns test suite info with results for users test suites

Request parameters

{
  "names": [
    "example"
  ]
}

Responses

[
  {
    "id": 96,
    "name": "example",
    "owner": "example",
    "lastExecBy": "example",
    "execTime": "example",
    "execEndTime": "example",
    "duration": "example",
    "nextExecutionTime": "example",
    "schedule": "example",
    "passed": 96,
    "failed": 96,
    "error": 96,
    "notExecuted": 96,
    "testCount": 96,
    "directory": "example",
    "tags": [
      "example"
    ],
    "passedResult": 16.0,
    "failedResult": 16.0,
    "errorResult": 16.0,
    "notExecutedResult": 16.0
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Tag

/api/v1/testsuites/tag

Returns test suite info with results for tag(s)

Request parameters

{
  "names": [
    "example"
  ]
}

Responses

[
  {
    "id": 96,
    "name": "example",
    "owner": "example",
    "lastExecBy": "example",
    "execTime": "example",
    "execEndTime": "example",
    "duration": "example",
    "nextExecutionTime": "example",
    "schedule": "example",
    "passed": 96,
    "failed": 96,
    "error": 96,
    "notExecuted": 96,
    "testCount": 96,
    "directory": "example",
    "tags": [
      "example"
    ],
    "passedResult": 16.0,
    "failedResult": 16.0,
    "errorResult": 16.0,
    "notExecutedResult": 16.0
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

13 October 2026