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

    The name of the snapshot repository to clean up.

Query parameters

  • master_timeout string

    The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1

  • timeout string

    The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

Responses

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

      Additional properties are allowed.

      Hide results attributes Show results attributes object
      • deleted_blobs number Required

        The number of binary large objects (blobs) removed from the snapshot repository during cleanup operations. A non-zero value indicates that unreferenced blobs were found and subsequently cleaned up.

      • deleted_bytes number Required

        The 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) 
{
  "results": {
    "deleted_blobs": 42.0,
    "deleted_bytes": 42.0
  }
}