1
0
mirror of https://github.com/Sonarr/Sonarr.git synced 2024-11-22 18:52:50 +01:00

Backup API docs

Mark McDowall 2017-08-20 23:27:25 -07:00
parent bd7cfe4f3c
commit d2438e105c
No known key found for this signature in database
GPG Key ID: D4CEFA9A718052E0
3 changed files with 43 additions and 0 deletions

@ -54,3 +54,4 @@ Where:
- [[Series]]
- [[Series-Lookup]]
- [[System-Status]]
- [[System-Backup]]

@ -167,3 +167,12 @@ Instruct Sonarr to rename all files in the provided series.
##### Parameters ######
`seriesIds (int[])` List of Series IDs to rename
### Backup ###
Instruct Sonarr to perform a backup of it's database and config file (nzbdrone.db and config.xml)
##### Parameters ######
None
---

33
API/System-Backup.md Normal file

@ -0,0 +1,33 @@
**Endpoint: "/system/backup"**
## GET ##
##### Summary #####
Returns the list of available backups
##### Parameters ######
*None*
##### Response (JSON Array) #####
```JSON
[
{
"name": "nzbdrone_backup_2017.08.17_22.00.00.zip",
"path": "/backup/update/nzbdrone_backup_2017.08.17_22.00.00.zip",
"type": "update",
"time": "2017-08-18T05:00:37Z",
"id": 1207435784
}
]
```
`type` is one of:
- `scheduled`
- `manual`
- `update`
Backups can be downloaded by using the host URL + URL Base (if configured) + the path returned (ie: `http://localhost:8989/urlbase/backup/update/nzbdrone_backup_2017.08.17_22.00.00.zip`)
A new backup can be taken using the `backup` command: [[Command]](#backup)