api/docs/admin/backup/create.md

49 lines
1.3 KiB
Markdown

# `/admin/backup/create` - POST
Creates a new backup.
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
| Content-Type | `application/json` |
## Content - JSON
This json body defines what will be included in the backup.
```
{
"all": true
/ OR /
/opt/ "NginxConfig": <bool>
/opt/ "MailServer": <bool>
/opt/ "Docker": {
/opt/ "Stacks": [<name/id>] / "all"
/opt/ "Images": [<name/id>] / "all"
/opt/ "Volumes": [<name/id>] / "all"
}
/opt/ "SslCerts": <bool>
}
```
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|---------|----------------------------------|
| backups | A list of (id, timestamp) pairs. |
### 400 - Error: Bad Request
The request was malformed.
### 401 - Error: Unauthorized
The provided auth token doesn't allow you to perform this operation.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
There was a unknown option in the content.
__Content - JSON:__
| Field | Description |
|---------|-----------------------------------------------------------------------------|
| problem | Tells you where the problem is. Example: "docker/stacks/not_existing_stack" |