Bulk update monitors

Base URL: https://{kibana_url}

PUT /api/synthetics/monitors/_bulk_update
PUT /s/{space_id}/api/synthetics/monitors/_bulk_update

Refer to Spaces for more information.

Partially update multiple monitors in a single request.

Each updates entry has its own id and attributes patch, so one request can apply a different change per monitor. Unspecified fields are left unchanged. Patches use the same merge, validate, and encrypt path as PUT /api/synthetics/monitors/{id}.

For private-location monitors, Fleet is synced once for the batch instead of once per monitor.

You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

A successful response. The result array is in request order. Per-id failures (not found, validation, Fleet sync) set updated: false and error without failing the whole batch. errors is present only when there are service-level sync errors.

application/json

400

Bad request. Returned when updates is missing or empty, an attributes object is empty, or the same id appears more than once.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/synthetics/monitors/_bulk_update
{"updates":[{"id":"monitor1-id","attributes":{"enabled":false}},{"id":"monitor2-id","attributes":{"tags":["bulk-patched"]}},{"id":"monitor3-id","attributes":{"schedule":{"number":"15","unit":"m"}}}]}

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/synthetics/monitors/_bulk_update" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"updates":[{"id":"monitor1-id","attributes":{"enabled":false}},{"id":"monitor2-id","attributes":{"tags":["bulk-patched"]}},{"id":"monitor3-id","attributes":{"schedule":{"number":"15","unit":"m"}}}]}'

Request Console 1 / 2 languages

Run PUT /api/synthetics/monitors/_bulk_update to apply a different partial update to each monitor.

Console Kibana Dev Tools

PUT kbn:/api/synthetics/monitors/_bulk_update
{
  "updates": [
    {
      "attributes": {
        "enabled": false
      },
      "id": "monitor1-id"
    },
    {
      "attributes": {
        "tags": [
          "bulk-patched"
        ]
      },
      "id": "monitor2-id"
    },
    {
      "attributes": {
        "schedule": {
          "number": "15",
          "unit": "m"
        }
      },
      "id": "monitor3-id"
    }
  ]
}

Generated from the API spec