mirror
/
Radarr
mirror of https://github.com/Radarr/Radarr
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: API
Pages
API API:Calendar API:Command API:Diskspace API:History API:List Exclusions API:Movie Lookup API:Movie API:Queue API:System Status AppData Directory Autostart on Linux Backup and Restore Built In Qualities Clear Cache Cookies and Local Storage Command Line Options Common Problems Connections Create a Folder for Each Movie Custom Formats Aphrodite Custom Formats Examples Custom Formats Custom Post Processing Scripts Docker FAQ Health Checks Home How to Create a Folder for Each Movie How to make sure Radarr doesn't snatch full Blu Rays Import Plex Movie Database to Radarr Importing IMDb lists into TMDb Indexer Flags Installation Installing Multiple Instances of Radarr on Windows Mass Delete via API Minimum Availability New Profiles Release Branches Remote Path Mappings explained Reverse Proxy Running Multiple Instances on Windows Setup Guide Sorting and Renaming Supported DownloadClients Supported Indexers Supported NetImports Supported Notifications Twitter Notifications Useful Tools Users Guide Webhook Schema Webhook
13 API
nitsua edited this page 2020-09-10 00:04:47 -04:00
Table of Contents

URL

All API endpoints are based off of /api or /api/v3 if you access Radarr via http://localhost:7878 the API root would be http://localhost:7878/api for Radarr v0.2 or http://localhost:7878/api/v3 for Radarr 3

Authentication

All requests made to the api endpoint require API Key authentication using the X-Api-Key header or in the query string using ?apikey=APIKEY.

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 (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

Examples

Powershell

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://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://RADARR_IP:RADARR_PORT/api/command?apikey=RADARR_APIKEY

Getting Started

Troubleshooting

Additional Configuration

API