Bulk update monitors

Server: 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. This is a versioned public API (elastic-api-version: 2023-10-31).

Request

updates [] object · min: 1 · max: 1000 required: Monitors to update. Minimum 1 entry, maximum 1000. Each id may appear at most once. attributes must contain at least one field.

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.

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /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 "https://{kibana_url}/api/synthetics/monitors/_bulk_update" \
  -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"
        }
      }
    }
  ]
}'

Response

{
  "result": [
    {
      "id": "monitor1-id",
      "updated": true
    },
    {
      "id": "missing-id",
      "updated": false,
      "error": "Monitor id missing-id not found!"
    },
    {
      "id": "monitor3-id",
      "updated": true
    }
  ]
}