v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Synthetics

Get the list of all Synthetic tests

Get the list of all Synthetic tests.

get/api/v1/synthetics/tests

Query parameters

page_sizeinteger

Used for pagination. The number of tests returned in the page.

page_numberinteger

Used for pagination. Which page you want to retrieve. Starts at zero.

Response

OK - Returns the list of all Synthetic tests.

Example response

{
  "tests": [
    {
      "config": {
        "assertions": [],
        "configVariables": [
          {
            "name": "VARIABLE_NAME",
            "type": "text"
          }
        ],
        "request": {
          "basicAuth": {
            "password": "PaSSw0RD!",
            "type": "web",
            "username": "my_username"
          },
          "bodyType": "text/plain",
          "callType": "unary",
          "mcpProtocolVersion": "2025-06-18",
          "proxy": {
            "url": "https://example.com"
          },
          "service": "Greeter",
          "toolName": "search",
          "url": "https://example.com"
        },
        "variables": [
          {
            "name": "VARIABLE_NAME",
            "type": "text"
          }
        ]
      },
      "locations": [
        "aws:eu-west-3"
      ],
      "options": {
        "ci": {
          "executionRule": "blocking"
        },
        "device_ids": [
          "chrome.laptop_large"
        ],
        "restricted_roles": [
          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        ],
        "rumSettings": {
          "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "clientTokenId": 12345,
          "isEnabled": true
        },
        "scheduling": {
          "timeframes": [
            {
              "day": 1,
              "from": "07:00",
              "to": "16:00"
            },
            {
              "day": 3,
              "from": "07:00",
              "to": "16:00"
            }
          ],
          "timezone": "America/New_York"
        }
      },
      "status": "live",
      "subtype": "http"
    }
  ]
}