Test Suites API

See the documentation on authenticating to configure access to the Captain API.

You can use the test suites endpoint to list your test suites and retrieve identifiers for follow-up API calls.

https://cloud.rwx.com/captain/api/test_suites

No query string parameters are required.

Example

A fully authenticated request with curl, assuming an access token is set in an RWX_ACCESS_TOKEN environment variable, will look like this:

curl \
  --header "Authorization: Bearer $RWX_ACCESS_TOKEN" \
  "https://cloud.rwx.com/captain/api/test_suites"

Response

The API will respond with a JSON document containing the following fields:

  • test_suites – an array of test suites
  • total – the total count of test suites

Result Structure

Each object under test_suites contains the following properties:

  • identifier
  • quarantined_count
  • flaky_count
  • is_quarantined
  • framework.language
  • framework.kind

Example Response

{
  "total": 1,
  "test_suites": [
    {
      "identifier": "your-test-suite-identifier",
      "quarantined_count": 0,
      "flaky_count": 2,
      "is_quarantined": false,
      "framework": {
        "language": "JavaScript",
        "kind": "Jest"
      }
    }
  ]
}