Delete monitors

Base URL: https://{kibana_url}

POST /api/synthetics/monitors/_bulk_delete

Auth

Delete multiple monitors by sending a list of config IDs.

Request body

ids string[] required: An array of monitor IDs to delete.

Response

A successful response.

application/json

<array> object[]

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Run POST /api/synthetics/monitors/_bulk_delete to delete a list of monitors.

Console Kibana Dev Tools

POST kbn:/api/synthetics/monitors/_bulk_delete
{
  "ids": [
    "monitor1-id",
    "monitor2-id"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/synthetics/monitors/_bulk_delete" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "monitor1-id",
      "monitor2-id"
    ]
  }'

Generated from the API spec

Response

A response from successfully deleting multiple monitors.

[
  {
    "id": "monitor1-id",
    "deleted": true
  },
  {
    "id": "monitor2-id",
    "deleted": true
  }
]

Request body { }

Response

Request body