{ "openapi": "3.0.0", "info": { "title": "Radarr", "description": "Movie Automation", "contact": { "url": "https://radarr.video" }, "version": "0.2.0" }, "servers": [ { "url": "{protocol}://{hostPath}/api", "variables": { "protocol": { "enum": [ "https", "http" ], "default": "https" }, "hostPath": { "default": "localhost:7878", "description": "Your Radarr Server URL" } } } ], "paths": { "/movie": { "get": { "tags": [ "Movie" ], "summary": "Get all movies", "description": "Returns all movies", "operationId": "getMovie", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Movie" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Movie not found" } }, "security": [ { "api_key": [] } ] }, "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 operation", "content": { "application/json": { "schema": { "type": "integer" } } } }, "405": { "description": "Validation exception" } }, "security": [ { "api_key": [] } ] }, "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" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Movie" } } } }, "404": { "description": "Movie not found" }, "405": { "description": "Validation exception" } }, "security": [ { "api_key": [] } ] } }, "/movie/{movieId}": { "get": { "tags": [ "Movie" ], "summary": "Get movie by ID", "description": "Returns a single movie", "operationId": "getMovieById", "parameters": [ { "name": "movieId", "in": "path", "description": "ID of movie to return", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Movie" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Movie not found" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Movie" ], "summary": "Deletes a Movie", "description": "", "operationId": "deleteMovie", "parameters": [ { "name": "movieId", "in": "path", "description": "Movie id to delete", "required": true, "schema": { "type": "integer" } }, { "name": "addImportExclusion", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteFiles", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Invalid ID supplied" }, "404": { "description": "Movie not found" } }, "security": [ { "api_key": [] } ] } } }, "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" } } }, "securitySchemes": { "api_key": { "type": "apiKey", "in": "query", "name": "apiKey" } } }, "externalDocs": { "description": "GitHub", "url": "https://github.com/Radarr/Radarr" } }