Clean up the snapshot repository

POST /_snapshot/{repository}/_cleanup

Auth

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

About managing snapshot

Required privileges

Cluster privileges manage

Path parameters

repository string required: The name of the snapshot repository to clean up.

Query parameters

master_timeout string · default: 30s: 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 · default: 30s: 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.

Response

application/json

results object required: Statistics for cleanup operations.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_snapshot/my_repository/_cleanup

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.cleanupRepository({
  name: "my_repository",
});

Python Elasticsearch Python Client

resp = client.snapshot.cleanup_repository(
    name="my_repository",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_repository/_cleanup" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.snapshot().cleanupRepository(c -> c
    .name("my_repository")
);

C# Elasticsearch .NET Client

var response = await client.Snapshot.CleanupRepositoryAsync(name: "my_repository");

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->cleanupRepository([
    "repository" => "my_repository",
]);

Ruby Elasticsearch Ruby Client

response = client.snapshot.cleanup_repository(
  repository: "my_repository"
)

Response

A successful response from POST /_snapshot/my_repository/_cleanup.

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