Clean up the snapshot repository Added in 7.4.0

POST /_snapshot/{repository}/_cleanup
Api key auth Basic auth Bearer auth

Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

External documentation

Path parameters

  • repository string Required

    Snapshot repository to clean up.

Query parameters

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • results object Required
      Hide results attributes Show results attributes object
      • deleted_blobs number Required

        Number of binary large objects (blobs) removed during cleanup.

      • deleted_bytes number Required

        Number of bytes freed by cleanup operations.
POST /_snapshot/{repository}/_cleanup 
curl \
 --request POST 'http://api.example.com/_snapshot/{repository}/_cleanup' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `POST /_snapshot/my_repository/_cleanup`. 
{
  "results": {
    "deleted_bytes": 20,
    "deleted_blobs": 5
  }
}