2020-07-25 04:39:10 +00:00
{
"openapi" : "3.0.0" ,
"info" : {
"title" : "Radarr" ,
2020-09-10 04:28:35 +00:00
"version" : "3.0.0" ,
"description" : "The way users should interact with Radarr programatically. To utilize any of these endpoints you will need a few pieces of information:\n\nex: localhost:7878/api/v3/movies?apiKey={key_here}\n\n* url: localhost, 10.1.0.1, 192.168.1.1, etc\n* port: 7878 (unless you modify it)\n* apiKey: Located in Settings > General > Security"
2020-07-25 04:39:10 +00:00
} ,
"servers" : [
{
"url" : "{protocol}://{hostPath}/api/v3" ,
"variables" : {
"protocol" : {
"enum" : [
"https" ,
"http"
] ,
"default" : "https"
} ,
"hostPath" : {
"default" : "localhost:7878" ,
"description" : "Your Radarr Server URL"
}
}
2020-09-10 04:28:35 +00:00
}
] ,
"paths" : {
"/movie" : {
"get" : {
"tags" : [
"Movie"
] ,
"summary" : "Get all movies" ,
"description" : "Returns all movies stored in the database" ,
"operationId" : "getMovie" ,
"parameters" : [
{
"in" : "query" ,
"name" : "tmdbId" ,
"schema" : {
"type" : "integer"
} ,
"required" : false ,
"description" : "TMDb id of the movie to get"
}
] ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
}
} ,
"400" : {
"description" : "Invalid ID supplied"
} ,
"401" : {
"description" : "Invalid API Key"
} ,
"404" : {
"description" : "Movie not found"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"post" : {
"tags" : [
"Movie"
] ,
"summary" : "Add new movie" ,
"requestBody" : {
"description" : "Movie object that needs to be added" ,
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "integer"
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
} ,
"405" : {
"description" : "Validation exception"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
] ,
"description" : "Adds a movie to the database"
} ,
"put" : {
"tags" : [
"Movie"
] ,
"summary" : "Edit existing movie" ,
"requestBody" : {
"description" : "Movie object that needs to be edited" ,
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
} ,
"parameters" : [
{
"in" : "query" ,
"name" : "movieFiles" ,
"schema" : {
"type" : "boolean"
} ,
"required" : false ,
"description" : "Have radarr move files when updating"
}
] ,
"responses" : {
"200" : {
"description" : "successful operation" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
} ,
"404" : {
"description" : "Movie not found"
} ,
"405" : {
"description" : "Validation exception"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
] ,
"description" : "Updates a movie in the database"
}
} ,
"/movie/{id}" : {
"get" : {
"tags" : [
"Movie"
] ,
"summary" : "Get movie by database id" ,
"description" : "Returns a single movie" ,
"operationId" : "getMovieById" ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"description" : "Database Id of movie to return" ,
"required" : true ,
"schema" : {
"type" : "integer"
}
}
] ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
} ,
"400" : {
"description" : "Invalid ID supplied"
} ,
"401" : {
"description" : "Invalid API Key"
} ,
"404" : {
"description" : "Movie not found"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"delete" : {
"tags" : [
"Movie"
] ,
"summary" : "Delete movie" ,
"description" : "" ,
"operationId" : "deleteMovie" ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"description" : "Database Id of movie to delete" ,
"required" : true ,
"schema" : {
"type" : "integer"
}
} ,
{
"name" : "addImportExclusion" ,
"in" : "query" ,
"description" : "Add deleted movies to List Exclusions" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "deleteFiles" ,
"in" : "query" ,
"description" : "Delete movie files when deleting movies" ,
"schema" : {
"type" : "boolean"
}
}
] ,
"responses" : {
"400" : {
"description" : "Invalid ID supplied"
} ,
"401" : {
"description" : "Invalid API Key"
} ,
"404" : {
"description" : "Movie not found"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
]
}
} ,
"/tag/detail/{id}" : {
"get" : {
"tags" : [
"Tag"
] ,
"summary" : "Return usage details for a given tag id" ,
"description" : "Returns the id of all items in the database which use the specified tag" ,
"operationId" : "" ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TagDetail"
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"description" : "Database id of tag" ,
"required" : true ,
"schema" : {
"type" : "integer"
}
}
]
} ,
"/tag/detail" : {
"get" : {
"tags" : [
"Tag"
] ,
"summary" : "Return usage details for all tags in database" ,
"description" : "Returns a list of tag detail objects for all tags in the database." ,
"operationId" : "" ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/TagDetail"
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"parameters" : [ ]
} ,
"/tag/{id}" : {
"get" : {
"tags" : [
"Tag"
] ,
"summary" : "Get tag by database id" ,
"description" : "Return a given tag and its label by the database id." ,
"operationId" : "" ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"delete" : {
"tags" : [
"Tag"
] ,
"summary" : "Delete tag by database id" ,
"description" : "Delete a tag" ,
"operationId" : "" ,
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
]
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"description" : "ID of tag" ,
"required" : true ,
"schema" : {
"type" : "integer"
}
}
]
} ,
"/tag" : {
"get" : {
"summary" : "Get all tags" ,
"description" : "Get all tags in the database" ,
"operationId" : "" ,
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
] ,
"tags" : [
"Tag"
2020-09-10 04:28:35 +00:00
]
} ,
"put" : {
"tags" : [
"Tag"
] ,
"summary" : "Update tag" ,
"description" : "Update a tags label." ,
"operationId" : "" ,
"requestBody" : {
"description" : "Tag object that needs to be updated" ,
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
]
} ,
"post" : {
"tags" : [
"Tag"
] ,
"summary" : "Create a new tag" ,
"description" : "Create a new tag that can be assigned to a movie, list, delay profile, notification, or restriction" ,
"operationId" : "" ,
"requestBody" : {
"description" : "Tag object that needs to be added" ,
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
}
]
} ,
"parameters" : [ ]
} ,
"/diskspace" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get system diskspace information" ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"items" : {
"type" : "object"
2020-09-10 04:28:35 +00:00
}
} ,
"examples" : {
"Response" : {
"value" : [
{
"path" : "D:\\" ,
"label" : "DrivePool" ,
"freeSpace" : 16187217043456 ,
"totalSpace" : 56009755148288
} ,
{
"path" : "C:\\" ,
"label" : "Windows" ,
"freeSpace" : 78659211264 ,
"totalSpace" : 239409819648
}
]
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-diskspace" ,
"description" : "Query Radarr for disk usage information\n\nLocation: System > Status" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
] ,
"tags" : [
"Disk Space"
2020-09-10 04:28:35 +00:00
]
}
} ,
"/status" : {
"get" : {
"summary" : "Get internal information" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Status"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"version" : {
"type" : "string"
} ,
"buildTime" : {
"type" : "string"
} ,
"isDebug" : {
"type" : "boolean"
} ,
"isProduction" : {
"type" : "boolean"
} ,
"isAdmin" : {
"type" : "boolean"
} ,
"isUserInteractive" : {
"type" : "boolean"
} ,
"startupPath" : {
"type" : "string"
} ,
"appData" : {
"type" : "string"
} ,
"osName" : {
"type" : "string"
} ,
"osVersion" : {
"type" : "string"
} ,
"isNetCore" : {
"type" : "boolean"
} ,
"isMono" : {
"type" : "boolean"
} ,
"isLinux" : {
"type" : "boolean"
} ,
"isOsx" : {
"type" : "boolean"
} ,
"isWindows" : {
"type" : "boolean"
} ,
"isDocker" : {
"type" : "boolean"
} ,
"mode" : {
"type" : "string"
} ,
"branch" : {
"type" : "string"
} ,
"authentication" : {
"type" : "string"
} ,
"sqliteVersion" : {
"type" : "string"
} ,
"migrationVersion" : {
"type" : "integer"
} ,
"urlBase" : {
"type" : "string"
} ,
"runtimeVersion" : {
"type" : "string"
} ,
"runtimeName" : {
"type" : "string"
} ,
"startTime" : {
"type" : "string"
} ,
"packageUpdateMechanism" : {
"type" : "string"
}
}
} ,
"examples" : {
"Response" : {
"value" : {
"version" : "10.0.0.34882" ,
"buildTime" : "2020-09-01T23:23:23.9621974Z" ,
"isDebug" : true ,
"isProduction" : false ,
"isAdmin" : false ,
"isUserInteractive" : true ,
"startupPath" : "C:\\ProgramData\\Radarr" ,
"appData" : "C:\\ProgramData\\Radarr" ,
"osName" : "Windows" ,
"osVersion" : "10.0.18363.0" ,
"isNetCore" : true ,
"isMono" : false ,
"isLinux" : false ,
"isOsx" : false ,
"isWindows" : true ,
"isDocker" : false ,
"mode" : "console" ,
2020-09-27 02:03:14 +00:00
"branch" : "nightly" ,
2020-09-10 04:28:35 +00:00
"authentication" : "none" ,
"sqliteVersion" : "3.32.1" ,
"migrationVersion" : 180 ,
"urlBase" : "" ,
2020-11-12 03:33:32 +00:00
"runtimeVersion" : "3.1.10" ,
2020-09-10 04:28:35 +00:00
"runtimeName" : "netCore" ,
"startTime" : "2020-09-01T23:50:20.2415965Z" ,
"packageUpdateMechanism" : "builtIn"
}
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-status" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
] ,
"description" : "Find out information such as OS, version, paths used, etc" ,
"parameters" : [ ]
}
} ,
"/health" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's health information" ,
"tags" : [
"Health"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"items" : {
"type" : "object"
2020-09-10 04:28:35 +00:00
}
} ,
"examples" : {
"Response" : {
"value" : [
{
"source" : "ImportMechanismCheck" ,
"type" : "warning" ,
"message" : "Enable Completed Download Handling" ,
2020-11-12 22:54:27 +00:00
"wikiUrl" : "https://wiki.servarr.com/Radarr_System#Completed.2FFailed_Download_Handling"
2020-09-10 04:28:35 +00:00
} ,
{
"source" : "DownloadClientCheck" ,
"type" : "error" ,
"message" : "Unable to communicate with qBittorrent. Failed to connect to qBittorrent, check your settings." ,
2020-11-12 22:54:27 +00:00
"wikiUrl" : "https://wiki.servarr.com/Radarr_System#Download_Clients"
2020-09-10 04:28:35 +00:00
}
]
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-health" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
] ,
"description" : "Query radarr for health information\n\nLocation: System > Status"
}
} ,
"/command" : {
"post" : {
"summary" : "command" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Command"
] ,
2020-09-10 04:28:35 +00:00
"operationId" : "post-command" ,
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"201" : {
"description" : "" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
}
} ,
"required" : [
"name"
]
} ,
"examples" : {
"Example" : {
"value" : {
"name" : "Backup"
}
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"description" : "Pushes commands to Radarr using a key:value pair. The main key is \"name\" and below are acceptable values but it can also accept other key:value pairs (listed under each command):\n\n* ApplicationUpdate - Trigger an update of Radarr\n* Backup - Trigger a backup routine\n* CheckHealth - Trigger a system health check\n* ClearBlacklist - Triggers the removal of all blacklisted movies\n* CleanUpRecycleBin - Trigger a recycle bin cleanup check\n* DeleteLogFiles - Triggers the removal of all Info/Debug/Trace log files\n* DeleteUpdateLogFiles - Triggers the removal of all Update log files\n* DownloadedMoviesScan - Triggers the scan of downloaded movies\n* MissingMoviesSearch - Triggers a search of all missing movies\n* RefreshMonitoredDownloads - Triggers the scan of monitored downloads\n* RefreshMovie - Trigger a refresh / scan of library\n * movieIds:int[] - Specify a list of ids (comma separated) for individual movies to refresh" ,
"security" : [
{
"X-API-Key" : [ ]
}
] ,
"parameters" : [ ]
}
} ,
"/update" : {
"get" : {
"summary" : "List of recent updates" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Update"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"version" : {
"type" : "string"
} ,
"branch" : {
"type" : "string"
} ,
"releaseDate" : {
"type" : "string"
} ,
"fileName" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
} ,
"installed" : {
"type" : "boolean"
} ,
"installable" : {
"type" : "boolean"
} ,
"latest" : {
"type" : "boolean"
} ,
"changes" : {
2020-11-22 07:50:38 +00:00
"type" : "object" ,
"properties" : {
"new" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"fixed" : {
"type" : "array" ,
"items" : {
"type" : "string"
2020-09-10 04:28:35 +00:00
}
}
}
} ,
"hash" : {
"type" : "string"
}
}
} ,
"examples" : {
"Example" : {
"value" : {
"version" : "3.0.0.3553" ,
2020-09-27 02:03:14 +00:00
"branch" : "nightly" ,
2020-09-10 04:28:35 +00:00
"releaseDate" : "2020-09-02T05:36:13.047313Z" ,
2020-09-27 02:03:14 +00:00
"fileName" : "Radarr.nightly.3.0.0.3553.windows-core-x64.zip" ,
2020-09-10 04:28:35 +00:00
"url" : "https://dev.azure.com/Radarr/Radarr/_apis/build/builds/1896/artifacts?artifactName=Packages&fileId=A710686A9CB6848E73C3DDCA5F2B0D83C6189546E66DD3EF2D0D30B20735F6E802&fileName=Radarr.aphrodite.3.0.0.3553.windows-core-x64.zip&api-version=5.1" ,
"installed" : false ,
"installable" : false ,
"latest" : false ,
"changes" : {
"new" : [ ] ,
"fixed" : [
"Importing completed downloads from NZBGet with post processing script failing" ,
"Importing of completed download when not a child of the download client output path" ,
"Getting parent of UNC paths"
]
} ,
"hash" : "a95c855cbc3ee253fd0b74181e866106daffc7b71b4a9e2d57cfbeede4333aee"
}
}
}
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-update" ,
"description" : "Will return a list of recent updates to Radarr\n\nLocation: System > Updates" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
}
} ,
"/qualityProfile" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's quality profiles" ,
"tags" : [
"Quality"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful response" ,
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/QualityProfile"
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"examples" : { }
2020-09-10 04:28:35 +00:00
}
}
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-add-discover" ,
"description" : "Query Radarr for quality profiles " ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
} ,
"parameters" : [ ]
} ,
"/calendar" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's calendar events" ,
"tags" : [
"Calendar"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-calendar" ,
"description" : "Get a list of movies based on calendar parameters" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
] ,
"parameters" : [
{
"schema" : {
"type" : "boolean"
} ,
"in" : "query" ,
"name" : "unmonitored" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "start" ,
"description" : "ISO 8601" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "end" ,
"description" : "ISO 8601" ,
"required" : true
}
]
}
} ,
"/queue" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's queue items" ,
"tags" : [
"Queue"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request"
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-queue" ,
"description" : "Return a json object list of items in the queue" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
] ,
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "page" ,
"description" : "1" ,
"required" : true
} ,
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "pageSize" ,
"description" : "20" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "sortDirection" ,
"description" : "ascending" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "sortKey" ,
"description" : "timeLeft" ,
"required" : true
} ,
{
"schema" : {
"type" : "boolean"
} ,
"in" : "query" ,
"name" : "includeUnknownMovieItems" ,
"description" : "true" ,
"required" : true
}
]
}
} ,
"/history" : {
2020-07-25 04:39:10 +00:00
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's history items" ,
2020-07-25 04:39:10 +00:00
"responses" : {
"200" : {
2020-09-10 04:28:35 +00:00
"description" : "Successful request" ,
2020-07-25 04:59:00 +00:00
"content" : {
"application/json" : {
"schema" : {
2020-09-10 04:28:35 +00:00
"type" : "object" ,
"properties" : {
"page" : {
"type" : "integer"
} ,
"pageSize" : {
"type" : "integer"
} ,
"sortDirection" : {
"type" : "string"
} ,
"totalRecords" : {
"type" : "integer"
} ,
"records" : {
"type" : "array" ,
"items" : {
2020-11-22 07:50:38 +00:00
"$ref" : "#/components/schemas/History"
2020-09-10 04:28:35 +00:00
}
}
}
} ,
2020-11-22 07:50:38 +00:00
"examples" : { }
2020-07-25 04:59:00 +00:00
}
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-history" ,
"description" : "Return a json object list of items in your history" ,
2020-07-25 04:39:10 +00:00
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-07-25 04:39:10 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-07-25 04:39:10 +00:00
}
] ,
2020-09-10 04:28:35 +00:00
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "page" ,
"description" : "1" ,
"required" : true
} ,
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "pageSize" ,
"description" : "20" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "sortDirection" ,
"description" : "descending" ,
"required" : true
} ,
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "sortKey" ,
"description" : "date" ,
"required" : true
}
2020-11-22 07:50:38 +00:00
] ,
"tags" : [
"History"
2020-09-10 04:28:35 +00:00
]
}
} ,
"/customFilter" : {
"get" : {
2020-10-03 13:25:35 +00:00
"summary" : "Get Radarr's custom filters" ,
"tags" : [
"Custom Filters"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful response" ,
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"description" : "" ,
"minItems" : 1 ,
"uniqueItems" : true ,
"items" : {
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"minLength" : 1
} ,
"label" : {
"type" : "string" ,
"minLength" : 1
} ,
"filters" : {
"type" : "array" ,
"uniqueItems" : true ,
"minItems" : 1 ,
"items" : {
"type" : "object" ,
"properties" : {
"key" : {
"type" : "string" ,
"minLength" : 1
} ,
"value" : {
"type" : "array" ,
"items" : {
"type" : [
"string" ,
"number"
]
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"type" : {
"type" : "string"
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"required" : [
"key" ,
"type"
]
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"id" : {
"type" : "integer"
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"type" ,
"label" ,
"filters" ,
"id"
]
2020-09-10 04:28:35 +00:00
}
} ,
"examples" : {
"Example" : {
"value" : [
{
"type" : "movieIndex" ,
2020-11-22 07:50:38 +00:00
"label" : "Rated G" ,
2020-09-10 04:28:35 +00:00
"filters" : [
{
2020-11-22 07:50:38 +00:00
"key" : "certification" ,
"value" : [
"G"
] ,
"type" : "equal"
2020-09-10 04:28:35 +00:00
}
] ,
2020-11-22 07:50:38 +00:00
"id" : 10
2020-09-10 04:28:35 +00:00
}
]
}
}
2020-07-25 04:59:00 +00:00
}
2020-07-25 04:39:10 +00:00
}
2020-09-10 04:28:35 +00:00
} ,
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
2020-07-25 04:59:00 +00:00
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-customFilter" ,
"description" : "Query Radarr for custom filters" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
}
} ,
2020-11-22 07:50:38 +00:00
"/importlist" : {
2020-09-10 04:28:35 +00:00
"get" : {
"summary" : "Get import list information" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Import"
] ,
2020-07-25 04:39:10 +00:00
"responses" : {
"200" : {
2020-11-22 07:50:38 +00:00
"description" : "Successful response" ,
2020-07-25 04:59:00 +00:00
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ImportList"
2020-09-10 04:28:35 +00:00
}
} ,
"examples" : {
"Example" : {
"value" : [
{
"enabled" : true ,
"enableAuto" : true ,
"shouldMonitor" : true ,
"rootFolderPath" : "D:\\Plex\\Movies\\" ,
"qualityProfileId" : 4 ,
"searchOnAdd" : false ,
"minimumAvailability" : "announced" ,
"listType" : "other" ,
"listOrder" : 3 ,
"name" : "IMDb List" ,
"fields" : [
{
"order" : 0 ,
"name" : "listId" ,
"label" : "List/User ID" ,
"helpText" : "IMDb list ID (e.g ls12345678), IMDb user ID (e.g. ur12345678), 'top250' or 'popular'" ,
"value" : "ur109135197" ,
"type" : "textbox" ,
"advanced" : false
}
] ,
"implementationName" : "IMDb Lists" ,
"implementation" : "IMDbListImport" ,
"configContract" : "IMDbListSettings" ,
2020-11-12 22:54:27 +00:00
"infoLink" : "https://wiki.servarr.com/Radarr_Settings#Lists" ,
2020-09-10 04:28:35 +00:00
"tags" : [
2
] ,
"id" : 1
}
]
}
2020-07-25 04:59:00 +00:00
}
}
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-importList" ,
"description" : "Query Radarr for all lists" ,
2020-07-25 04:39:10 +00:00
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-07-25 04:39:10 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-07-25 04:39:10 +00:00
}
]
2020-11-22 07:50:38 +00:00
} ,
"parameters" : [ ]
2020-09-10 04:28:35 +00:00
} ,
"/ui" : {
"get" : {
"summary" : "Get UI settings" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"UI"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"firstDayOfWeek" : {
"type" : "integer"
} ,
"calendarWeekColumnHeader" : {
"type" : "string"
} ,
"movieRuntimeFormat" : {
"type" : "string"
} ,
"shortDateFormat" : {
"type" : "string"
} ,
"longDateFormat" : {
"type" : "string"
} ,
"timeFormat" : {
"type" : "string"
} ,
"showRelativeDates" : {
"type" : "boolean"
} ,
"enableColorImpairedMode" : {
"type" : "boolean"
} ,
"movieInfoLanguage" : {
"type" : "integer"
} ,
"id" : {
"type" : "integer"
}
}
} ,
"examples" : {
"Example" : {
"value" : {
"firstDayOfWeek" : 0 ,
"calendarWeekColumnHeader" : "ddd M/D" ,
"movieRuntimeFormat" : "hoursMinutes" ,
"shortDateFormat" : "MMM D YYYY" ,
"longDateFormat" : "dddd, MMMM D YYYY" ,
"timeFormat" : "h(:mm)a" ,
"showRelativeDates" : true ,
"enableColorImpairedMode" : false ,
"movieInfoLanguage" : 1 ,
"id" : 1
}
}
}
2020-07-25 04:59:00 +00:00
}
2020-07-25 04:39:10 +00:00
}
2020-09-10 04:28:35 +00:00
} ,
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
2020-07-25 04:59:00 +00:00
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-ui" ,
"description" : "Query Radarr for UI settings" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-09-10 04:28:35 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-09-10 04:28:35 +00:00
}
]
}
} ,
"/remotePathMapping" : {
"get" : {
"summary" : "Get Radarr's remote path mappings" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Remote Path Mapping"
] ,
2020-07-25 04:39:10 +00:00
"responses" : {
"200" : {
2020-09-10 04:28:35 +00:00
"description" : "Successful request" ,
2020-07-25 04:59:00 +00:00
"content" : {
"application/json" : {
"schema" : {
2020-11-22 07:50:38 +00:00
"type" : "array" ,
"description" : "" ,
"minItems" : 1 ,
"uniqueItems" : true ,
"items" : {
"type" : "object" ,
"properties" : {
"host" : {
"type" : "string" ,
"minLength" : 1
} ,
"remotePath" : {
"type" : "string" ,
"minLength" : 1
} ,
"localPath" : {
"type" : "string" ,
"minLength" : 1
} ,
"id" : {
"type" : "integer"
}
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"host" ,
"remotePath" ,
"localPath" ,
"id"
]
2020-09-10 04:28:35 +00:00
}
} ,
"examples" : {
"Example" : {
"value" : [
{
"host" : "localhost" ,
"remotePath" : "B:\\" ,
"localPath" : "A:\\Movies\\" ,
"id" : 1
} ,
{
"host" : "localhost" ,
"remotePath" : "C:\\" ,
"localPath" : "A:\\Movies\\" ,
"id" : 2
}
]
}
2020-07-25 04:59:00 +00:00
}
}
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-remotePathMapping" ,
"description" : "Get a list of remote paths being mapped and used by Radarr" ,
2020-07-25 04:39:10 +00:00
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-07-25 04:39:10 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-07-25 04:39:10 +00:00
}
]
}
} ,
2020-11-22 07:50:38 +00:00
"/downloadclient" : {
2020-07-25 04:39:10 +00:00
"get" : {
2020-09-10 04:28:35 +00:00
"summary" : "Get Radarr's download client list" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Download Client"
] ,
2020-09-10 04:28:35 +00:00
"responses" : {
"200" : {
2020-11-22 07:50:38 +00:00
"description" : "Successful request" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/DownloadClient"
}
}
}
}
2020-09-10 04:28:35 +00:00
} ,
"401" : {
"description" : "Invalid API Key"
}
} ,
"operationId" : "get-downloadClient" ,
"description" : "Get a list of all the download clients added in Radarr" ,
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-07-25 04:39:10 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-07-25 04:39:10 +00:00
}
2020-09-10 04:28:35 +00:00
]
2020-11-22 07:50:38 +00:00
} ,
"parameters" : [ ]
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"/blacklist" : {
2020-09-10 04:28:35 +00:00
"get" : {
"summary" : "Get Radarr's blacklisted movies" ,
2020-10-03 13:25:35 +00:00
"tags" : [
"Blacklist"
] ,
2020-07-25 04:39:10 +00:00
"responses" : {
"200" : {
2020-09-10 04:28:35 +00:00
"description" : "Invalid API Key" ,
2020-07-25 04:59:00 +00:00
"content" : {
"application/json" : {
"schema" : {
2020-09-10 04:28:35 +00:00
"type" : "object" ,
"properties" : {
"page" : {
"type" : "integer" ,
"description" : "1"
} ,
"pageSize" : {
"type" : "integer" ,
"description" : "20"
} ,
"sortDirection" : {
"type" : "string" ,
"description" : "descending"
} ,
"sortKey" : {
"type" : "string" ,
"description" : "date"
} ,
"totalRecords" : {
"type" : "integer"
} ,
"records" : {
"type" : "array" ,
"items" : {
2020-11-22 07:50:38 +00:00
"$ref" : "#/components/schemas/Blacklist"
2020-09-10 04:28:35 +00:00
}
}
} ,
"required" : [
"page" ,
"pageSize" ,
"sortDirection" ,
"sortKey"
]
2020-07-25 04:59:00 +00:00
}
}
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
} ,
2020-09-10 04:28:35 +00:00
"operationId" : "get-blackList" ,
2020-11-22 07:50:38 +00:00
"description" : "Returns blacklisted releases" ,
2020-07-25 04:39:10 +00:00
"security" : [
2020-10-03 13:25:35 +00:00
{
"X-API-Key" : [ ]
} ,
2020-07-25 04:39:10 +00:00
{
2020-11-22 07:50:38 +00:00
"apikey" : [ ]
2020-07-25 04:39:10 +00:00
}
] ,
"parameters" : [
{
2020-07-25 04:59:00 +00:00
"schema" : {
"type" : "integer"
2020-09-10 04:28:35 +00:00
} ,
"in" : "query" ,
"name" : "page" ,
"description" : "1" ,
"required" : true
2020-07-25 04:39:10 +00:00
} ,
{
2020-07-25 04:59:00 +00:00
"schema" : {
2020-09-10 04:28:35 +00:00
"type" : "integer"
} ,
"in" : "query" ,
"name" : "pageSize" ,
"description" : "20" ,
"required" : true
2020-07-25 04:39:10 +00:00
} ,
{
2020-09-10 04:28:35 +00:00
"schema" : {
"type" : "string"
} ,
2020-07-25 04:39:10 +00:00
"in" : "query" ,
2020-09-10 04:28:35 +00:00
"name" : "sortDirection" ,
"description" : "descending" ,
"required" : true
} ,
{
2020-07-25 04:59:00 +00:00
"schema" : {
2020-09-10 04:28:35 +00:00
"type" : "string"
} ,
"in" : "query" ,
"name" : "sortKey" ,
"description" : "date" ,
"required" : true
2020-07-25 04:39:10 +00:00
}
2020-09-10 04:28:35 +00:00
]
} ,
"delete" : {
"summary" : "Remove a blacklisted movie" ,
"operationId" : "delete-blackList" ,
2020-07-25 04:39:10 +00:00
"responses" : {
2020-09-10 04:28:35 +00:00
"200" : {
"description" : "Successful request"
2020-07-25 04:39:10 +00:00
} ,
2020-09-10 04:28:35 +00:00
"401" : {
"description" : "Invalid API Key"
2020-07-25 04:39:10 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"description" : "Removes a specific release (the id provided) from the blacklist" ,
2020-07-25 04:39:10 +00:00
"security" : [
{
2020-10-03 13:25:35 +00:00
"X-API-Key" : [ ]
2020-09-10 04:28:35 +00:00
}
] ,
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "id" ,
"required" : true
2020-07-25 04:39:10 +00:00
}
2020-11-22 07:50:38 +00:00
] ,
"tags" : [
"Blacklist"
2020-07-25 04:39:10 +00:00
]
2020-09-10 04:28:35 +00:00
} ,
"parameters" : [ ]
2020-11-22 07:50:38 +00:00
} ,
"/blacklist/movie" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [
"Blacklist"
2020-07-25 04:59:00 +00:00
] ,
2020-11-22 07:50:38 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Blacklist"
}
}
}
}
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-blacklist-movie" ,
"description" : "Retrieves blacklisted releases that are tied to a given movie in the database" ,
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "movieId" ,
"description" : "Database Id for the movie " ,
"required" : true
}
] ,
"security" : [
{
"X-API-Key" : [ ]
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
{
"apikey" : [ ]
}
]
}
} ,
"/blacklist/bulk" : {
"delete" : {
"summary" : "" ,
"operationId" : "delete-blacklist-bulk" ,
"responses" : {
"200" : {
"description" : "OK"
}
} ,
"description" : "Delete blacklisted releases in bulk" ,
"security" : [
{
"X-API-Key" : [ ]
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"ids" : {
"type" : "array" ,
"description" : "Database ids of the blacklist items to delete" ,
"items" : {
"type" : "integer"
}
}
} ,
"required" : [
"ids"
]
} ,
"examples" : { }
}
}
} ,
"tags" : [
"Blacklist"
]
}
} ,
"/indexer" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [
"Indexer"
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"description" : "" ,
"minItems" : 1 ,
"uniqueItems" : true ,
"items" : {
"$ref" : "#/components/schemas/Indexer"
}
}
}
2020-07-25 04:59:00 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"401" : {
"description" : "Unauthorized" ,
"content" : {
"application/json" : {
"schema" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"error" : {
"type" : "string" ,
"minLength" : 1
}
} ,
"required" : [
"error"
]
}
}
}
}
} ,
"operationId" : "get-indexer" ,
"security" : [
{
"X-API-Key" : [ ]
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
{
"apikey" : [ ]
}
] ,
"description" : "Get all indexers"
}
} ,
"/indexer/{id}" : {
"parameters" : [
{
"schema" : {
2020-07-25 04:59:00 +00:00
"type" : "integer"
} ,
2020-11-22 07:50:38 +00:00
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"description" : "Database Id of the indexer"
}
] ,
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [
"Indexer"
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Indexer"
}
}
}
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-indexer-id" ,
"description" : "Get Indexer by its database Id" ,
"parameters" : [ ] ,
"security" : [
{
"X-API-Key" : [ ]
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
{
"apikey" : [ ]
}
]
} ,
"put" : {
"summary" : "" ,
"operationId" : "put-indexer-id" ,
"responses" : {
"200" : {
"description" : "OK"
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"401" : {
"description" : "Unauthorized"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
{
"apikey" : [ ]
}
] ,
"tags" : [
"Indexer"
]
} ,
"delete" : {
"summary" : "" ,
"operationId" : "delete-indexer-id" ,
"responses" : {
"200" : {
"description" : "OK"
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"401" : {
"description" : "Unauthorized"
}
} ,
"description" : "Delete Indexer by database id" ,
"security" : [
{
"X-API-Key" : [ ]
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
{
"apikey" : [ ]
}
] ,
"tags" : [
"Indexer"
]
}
} ,
"/downloadclient/{id}" : {
"parameters" : [
{
"schema" : {
2020-07-25 04:59:00 +00:00
"type" : "integer"
} ,
2020-11-22 07:50:38 +00:00
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"description" : "Database id of the download client"
}
] ,
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [
"Download Client"
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadClient"
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-downloadclient-id" ,
"description" : "Get a single download client by database id" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
]
} ,
"delete" : {
"summary" : "" ,
"operationId" : "delete-downloadclient-id" ,
"responses" : {
"200" : {
"description" : "OK"
}
} ,
"description" : "Delete a download client by database id" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"tags" : [
"Download Client"
]
} ,
"put" : {
"summary" : "" ,
"operationId" : "put-downloadclient-id" ,
"responses" : {
"200" : {
"description" : "OK"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"description" : "Edit a downloadclient by database id" ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadClient"
}
}
} ,
"description" : ""
} ,
"tags" : [
"Download Client"
]
}
} ,
"/notification" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [ ] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Notification"
}
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-notifications" ,
"description" : "Get all notifications" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
]
} ,
"parameters" : [ ]
} ,
"/notification/{id}" : {
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"description" : "Database id of notification"
}
] ,
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [
"Notification"
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Notification"
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-notification-id" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"description" : "Get Notification by database id"
} ,
"delete" : {
"summary" : "" ,
"operationId" : "delete-notification-id" ,
"responses" : {
"200" : {
"description" : "OK"
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"description" : "Delete Notification by database id" ,
"tags" : [
"Notification"
]
} ,
"put" : {
"summary" : "" ,
"operationId" : "put-notification-id" ,
"responses" : {
"200" : {
"description" : "OK"
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Notification"
}
}
}
} ,
"description" : "Edit Notification by database id" ,
"tags" : [
"Notification"
]
}
} ,
"/metadata" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [ ] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-metadata" ,
"description" : "Get all metadata consumer settings" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
]
}
} ,
"/movie/lookup" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [ ] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Movie"
}
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-movie-lookup" ,
"description" : "Search for a movie to add to the database (Uses TMDB for search results)" ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
] ,
"parameters" : [
{
"schema" : {
"type" : "string"
} ,
"in" : "query" ,
"name" : "term" ,
"description" : "search term to use for lookup" ,
"required" : true
}
]
}
} ,
"/history/movie" : {
"get" : {
"summary" : "Your GET endpoint" ,
"tags" : [ ] ,
"responses" : {
"200" : {
"description" : "OK" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/History"
}
}
}
}
} ,
"401" : {
"description" : "Unauthorized"
}
} ,
"operationId" : "get-history-movie" ,
"description" : "Get history for a given movie in database by its database id" ,
"parameters" : [
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "movieId" ,
"description" : "database id of movie" ,
"required" : true
} ,
{
"schema" : {
"type" : "integer"
} ,
"in" : "query" ,
"name" : "eventType" ,
"description" : "history event type to retrieve"
}
] ,
"security" : [
{
"X-API-Key" : [ ]
} ,
{
"apikey" : [ ]
}
]
}
}
} ,
"components" : {
"schemas" : {
"Movie" : {
"type" : "object" ,
"required" : [
"title"
] ,
"properties" : {
"id" : {
"type" : "integer" ,
"format" : "int64"
} ,
"title" : {
"type" : "string" ,
"example" : "Dark Phoenix"
} ,
"sortTitle" : {
"type" : "string" ,
"example" : "dark phoenix"
} ,
"sizeOnDisk" : {
"type" : "number"
} ,
"overview" : {
"type" : "string"
} ,
"inCinemas" : {
"type" : "string"
} ,
"physicalRelease" : {
"type" : "string"
} ,
"images" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Image"
}
} ,
"website" : {
"type" : "string" ,
"example" : "http://darkphoenix.com"
} ,
"year" : {
"type" : "integer"
} ,
"hasFile" : {
"type" : "boolean"
} ,
"youTubeTrailerId" : {
"type" : "string"
} ,
"studio" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"qualityProfileId" : {
"type" : "integer"
} ,
"monitored" : {
"type" : "boolean"
} ,
"minimumAcailability" : {
"type" : "string" ,
"enum" : [
"announced" ,
"inCinema" ,
"released"
]
} ,
"isAvailable" : {
"type" : "boolean"
} ,
"folderName" : {
"type" : "string"
} ,
"runtime" : {
"type" : "integer"
} ,
"cleanTitle" : {
"type" : "string"
} ,
"imdbId" : {
"type" : "string"
} ,
"tmdbId" : {
"type" : "integer"
} ,
"titleSlug" : {
"type" : "integer"
} ,
"certification" : {
"type" : "string"
} ,
"genres" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"added" : {
"type" : "string"
} ,
"ratings" : {
"$ref" : "#/components/schemas/Rating"
} ,
"collection" : {
"$ref" : "#/components/schemas/Collection"
} ,
"status" : {
"type" : "string" ,
"description" : "movie status" ,
"enum" : [
"deleted" ,
"tba" ,
"announced" ,
"inCinema" ,
"released"
]
}
} ,
"xml" : {
"name" : "Movie"
}
} ,
"Image" : {
"type" : "object" ,
"properties" : {
"coverType" : {
"type" : "string" ,
"enum" : [
"poster" ,
"fanart"
]
} ,
"url" : {
"type" : "string"
}
} ,
"xml" : {
"name" : "Image"
}
} ,
"Collection" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
} ,
"tmdbId" : {
"type" : "integer"
} ,
"images" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Image"
}
}
} ,
"xml" : {
"name" : "Collection"
}
} ,
"Rating" : {
"type" : "object" ,
"properties" : {
"votes" : {
"type" : "integer"
} ,
"value" : {
"type" : "integer"
}
} ,
"xml" : {
"name" : "Rating"
}
} ,
"Tag" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "integer"
} ,
"label" : {
"type" : "string"
}
}
} ,
"TagDetail" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "integer"
} ,
"label" : {
"type" : "string"
} ,
"delayProfileIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"notificationIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"restrictionIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"netImportIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"movieIds" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
}
}
} ,
"Indexer" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"enableRss" : {
"type" : "boolean"
} ,
"enableAutomaticSearch" : {
"type" : "boolean"
} ,
"enableInteractiveSearch" : {
"type" : "boolean"
} ,
"supportsRss" : {
"type" : "boolean"
} ,
"supportsSearch" : {
"type" : "boolean"
} ,
"protocol" : {
"type" : "string" ,
"minLength" : 1
} ,
"priority" : {
"type" : "integer" ,
"minimum" : 0 ,
"maximum" : 50
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProviderField"
}
} ,
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"configContract" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "object"
}
} ,
"id" : {
"type" : "number"
}
} ,
"required" : [
"enableRss" ,
"enableAutomaticSearch" ,
"enableInteractiveSearch" ,
"supportsRss" ,
"supportsSearch" ,
"protocol" ,
"priority" ,
"name" ,
"fields" ,
"implementationName" ,
"implementation" ,
"configContract" ,
"infoLink" ,
"tags" ,
"id"
]
} ,
"DownloadClient" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"enable" : {
"type" : "boolean"
} ,
"protocol" : {
"type" : "string" ,
"minLength" : 1
} ,
"priority" : {
"type" : "integer" ,
"minimum" : 0 ,
"maximum" : 50
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProviderField"
}
} ,
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"configContract" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"id" : {
"type" : "integer"
}
} ,
"required" : [
"enable" ,
"protocol" ,
"priority" ,
"name" ,
"fields" ,
"implementationName" ,
"implementation" ,
"configContract" ,
"infoLink" ,
"tags" ,
"id"
]
} ,
"Notification" : {
"description" : "" ,
"type" : "object" ,
"title" : "" ,
"properties" : {
"onGrab" : {
"type" : "boolean"
} ,
"onDownload" : {
"type" : "boolean"
} ,
"onUpgrade" : {
"type" : "boolean"
} ,
"onRename" : {
"type" : "boolean"
} ,
"onDelete" : {
"type" : "boolean"
} ,
"onHealthIssue" : {
"type" : "boolean"
} ,
"supportsOnGrab" : {
"type" : "boolean"
} ,
"supportsOnDownload" : {
"type" : "boolean"
} ,
"supportsOnUpgrade" : {
"type" : "boolean"
} ,
"supportsOnRename" : {
"type" : "boolean"
} ,
"supportsOnDelete" : {
"type" : "boolean"
} ,
"supportsOnHealthIssue" : {
"type" : "boolean"
} ,
"includeHealthWarnings" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProviderField"
}
} ,
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"configContract" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
"message" : {
"type" : "object" ,
"required" : [
"message" ,
"type"
] ,
"properties" : {
"message" : {
"type" : "string" ,
"minLength" : 1
} ,
"type" : {
"type" : "string" ,
"minLength" : 1
}
}
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"id" : {
"type" : "integer"
}
} ,
"required" : [
"onGrab" ,
"onDownload" ,
"onUpgrade" ,
"onRename" ,
"onDelete" ,
"onHealthIssue" ,
"supportsOnGrab" ,
"supportsOnDownload" ,
"supportsOnUpgrade" ,
"supportsOnRename" ,
"supportsOnDelete" ,
"supportsOnHealthIssue" ,
"includeHealthWarnings" ,
"name" ,
"fields" ,
"implementationName" ,
"implementation" ,
"configContract" ,
"infoLink" ,
"message" ,
"tags" ,
"id"
]
} ,
"Metadata" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"enable" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProviderField"
}
} ,
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"configContract" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"id" : {
2020-07-25 04:59:00 +00:00
"type" : "integer"
2020-11-22 07:50:38 +00:00
}
} ,
"required" : [
"enable" ,
"name" ,
"fields" ,
"implementationName" ,
"implementation" ,
"configContract" ,
"infoLink" ,
"tags" ,
"id"
]
} ,
"ImportList" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"enabled" : {
"type" : "boolean"
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"enableAuto" : {
"type" : "boolean"
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"shouldMonitor" : {
"type" : "boolean"
} ,
"rootFolderPath" : {
"type" : "string" ,
"minLength" : 1
} ,
"qualityProfileId" : {
"type" : "number"
} ,
"searchOnAdd" : {
"type" : "boolean"
} ,
"minimumAvailability" : {
"type" : "string" ,
"minLength" : 1
} ,
"listType" : {
"type" : "string" ,
"minLength" : 1
} ,
"listOrder" : {
"type" : "number"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"fields" : {
2020-07-25 04:59:00 +00:00
"type" : "array" ,
"items" : {
2020-11-22 07:50:38 +00:00
"$ref" : "#/components/schemas/ProviderField"
2020-07-25 04:59:00 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"configContract" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
2020-07-25 04:59:00 +00:00
"tags" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
2020-11-22 07:50:38 +00:00
"id" : {
"type" : "integer"
2020-07-25 04:39:10 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"enabled" ,
"enableAuto" ,
"shouldMonitor" ,
"rootFolderPath" ,
"qualityProfileId" ,
"searchOnAdd" ,
"minimumAvailability" ,
"listType" ,
"listOrder" ,
"name" ,
"fields" ,
"implementationName" ,
"implementation" ,
"configContract" ,
"infoLink" ,
"tags" ,
"id"
]
2020-07-25 04:39:10 +00:00
} ,
2020-11-22 07:50:38 +00:00
"ProviderField" : {
"description" : "" ,
2020-07-25 04:59:00 +00:00
"type" : "object" ,
"properties" : {
2020-11-22 07:50:38 +00:00
"order" : {
"type" : "integer"
} ,
"name" : {
2020-07-25 04:59:00 +00:00
"type" : "string" ,
2020-11-22 07:50:38 +00:00
"minLength" : 1
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"label" : {
"type" : "string" ,
"minLength" : 1
} ,
"helpText" : {
"type" : "string" ,
"minLength" : 1
} ,
"value" : {
"type" : "string" ,
"minLength" : 1
} ,
"type" : {
"type" : "string" ,
"minLength" : 1
} ,
"advanced" : {
"type" : "boolean"
2020-07-25 04:59:00 +00:00
}
2020-07-25 04:39:10 +00:00
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"order" ,
"name" ,
"label" ,
"helpText" ,
"value" ,
"type" ,
"advanced"
]
2020-07-25 04:39:10 +00:00
} ,
2020-11-22 07:50:38 +00:00
"History" : {
"description" : "" ,
2020-07-25 04:59:00 +00:00
"type" : "object" ,
"properties" : {
2020-11-22 07:50:38 +00:00
"movieId" : {
"type" : "number"
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"sourceTitle" : {
"type" : "string" ,
"minLength" : 1
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"languages" : {
2020-07-25 04:59:00 +00:00
"type" : "array" ,
2020-11-22 07:50:38 +00:00
"uniqueItems" : true ,
"minItems" : 1 ,
2020-07-25 04:59:00 +00:00
"items" : {
2020-11-22 07:50:38 +00:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "number"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
}
} ,
"required" : [
"id" ,
"name"
]
}
} ,
"quality" : {
"$ref" : "#/components/schemas/Quality"
} ,
"customFormats" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/CustomFormat"
2020-07-25 04:59:00 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"qualityCutoffNotMet" : {
"type" : "boolean"
} ,
"date" : {
"type" : "string" ,
"minLength" : 1
} ,
"downloadId" : {
"type" : "string" ,
"minLength" : 1
} ,
"eventType" : {
"type" : "string" ,
"minLength" : 1
} ,
"data" : {
"type" : "object"
} ,
"id" : {
"type" : "number"
2020-07-25 04:39:10 +00:00
}
2020-07-25 04:59:00 +00:00
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"movieId" ,
"sourceTitle" ,
"languages" ,
"quality" ,
"customFormats" ,
"qualityCutoffNotMet" ,
"date" ,
"downloadId" ,
"eventType" ,
"data" ,
"id"
]
2020-07-25 04:39:10 +00:00
} ,
2020-11-22 07:50:38 +00:00
"CustomFormat" : {
"description" : "" ,
2020-07-25 04:59:00 +00:00
"type" : "object" ,
"properties" : {
2020-11-22 07:50:38 +00:00
"id" : {
2020-07-25 04:59:00 +00:00
"type" : "integer"
} ,
2020-11-22 07:50:38 +00:00
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"includeCustomFormatWhenRenaming" : {
"type" : "boolean"
} ,
"specifications" : {
"type" : "array" ,
"uniqueItems" : true ,
"minItems" : 1 ,
"items" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementation" : {
"type" : "string" ,
"minLength" : 1
} ,
"implementationName" : {
"type" : "string" ,
"minLength" : 1
} ,
"infoLink" : {
"type" : "string" ,
"minLength" : 1
} ,
"negate" : {
"type" : "boolean"
} ,
"required" : {
"type" : "boolean"
} ,
"fields" : {
"type" : "array" ,
"uniqueItems" : true ,
"minItems" : 1 ,
"items" : {
"$ref" : "#/components/schemas/ProviderField"
}
}
} ,
"required" : [
"name" ,
"implementation" ,
"implementationName" ,
"infoLink" ,
"negate" ,
"required"
]
}
2020-07-25 04:59:00 +00:00
}
2020-07-25 04:39:10 +00:00
} ,
2020-11-22 07:50:38 +00:00
"required" : [
"id" ,
"name" ,
"includeCustomFormatWhenRenaming" ,
"specifications"
]
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"Quality" : {
"description" : "" ,
2020-09-10 04:28:35 +00:00
"type" : "object" ,
"properties" : {
2020-11-22 07:50:38 +00:00
"quality" : {
"type" : "object" ,
"required" : [
"id" ,
"name" ,
"source" ,
"resolution" ,
"modifier"
] ,
"properties" : {
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"source" : {
"type" : "string" ,
"minLength" : 1
} ,
"resolution" : {
"type" : "integer"
} ,
"modifier" : {
"type" : "string" ,
"minLength" : 1
}
}
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"revision" : {
"type" : "object" ,
"required" : [
"version" ,
"real" ,
"isRepack"
] ,
"properties" : {
"version" : {
"type" : "integer"
} ,
"real" : {
"type" : "integer"
} ,
"isRepack" : {
"type" : "boolean"
}
}
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"required" : [
"quality" ,
"revision"
]
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"QualityProfile" : {
"description" : "" ,
2020-09-10 04:28:35 +00:00
"type" : "object" ,
"properties" : {
2020-11-22 07:50:38 +00:00
"name" : {
"type" : "string" ,
"minLength" : 1
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"upgradeAllowed" : {
"type" : "boolean"
2020-09-10 04:28:35 +00:00
} ,
2020-11-22 07:50:38 +00:00
"cutoff" : {
"type" : "integer"
} ,
"items" : {
2020-09-10 04:28:35 +00:00
"type" : "array" ,
"items" : {
2020-11-22 07:50:38 +00:00
"type" : "object"
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"minFormatScore" : {
"type" : "integer"
} ,
"cutoffFormatScore" : {
"type" : "integer"
} ,
"formatItems" : {
2020-09-10 04:28:35 +00:00
"type" : "array" ,
2020-11-22 07:50:38 +00:00
"uniqueItems" : true ,
"minItems" : 1 ,
2020-09-10 04:28:35 +00:00
"items" : {
2020-11-22 07:50:38 +00:00
"type" : "object" ,
"properties" : {
"format" : {
"type" : "integer"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
} ,
"score" : {
"type" : "integer"
}
} ,
"required" : [
"format" ,
"name" ,
"score"
]
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"language" : {
"type" : "object" ,
"required" : [
"id" ,
"name"
] ,
"properties" : {
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
}
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"id" : {
"type" : "integer"
}
} ,
"required" : [
"name" ,
"upgradeAllowed" ,
"cutoff" ,
"items" ,
"minFormatScore" ,
"cutoffFormatScore" ,
"formatItems" ,
"language" ,
"id"
]
} ,
"Blacklist" : {
"description" : "" ,
"type" : "object" ,
"properties" : {
"movieId" : {
"type" : "number"
} ,
"sourceTitle" : {
"type" : "string" ,
"minLength" : 1
} ,
"languages" : {
2020-09-10 04:28:35 +00:00
"type" : "array" ,
2020-11-22 07:50:38 +00:00
"uniqueItems" : true ,
"minItems" : 1 ,
2020-09-10 04:28:35 +00:00
"items" : {
2020-11-22 07:50:38 +00:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "number"
} ,
"name" : {
"type" : "string" ,
"minLength" : 1
}
} ,
"required" : [
"id" ,
"name"
]
2020-09-10 04:28:35 +00:00
}
} ,
2020-11-22 07:50:38 +00:00
"quality" : {
"$ref" : "#/components/schemas/Quality"
} ,
"customFormats" : {
2020-09-10 04:28:35 +00:00
"type" : "array" ,
"items" : {
2020-11-22 07:50:38 +00:00
"$ref" : "#/components/schemas/CustomFormat"
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"date" : {
"type" : "string" ,
"minLength" : 1
} ,
"protocol" : {
"type" : "string" ,
"minLength" : 1
} ,
"indexer" : {
"type" : "string" ,
"minLength" : 1
} ,
"message" : {
"type" : "string" ,
"minLength" : 1
} ,
"id" : {
"type" : "number"
2020-09-10 04:28:35 +00:00
}
2020-11-22 07:50:38 +00:00
} ,
"required" : [
"movieId" ,
"sourceTitle" ,
"languages" ,
"quality" ,
"customFormats" ,
"date" ,
"protocol" ,
"indexer" ,
"message" ,
"id"
]
2020-07-25 04:59:00 +00:00
}
} ,
"securitySchemes" : {
2020-09-10 04:28:35 +00:00
"X-API-Key" : {
"type" : "http" ,
"scheme" : "basic" ,
2020-10-03 13:25:35 +00:00
"description" : "Used when not providing the key via URL"
} ,
2020-11-22 07:50:38 +00:00
"apikey" : {
2020-10-03 13:25:35 +00:00
"name" : "API Key" ,
"type" : "apiKey" ,
"in" : "query" ,
"description" : "Used when not providing the key via header"
2020-07-25 04:39:10 +00:00
}
}
2020-11-22 07:50:38 +00:00
} ,
"tags" : [
{
"name" : "History"
} ,
{
"name" : "Indexer"
} ,
{
"name" : "Tag"
} ,
{
"name" : "Disk Space"
} ,
{
"name" : "Download Client"
} ,
{
"name" : "Blacklist"
} ,
{
"name" : "Notification"
}
]
2020-07-25 04:39:10 +00:00
}
