Bulk update entities

Base URL: https://{kibana_url}

PUT /api/security/entity_store/entities/bulk
PUT /s/{space_id}/api/security/entity_store/entities/bulk

Refer to Spaces for more information.

Update multiple entity records in the Entity Store in a single request.

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>

Query parameters

Header parameters

Request body

entities object[] required: The entities to update.

Responses

200

Indicates a successful response.

application/json

400

Bad request.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/security/entity_store/entities/bulk?force=true
{
  "entities": [
    {
      "type": "host",
      "doc": {
        "entity": {
          "id": "host:web-server-prod-01",
          "name": "web-server-prod-01",
          "type": "host",
          "attributes": { "asset": true }
        },
        "host": { "name": "web-server-prod-01" }
      }
    }
  ]
}

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"entities":[{"type":"host","doc":{"entity":{"id":"host:web-server-prod-01","name":"web-server-prod-01","type":"host","attributes":{"asset":true}},"host":{"name":"web-server-prod-01"}}}]}' \
  "${KIBANA_URL}/api/security/entity_store/entities/bulk?force=true"

Response

The request attempts to update protected fields without the force query parameter.

{
  "error": "Bad Request",
  "message": "Bad request: The following attributes are not allowed to be updated without forcing it (?force=true): entity.name, entity.type",
  "statusCode": 400
}

Request Console 1 / 2 languages

Update a host entity and a user entity in a single request.

Console Kibana Dev Tools

PUT kbn:/api/security/entity_store/entities/bulk
{
  "entities": [
    {
      "doc": {
        "entity": {
          "attributes": {
            "asset": true
          },
          "id": "host:web-server-prod-01",
          "name": "web-server-prod-01",
          "type": "host"
        },
        "host": {
          "name": "web-server-prod-01"
        }
      },
      "type": "host"
    },
    {
      "doc": {
        "entity": {
          "attributes": {
            "managed": true
          },
          "id": "user:jane.doe@example.com",
          "name": "jane.doe",
          "type": "user"
        },
        "user": {
          "name": "jane.doe"
        }
      },
      "type": "user"
    }
  ]
}

Generated from the API spec

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "entities": [
      {
        "doc": {
          "entity": {
            "attributes": {
              "asset": true
            },
            "id": "host:web-server-prod-01",
            "name": "web-server-prod-01",
            "type": "host"
          },
          "host": {
            "name": "web-server-prod-01"
          }
        },
        "type": "host"
      },
      {
        "doc": {
          "entity": {
            "attributes": {
              "managed": true
            },
            "id": "user:jane.doe@example.com",
            "name": "jane.doe",
            "type": "user"
          },
          "user": {
            "name": "jane.doe"
          }
        },
        "type": "user"
      }
    ]
  }' \
  "${KIBANA_URL}/api/security/entity_store/entities/bulk"

Generated from the API spec

Response

Some entities were updated but others encountered Elasticsearch-level errors.

{
  "errors": [
    {
      "_id": "5de9f93a68a72532e736bf5a6184b06300b9cabf",
      "reason": "[5de9f93a68a72532e736bf5a6184b06300b9cabf]: document missing",
      "status": 404,
      "type": "document_missing_exception"
    }
  ],
  "ok": true
}

{
  "error": "Bad Request",
  "message": "Bad request: The following attributes are not allowed to be updated without forcing it (?force=true): entity.name, entity.type",
  "statusCode": 400
}