v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB

Synthetics

Trigger tests from CI/CD pipelines

Trigger a set of Synthetic tests for continuous integration.

post/api/v1/synthetics/tests/trigger/ci

Request body

Example request

{
  "tests": [
    {
      "basicAuth": {
        "password": "PaSSw0RD!",
        "type": "web",
        "username": "my_username"
      },
      "deviceIds": [
        "chrome.laptop_large"
      ],
      "locations": [
        "aws:eu-west-3"
      ],
      "public_id": "aaa-aaa-aaa"
    }
  ]
}

Response

batch_idstring nullable

The public ID of the batch triggered.

triggered_check_idsstring[]

The public IDs of the Synthetic test triggered.

Example response

{
  "results": [
    {
      "device": "chrome.laptop_large"
    }
  ]
}