Trigger an on-demand test run for a monitor

Server: https://{kibana_url}

POST /api/synthetics/monitor/test/{monitorId}

Trigger an immediate test execution for the specified monitor. The response includes the generated testRunId. If the test encounters issues in one or more service locations, an errors array is also returned with details about the failures.

Path Parameters

monitorId string required: The ID (config_id) of the monitor to test.

Responses

Test run triggered successfully.

application/json

404

Monitor not found.

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitor/test/{monitorId}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitor/test/{monitorId}"

Response

{
  "testRunId": "2bd506e5-4f9a-4aa6-a019-7988500afba0",
  "errors": [
    {
      "locationId": "us_central_staging",
      "error": {
        "status": 401,
        "reason": "no auth credentials provided",
        "failed_monitors": null
      }
    }
  ]
}