IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Clean up snapshot repository API
editClean up snapshot repository API
editTriggers the review of a snapshot repository’s contents and deletes any stale data that is not referenced by existing snapshots. See Clean up a repository.
POST /_snapshot/my_repository/_cleanup
Request
editPOST /_snapshot/<repository>/_cleanup
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
managecluster privilege to use this API.
Path parameters
edit-
<repository> - (Required, string) Name of the snapshot repository to review and clean up.
Query parameters
edit-
master_timeout -
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s. -
timeout -
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s.
Response body
edit-
results -
(object) Contains statistics for cleanup operations.
Properties of
results-
deleted_bytes - (integer) Number of bytes freed by cleanup operations.
-
deleted_blobs - (integer) Number of binary large objects (blobs) removed from the snapshot repository during cleanup operations. Any non-zero value implies that unreferenced blobs were found and subsequently cleaned up.
-
Examples
editPOST /_snapshot/my_repository/_cleanup
The API returns the following response:
{
"results": {
"deleted_bytes": 20,
"deleted_blobs": 5
}
}