› › ›

Clean up snapshot repository API

Triggers 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

POST /_snapshot/<repository>/_cleanup

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API.

Path parameters

<repository>: (Required, string) Name of the snapshot repository to review and clean up.

Query parameters

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

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

POST /_snapshot/my_repository/_cleanup

The API returns the following response:

{
  "results": {
    "deleted_bytes": 20,
    "deleted_blobs": 5
  }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/clean-up-snapshot-repo-api.html