v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Synthetics

Search test suites

Search for test suites.

get/api/v2/synthetics/suites/search

Query parameters

querystring

The search query.

sortstring

The sort order for the results (e.g., name,asc or name,desc).

facets_onlyboolean

If true, return only facets instead of full test details.

startinteger

The offset from which to start returning results.

countinteger

The maximum number of results to return.

Response

Example response

{
  "data": {
    "attributes": {
      "suites": [
        {
          "message": "Notification message",
          "monitor_id": 12345678,
          "name": "Example suite name",
          "public_id": "123-abc-456",
          "tags": [
            "env:production"
          ],
          "tests": [
            {
              "alerting_criticality": "critical"
            }
          ],
          "type": "suite"
        }
      ]
    },
    "type": "suites_search"
  }
}