From f7870d79d4dc1f12fa81e399ffe3a5802c41050f Mon Sep 17 00:00:00 2001 From: Tanmoy Sarkar <57363826+tanmoysrt@users.noreply.github.com> Date: Thu, 15 Feb 2024 23:41:02 +0530 Subject: [PATCH] chore: docs update --- docs/rest_api.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/rest_api.md b/docs/rest_api.md index cf7decbf1a..1e47dac84c 100644 --- a/docs/rest_api.md +++ b/docs/rest_api.md @@ -71,4 +71,41 @@ For other part, we are using the GraphQL API. Check the [GraphQL API Documentati { "message": "file is not a tar file" } - ``` \ No newline at end of file + ``` + +--- + +### Download Backup API + +**GET** /persistent-volume/backup//download + +**Example Response** + +**200 OK** +- The file will be downloaded + +**Any other status code** +- The file will not be downloaded + +--- + +### Upload File for Restore API +**POST** /persistent-volume/restore//upload + +**Form Data** + +| Key | Value Type | Example Value | +| --- |-----------------------|---------------| +| file | file (only tar files) | file.tar.gz | + +**Example Response** + +**200 OK** +```json +{ + "message": "file uploaded successfully, you can now start the restore process", +} +``` + +**Any other status code** +- The file upload failed \ No newline at end of file