Stop Entity Store engines

Base URL: https://{kibana_url}

PUT /api/security/entity_store/stop
PUT /s/{space_id}/api/security/entity_store/stop

Auth

Stop running entity engines, pausing data processing for the specified entity types.

Required privileges

Privileges securitySolution

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

entityTypes enum[] · default: ["user","host","service","generic"]: Entity types to stop. Defaults to all running types.; Values: user host service generic

Response

200

Indicates a successful response.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Stop all running entity engines.

Console Kibana Dev Tools

PUT kbn://api/security/entity_store/stop
{
  "entityTypes": ["user", "host", "service", "generic"]
}

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"entityTypes":["user","host","service","generic"]}' \
  "${KIBANA_URL}/api/security/entity_store/stop"

Response

The specified entity engines were successfully stopped.

{
  "ok": true
}

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body