synthetics

Delete monitors

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

Refer to Spaces for more information.

Delete multiple monitors by sending a list of config IDs.<br/><br/>[Required authorization] Route required privileges: uptime-read AND uptime-write.

post/api/synthetics/monitors/_bulk_delete

Request

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

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

idsstring[] required

An array of monitor IDs to delete.

Response

A successful response.

deletedboolean

If true, the object was deleted. If false, it was not deleted.

idstring

The unique identifier of the deleted object.

Changes

No operation changes recorded.