From f09a1c577bb4fa38101b0ff142f4cc23089d9d29 Mon Sep 17 00:00:00 2001
From: Girish Ramakrishnan <girish@cloudron.io>
Date: Sun, 9 Oct 2016 20:23:05 -0700
Subject: [PATCH] doc: more docs for backup api

---
 docs/references/api.md | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

diff --git a/docs/references/api.md b/docs/references/api.md
index 6e870e5c1..651ca9ffe 100644
--- a/docs/references/api.md
+++ b/docs/references/api.md
@@ -1054,17 +1054,15 @@ GET `/api/v1/settings/backup_config` <scope>admin</scope> <scope>internal</scope
 
 Gets the credentials used to upload backups.
 
-This is currently internal API and is documented here for completeness.
-
 Response(200):
 ```
 {
-  "provider": <string>,  // 'caas' or 's3' or 'filesystem'
-  "key": <string>,       // encryption key
-  "region": <string>,    // s3 region
-  "bucket": <string>,    // s3 bucket name
-  "prefix": <string>,    // s3 bucket prefix
-  "token": <string>,     // 'caas' specific token
+  "provider": <string>,    // 'caas' or 's3' or 'filesystem'
+  "key": <string>,         // encryption key
+  "region": <string>,      // s3 region
+  "bucket": <string>,      // s3 bucket name
+  "prefix": <string>,      // s3 bucket prefix
+  "token": <string>,       // 'caas' specific token
   "backupFolder": <string> // 'filesystem' specific backup directory
 }
 ```
@@ -1075,7 +1073,20 @@ POST `/api/v1/settings/backup_config` <scope>admin</scope> <scope>internal</scop
 
 Sets the credentials used to upload backups.
 
-This is currently internal API and is documented here for completeness.
+Request:
+```
+{
+    "provider": "s3|filesystem",
+    "key": <string>,             // backup encryption key
+
+    "bucket": <string>,          // S3: bucket
+    "prefix": <string>,          // S3: prefix in bucket
+    "accessKeyId": <string>,     // S3: access key id
+    "secretAccessKey": <string>, // S3: secret access key
+
+    "backupFolder": <string>     // filesystem: directory inside cloudron to store backups
+}
+```
 
 ### Get DNS Configuration