Trigger an on-demand test run for a monitor

Base URL: https://{kibana_url}

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

Auth

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.

[Required authorization] Route required privileges: (uptime-read) AND (uptime-write OR monitor-run-manually).

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
monitorId string · min length: 1 · max length: 1024 required: The ID (config_id) of the monitor to test.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Responses

Test run triggered successfully.

application/json

errors object[]: Array of errors encountered while triggering the test, one per service location.
testRunId string required: Unique identifier for the triggered test run.

404

Monitor not found.

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/synthetics/monitor/test/monitor-id

curl Shell

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

Response

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