Type to search.

Bulk update monitors

Base URL
https://{kibana_url}
  • PUT /api/synthetics/monitors/_bulk_update
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.5 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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 body

updates object[] · min items: 1 · max items: 1000 required

Monitors to update. Minimum 1 entry, maximum 1000. Each id may appear at most once. attributes must contain at least one field.

attributes object · min properties: 1 required

Attributes to update for the monitor. You can specify the same fields as in PUT /api/synthetics/monitors/{id}. An empty object is rejected.

id string · min length: 1 · max length: 1024 required

The monitor config ID to update.

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
errors object[]

Optional service-level errors from the bulk sync.

result object[] required
error string

Present when updated is false.

id string required

The monitor config ID from the request.

updated boolean required

If true, the monitor was updated. If false, see error.

400

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