From fea8f00dbb4918a77dad77a52a1d6e78bf312ed6 Mon Sep 17 00:00:00 2001 From: Reiya Downs Date: Tue, 17 Sep 2024 13:34:12 -0700 Subject: [PATCH] Fixed minor errors, light editing Signed-off-by: Reiya Downs --- .../snapshots/cleanup-snapshot-repository.md | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/_api-reference/snapshots/cleanup-snapshot-repository.md b/_api-reference/snapshots/cleanup-snapshot-repository.md index ba3cfcffc9..cc6f976439 100644 --- a/_api-reference/snapshots/cleanup-snapshot-repository.md +++ b/_api-reference/snapshots/cleanup-snapshot-repository.md @@ -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 } @@ -21,7 +21,7 @@ POST /_snapshot//_cleanup | Parameter | Data type | Description | | :--- | :--- | :--- | -| `repository` | String | Name of repository to cleanup. | +| `repository` | String | Name of repository to clean up. | ## Query parameters @@ -29,12 +29,12 @@ The following table lists the available query parameters. All query parameters a | 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 @@ -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. |