DAdatadog
Synthetics

Trigger tests from CI/CD pipelines

Trigger a set of Synthetic tests for continuous integration.

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

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/synthetics/tests/trigger/ci
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: synthetics_write

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

OK

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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.