Skip to content

Commit 3dd6a07

Browse files
authored
chore: docs update (#267) (#268)
1 parent 671ba62 commit 3dd6a07

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

docs/rest_api.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,41 @@ For other part, we are using the GraphQL API. Check the [GraphQL API Documentati
7171
{
7272
"message": "file is not a tar file"
7373
}
74-
```
74+
```
75+
76+
---
77+
78+
### Download Backup API
79+
80+
**GET** /persistent-volume/backup/<backup_id>/download
81+
82+
**Example Response**
83+
84+
**200 OK**
85+
- The file will be downloaded
86+
87+
**Any other status code**
88+
- The file will not be downloaded
89+
90+
---
91+
92+
### Upload File for Restore API
93+
**POST** /persistent-volume/restore/<restore_id>/upload
94+
95+
**Form Data**
96+
97+
| Key | Value Type | Example Value |
98+
| --- |-----------------------|---------------|
99+
| file | file (only tar files) | file.tar.gz |
100+
101+
**Example Response**
102+
103+
**200 OK**
104+
```json
105+
{
106+
"message": "file uploaded successfully, you can now start the restore process",
107+
}
108+
```
109+
110+
**Any other status code**
111+
- The file upload failed

0 commit comments

Comments
 (0)