Bulk create monitors

Server: https://{kibana_url}

POST /api/synthetics/monitors/_bulk_create
POST /s/{space_id}/api/synthetics/monitors/_bulk_create

Refer to Spaces for more information.

Create up to 1000 monitors in one request. Every monitor is validated before any monitor is persisted. The API creates the Saved Objects and synchronizes Fleet once for the batch. You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges. If a monitor is shared to additional spaces, you must also have create privileges in each of those spaces. This is a versioned public API (elastic-api-version: 2023-10-31).

Request

monitors [] union oneOf · min: 1 · max: 1000 required: A non-empty list of monitor configurations, up to 1000 monitors.; One of:

Responses

A successful response. created: false indicates an individual Saved Object creation or Fleet synchronization failure; see error. Batch-level Fleet synchronization errors are returned in errors.

application/json

400

Bad request. Returned when the batch is empty or too large, a monitor configuration is invalid, or two monitors use the same name.

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitors/_bulk_create
{
  "monitors": [
    {
      "type": "http",
      "name": "Storefront",
      "url": "https://example.com",
      "locations": ["united_kingdom"]
    },
    {
      "type": "http",
      "name": "Documentation",
      "url": "https://docs.example.com",
      "locations": ["united_kingdom"]
    }
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitors/_bulk_create" \
  -H "Content-Type: application/json" \
  -d '{
  "monitors": [
    {
      "type": "http",
      "name": "Storefront",
      "url": "https://example.com",
      "locations": ["united_kingdom"]
    },
    {
      "type": "http",
      "name": "Documentation",
      "url": "https://docs.example.com",
      "locations": ["united_kingdom"]
    }
  ]
}'

Response

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