synthetics

Create a monitor

Changed on

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/monitors</span></div>

Refer to Spaces for more information.

Create a new monitor with the specified attributes. A monitor can be one of the following types: HTTP, TCP, ICMP, or Browser. The required and default fields may vary based on the monitor type.

You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.<br/><br/>[Required authorization] Route required privileges: uptime-read AND uptime-write.

post/api/synthetics/monitors

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/monitors
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

idstring

A custom ID for the new monitor. Generated if omitted.

'true' | 'false'
OR
boolean

If true, store the namespace as sent. Otherwise, a default namespace is replaced with one derived from the space ID.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

OR
OR
OR
OR

Response

A successful response. The response may include a warnings array when the monitor configuration has non-critical issues. For example, if a browser monitor specifies a timeout but has no private locations configured, a warning is returned indicating the timeout will have no effect.

Changes

  • 53eec132a4e2Revision changes
    • info

      added the new optional request property //