jjkiers/cloudron-box
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

doc: more docs for backup api

Browse Source
This commit is contained in:
Girish Ramakrishnan
2016-10-09 20:23:05 -07:00
parent 4e3ba4c96f
commit f09a1c577b
1 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/references/api.md
View File

@@ -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