mirror of
https://github.com/Radarr/Radarr
synced 2024-12-22 07:52:34 +00:00
Added API doc
parent
d1e19bab5d
commit
512b722b08
1 changed files with 34 additions and 0 deletions
34
API.md
Normal file
34
API.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
## URL ##
|
||||
|
||||
All API endpoints are based off of `/api` if you access Radarr via `http://localhost:7878` the API root would be `http://localhost:7878/api`
|
||||
|
||||
|
||||
## Authentication ##
|
||||
|
||||
All requests made to the api endpoint require API Key authentication using the X-Api-Key header.
|
||||
|
||||
### API Key ###
|
||||
|
||||
- Can be accessed and reset via Settings -> General
|
||||
- Stored in Config.xml
|
||||
- alpha-numeric (lower case)
|
||||
|
||||
## Dates & Times ##
|
||||
|
||||
- All dates/timestamps are ISO-8601 formatted in UTC `2014-01-27T01:30:00Z`
|
||||
- Movies (and missing & calendar) also include the airdate in the original timezone for display purposes
|
||||
- Date parameters should be ISO-8601 UTC dates to ensure proper handling by Radarr
|
||||
|
||||
## Content Type ##
|
||||
|
||||
- All POST/PUT requests require all parameters to be JSON encoded in the body, unless otherwise noted.
|
||||
- All GET requests will return a JSON encoded response
|
||||
|
||||
## Endpoints ##
|
||||
|
||||
- Calendar
|
||||
- Command
|
||||
- Diskspace
|
||||
- History
|
||||
- Movies
|
||||
- System-Status
|
Loading…
Reference in a new issue