Skip to content

Commit

Permalink
Fixed minor errors, light editing
Browse files Browse the repository at this point in the history
Signed-off-by: Reiya Downs <[email protected]>
  • Loading branch information
Reiyadowns committed Sep 24, 2024
1 parent 6505789 commit fea8f00
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions _api-reference/snapshots/cleanup-snapshot-repository.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: default
title: Cleanup Snapshot
title: Cleanup Snapshot Repository
parent: Snapshot APIs
nav_order: 11
---

# Example API
# Cleanup Snapshot Repository
Introduced 1.0
{: .label .label-purple }

Expand All @@ -21,20 +21,20 @@ POST /_snapshot/<repository>/_cleanup

| Parameter | Data type | Description |
| :--- | :--- | :--- |
| `repository` | String | Name of repository to cleanup. |
| `repository` | String | Name of repository to clean up. |

## 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`. Default is 30 seconds. |
| `timeout` | Time | The amount of time to wait for the operation to complete. |
| `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 unreferenced data from the repository `my_backup`:
The following request removes all stale data from the repository `my_backup`:

```json
POST /_snapshot/my_backup/_cleanup
Expand All @@ -49,17 +49,16 @@ Upon success, the request will return a JSON object of the following form:
```json
{
"results":{
"deleted_bytes":0,
"deleted_blobs":0
}
"deleted_bytes":40,
"deleted_blobs":8
}
}
```

## Response body fields


| Field | Data type | Description |
| :--- | :--- | :--- |
| `deleted_bytes` | Integer | The amount of bytes freed by the request. |
| `deleted_blobs` | Integer | The amount of binary large objects (BLOBS) cleared from the repository during the request. |
| `deleted_blobs` | Integer | The amount of binary large objects (BLOBs) cleared from the repository by the request. |

0 comments on commit fea8f00

Please sign in to comment.