diff --git a/API/API.md b/API/API.md index 5b0656a..320aaf7 100644 --- a/API/API.md +++ b/API/API.md @@ -54,3 +54,4 @@ Where: - [[Series]] - [[Series-Lookup]] - [[System-Status]] +- [[System-Backup]] diff --git a/API/Command.md b/API/Command.md index 5400d71..187fd27 100644 --- a/API/Command.md +++ b/API/Command.md @@ -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 + +--- diff --git a/API/System-Backup.md b/API/System-Backup.md new file mode 100644 index 0000000..de0da59 --- /dev/null +++ b/API/System-Backup.md @@ -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)