Bulk create monitors

Base URL: 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.

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

monitors union oneOf[] · min items: 1 · max items: 1000 required: 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.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://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 "${KIBANA_URL}/api/synthetics/monitors/_bulk_create" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -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"]}]}'

Request Console 1 / 2 languages

Run POST /api/synthetics/monitors/_bulk_create to create several monitors in one request.

Console Kibana Dev Tools

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

Generated from the API spec