Disable the history snapshot task

Server: https://{kibana_url}

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

Refer to Spaces for more information.

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 authorization] Route required privileges: securitySolution.

Request

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

Examples

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

{
  "ok": true
}

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

Request Console 1 / 4 languages

Console Kibana Dev Tools

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

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 '{}' \
  "${KIBANA_URL}/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 '{"clearHistorySnapshots":true}' \
  "${KIBANA_URL}/api/security/entity_store/history_snapshot/disable"

Response

{
  "ok": true
}

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