Trigger an on-demand test run for a monitor Generally available

POST /api/synthetics/monitor/test/{monitorId}
Api key auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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).

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • monitorId string Required

    The ID (config_id) of the monitor to test.

    Minimum length is 1, maximum length is 1024.

Responses

  • 200 application/json

    Test run triggered successfully.

    Hide response attributes Show response attributes object
    • errors array[object]

      Array of errors encountered while triggering the test, one per service location.

      Hide errors attributes Show errors attributes object
      • error object Required
        Hide error attributes Show error attributes object
        • failed_monitors array[object] | null Required

          Optional list of monitors that failed at the location.

        • reason string Required

          Human-readable explanation of the failure.

        • status integer Required

          HTTP status code returned by the agent.

      • locationId string Required

        Identifier of the service location where the error occurred.

    • testRunId string Required

      Unique identifier for the triggered test run.
  • 404

    Monitor not found.

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

POST kbn://api/synthetics/monitor/test/monitor-id
Response examples (200) 
{
  "errors": [
    {
      "error": {
        "failed_monitors": null,
        "reason": "no auth credentials provided",
        "status": 401
      },
      "locationId": "us_central_staging"
    }
  ],
  "testRunId": "2bd506e5-4f9a-4aa6-a019-7988500afba0"
}