Mirrors/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr.git synced 2024-07-14 16:55:21 +02:00
Code Issues Releases Wiki Activity

Updated API (markdown)

nitsua 2020-09-10 00:04:47 -04:00
parent c371484f09
commit a6f350e802
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
API.md

@ -16,7 +16,7 @@ All requests made to the api endpoint require API Key authentication using the X
## Dates & Times ## ## Dates & Times ##
- All dates/timestamps are ISO-8601 formatted in UTC `2014-01-27T01:30:00Z` - 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 - Movies (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 - Date parameters should be ISO-8601 UTC dates to ensure proper handling by Radarr
## Content Type ## ## Content Type ##
@ -27,7 +27,7 @@ All requests made to the api endpoint require API Key authentication using the X
## Endpoints ## ## Endpoints ##
- API: V3 - API: V3
- https://radarr.video/docs/api/
- API: V1 - API: V1
- [Calendar](https://github.com/Radarr/Radarr/wiki/API:Calendar) - [Calendar](https://github.com/Radarr/Radarr/wiki/API:Calendar)
- [Command](https://github.com/Radarr/Radarr/wiki/API:Command) - [Command](https://github.com/Radarr/Radarr/wiki/API:Command)
@ -45,11 +45,11 @@ Example of post processing script to scan the disk for the movie
``` ```
$movie_id = $env:radarr_movie_id $movie_id = $env:radarr_movie_id
$params = @{"name"="RescanMovie";"movieId"="$movie_id";} | ConvertTo-Json $params = @{"name"="RescanMovie";"movieId"="$movie_id";} | ConvertTo-Json
Invoke-WebRequest -Uri http://RADARRIP:RADARRPORT/api/command?apikey=RADARRAPIKEY -Method POST -Body $params Invoke-WebRequest -Uri http://RADARR_IP:RADARR_PORT/api/command?apikey=RADARR_APIKEY -Method POST -Body $params
``` ```
### Curl on Linux ### Curl on Linux
Example of instructing Radarr to do a backlog search of your missing movies which are released. You can put this command in CRON to do it on a schedule. Example of instructing Radarr to do a backlog search of your missing movies which are released. You can put this command in CRON to do it on a schedule.
``` ```
curl -d '{name: "missingMoviesSearch", filterKey: "status", filterValue: "released"}' -H "Content-Type: application/json" -X POST http://RADARRIP:RADARRPORT/api/command?apikey=RADARRAPIKEY curl -d '{name: "missingMoviesSearch", filterKey: "status", filterValue: "released"}' -H "Content-Type: application/json" -X POST http://RADARR_IP:RADARR_PORT/api/command?apikey=RADARR_APIKEY
``` ```