Skip to content

Add 'Cleanup Snapshot' API Documentation #8373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 3, 2024
Merged

Add 'Cleanup Snapshot' API Documentation #8373

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
936c7ab
Add documentation for Clone Snapshot API
Reiyadowns Sep 14, 2024
6505789
Add documentation for Cleanup Snapshot Repository API
Reiyadowns Sep 15, 2024
fea8f00
Fixed minor errors, light editing
Reiyadowns Sep 17, 2024
65431f4
Remove erroneous clone-repository file
Reiyadowns Sep 24, 2024
7bdaafa
Merge branch 'main' into add-cleanup-snapshot-docs
Reiyadowns Sep 24, 2024
7f19a12
Merge branch 'main' into add-cleanup-snapshot-docs
Reiyadowns Sep 27, 2024
ca3a98c
Merge branch 'main' into add-cleanup-snapshot-docs
Naarcha-AWS Oct 1, 2024
3b8769a
Update cleanup-snapshot-repository.md
Naarcha-AWS Oct 3, 2024
eec51e1
Merge branch 'main' into add-cleanup-snapshot-docs
Naarcha-AWS Oct 3, 2024
e7f26ff
Apply suggestions from code review
Naarcha-AWS Oct 3, 2024
8d628b0
Apply suggestions from code review
Naarcha-AWS Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions _api-reference/snapshots/cleanup-snapshot-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
layout: default
title: Cleanup Snapshot Repository
parent: Snapshot APIs
nav_order: 11
---

# Cleanup Snapshot Repository

Check failure on line 8 in _api-reference/snapshots/cleanup-snapshot-repository.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'Cleanup Snapshot Repository' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'Cleanup Snapshot Repository' is a heading and should be in sentence case.", "location": {"path": "_api-reference/snapshots/cleanup-snapshot-repository.md", "range": {"start": {"line": 8, "column": 3}}}, "severity": "ERROR"}
Introduced 1.0
{: .label .label-purple }

The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot.

## Path and HTTP methods

```json
POST /_snapshot/<repository>/_cleanup
```
{% include copy.html %}


## Path parameters

| Parameter | Data type | Description |
| :--- | :--- | :--- |
| `repository` | String | The name of the snapshot repository. |

## Query parameters

The following table lists the available query parameters. All query parameters are optional.

| Parameter | Data type | Description |
| :--- | :--- | :--- |
| `cluster_manager_timeout` | Time | The amount of time to wait for a response from the cluster manager node. Formerly called `master_timeout`. Optional. Default is 30 seconds. |
| `timeout` | Time | The amount of time to wait for the operation to complete. Optional.|

## Example request

The following request removes all stale data from the repository `my_backup`:

```json
POST /_snapshot/my_backup/_cleanup
```
{% include copy-curl.html %}


## Example response

```json
{
"results":{
"deleted_bytes":40,
"deleted_blobs":8
}
}
```

## Response body fields

| Field | Data type | Description |
| :--- | :--- | :--- |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Below: Can we use something more precise than "freed"? Do we mean something like "The number of bytes made available by data deletion"?

| `deleted_bytes` | Integer | The number of bytes made available in the snapshot after data deletion. |
| `deleted_blobs` | Integer | The number of binary large objects (BLOBs) cleared from the repository by the request. |

Loading