mirror of
https://github.com/Radarr/Radarr.git
synced 2024-10-03 22:57:18 +02:00
Updated API (markdown)
parent
c371484f09
commit
a6f350e802
8
API.md
8
API.md
@ -16,7 +16,7 @@ All requests made to the api endpoint require API Key authentication using the X
|
||||
## 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
|
||||
- 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
|
||||
|
||||
## Content Type ##
|
||||
@ -27,7 +27,7 @@ All requests made to the api endpoint require API Key authentication using the X
|
||||
## Endpoints ##
|
||||
|
||||
- API: V3
|
||||
|
||||
- https://radarr.video/docs/api/
|
||||
- API: V1
|
||||
- [Calendar](https://github.com/Radarr/Radarr/wiki/API:Calendar)
|
||||
- [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
|
||||
$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
|
||||
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
|
||||
```
|
Loading…
Reference in New Issue
Block a user