Start Entity Store engines

Base URL: https://{kibana_url}

PUT /api/security/entity_store/start

Auth

Start previously stopped entity engines, resuming data processing for the specified entity types.

Required privileges

Privileges securitySolution

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 start. Defaults to all installed 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

Start all stopped entity engines.

Console Kibana Dev Tools

PUT kbn://api/security/entity_store/start
{
  "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/start"

Response

The specified entity engines were successfully started.

{
  "ok": true
}

Request Console 1 / 2 languages

Start only the host entity engine.

Console Kibana Dev Tools

PUT kbn:/api/security/entity_store/start
{
  "entityTypes": [
    "host"
  ]
}

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 '{
    "entityTypes": [
      "host"
    ]
  }' \
  "${KIBANA_URL}/api/security/entity_store/start"

Generated from the API spec

Response

The specified entity engines were successfully started.

{
  "ok": true
}

Required privileges

Header parameters

Request body { }

Response

Request body