Mirrors/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2024-11-22 10:42:47 +01:00
Code Issues Releases Wiki Activity

Updated Command (markdown)

Justin P 2017-03-16 14:20:35 -05:00
parent f6ce1e8af5
commit 4d7295fa0b
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
API/Command.md

@ -10,15 +10,16 @@ Queries the status of a previously started command, or all currently started com
##### Parameters ######
Required:
*None*
Required:
*None*
Optional:
Optional:
`id (int)` Unique ID of the command
##### Returns ######
For `api/command`
An array of JSON objects
For `api/command/{id}`
@ -37,11 +38,11 @@ For `api/command/{id}`
## POST ##
##### Summary #####
Publish a new command for Sonarr to run.
Publish a new command for Sonarr to run.
These commands are executed asynchronously; use `GET` to retrieve the current status.
And, remember, all `POST/PUT` requests require all parameters to be JSON encoded in the body, unless otherwise noted.
These commands are executed asynchronously; use `GET` to retrieve the current status.
And, remember, all `POST/PUT` requests require all parameters to be JSON encoded in the body, unless otherwise noted.
##### Parameters ######
@ -69,7 +70,7 @@ Refresh series information from trakt and rescan disk
##### Parameters ######
Optional:
`seriesId (int)` - if not set all series will be refreshed and scanned
`seriesId (int)` - if not set, all series will be refreshed and scanned
---
@ -115,19 +116,20 @@ Required:
---
### DownloadedEpisodesScan ###
Instruct Sonarr to scan the `DroneFactoryFolder` or another folder defined by the `path` variable.
Each file and folder in the `DroneFactoryFolder` is interpreted as a separate download (job).
Instruct Sonarr to scan the `DroneFactoryFolder` or another folder defined by the `path` variable.
Each file and folder in the `DroneFactoryFolder` is interpreted as a separate download (job).
But a folder specified by the path variable is assumed to be a single download (job) and the folder name should be the release name.
The `downloadClientId` can be used to support this API endpoint in conjunction with Completed Download Handling, so Sonarr knows that a particular download has already been imported.
The `downloadClientId` can be used to support this API endpoint in conjunction with Completed Download Handling, so Sonarr knows that a particular download has already been imported.
##### Parameters ######
Optional:
`path (string)`,
`downloadClientId (string)`
`path (string)`,
`downloadClientId (string)`
- nzoid for sabnzbd
- special 'drone' attribute value for nzbget
- uppercase infohash for torrents
@ -147,7 +149,7 @@ None
---
### RenameFiles ###
Instruct Sonarr to rename the list of files provided.
Instruct Sonarr to rename the list of files provided
##### Parameters ######