synthetics

Trigger an on-demand test run for a monitor

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/synthetics/monitor/test/{monitorId}</span></div>

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.<br/><br/>[Required authorization] Route required privileges: (uptime-read) AND (uptime-write OR monitor-run-manually).

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

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/monitor/test/{monitorId}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

monitorIdstring required

The ID (config_id) of the monitor to test.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Response

Test run triggered successfully.

testRunIdstring required

Unique identifier for the triggered test run.

Changes

No operation changes recorded.