Trigger an on-demand test run for a monitor

Base URL: 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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Responses

Test run triggered successfully.

application/json

404

Monitor not found.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/synthetics/monitor/test/MONITOR_ID

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/synthetics/monitor/test/${MONITOR_ID}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

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