Clean up the snapshot repository

POST /_snapshot/{repository}/_cleanup

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

Read the reference documentation

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

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
  }
}