Sign in
Security entity store

Disable the history snapshot task

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security/entity_store/history_snapshot/disable</span></div>

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

put/api/security/entity_store/history_snapshot/disable

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

clearHistorySnapshotsboolean

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.

Response

Indicates a successful response.

Changes

Changed in 1 of the 176 revisions of this API.1

Of the 176 revisions, 20 have no diff computed.