From a6f350e8027a8fb6a25019328358c3fdd965f0f5 Mon Sep 17 00:00:00 2001 From: nitsua Date: Thu, 10 Sep 2020 00:04:47 -0400 Subject: [PATCH] Updated API (markdown) --- API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/API.md b/API.md index cb4e8b6..d2ee597 100644 --- a/API.md +++ b/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 ``` \ No newline at end of file