Disable the history snapshot task

Base URL: https://{kibana_url}

PUT /api/security/entity_store/history_snapshot/disable
PUT /s/{space_id}/api/security/entity_store/history_snapshot/disable

Auth

Disable the Entity Store history snapshot task for this space so it no longer creates snapshot indices. Existing snapshot indices remain unless you set clearHistorySnapshots to true. Returns 404 if the Entity Store is not installed in the current space.

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

clearHistorySnapshots boolean · default: false: When true, deletes existing history snapshot indices for this space in the background after the task is disabled. The response returns immediately and does not wait for deletion to finish. Deletion failures are logged and are not returned to the caller. If the task is already disabled, the request succeeds and does not delete indices. Defaults to false.

Responses

200

Indicates a successful response.

application/json

404

Entity store is not installed.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/security/entity_store/history_snapshot/disable
{
  "clearHistorySnapshots": true
}

Generated from the API spec

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Content-Type: application/json" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -d '{
    "clearHistorySnapshots": true
  }' \
  "${KIBANA_URL}/api/security/entity_store/history_snapshot/disable"

Generated from the API spec

Response

The Entity Store history snapshot task was disabled.

{
  "ok": true
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/security/entity_store/history_snapshot/disable
{}

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Content-Type: application/json" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -d '{}' \
  "${KIBANA_URL}/api/security/entity_store/history_snapshot/disable"

Response

The Entity Store history snapshot task was disabled.

{
  "ok": true
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/security/entity_store/history_snapshot/disable
{
  "clearHistorySnapshots": true
}

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Content-Type: application/json" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -d '{"clearHistorySnapshots":true}' \
  "${KIBANA_URL}/api/security/entity_store/history_snapshot/disable"

Response

The Entity Store history snapshot task was disabled.

{
  "ok": true
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}