Sonarr / Sonarr
14,958 C#Smart PVR for newsgroup and bittorrent users.
Sonarr Specification
Located in src/Sonarr.Api.V3/openapi.json on branch HEAD
3.0.1
JSON
162 Endpoints
290.5 KB
Operations & Route Endpoints (100)
Raw JSON Specification
{
"openapi": "3.0.1",
"info": {
"title": "Sonarr",
"description": "Sonarr API docs - The v3 API docs apply to both v3 and v4 versions of Sonarr. Some functionality may only be available in v4 of the Sonarr application.",
"license": {
"name": "GPL-3.0",
"url": "https://github.com/Sonarr/Sonarr/blob/develop/LICENSE"
},
"version": "3.0.0"
},
"servers": [
{
"url": "{protocol}://{hostpath}",
"variables": {
"protocol": {
"default": "http",
"enum": [
"http",
"https"
]
},
"hostpath": {
"default": "localhost:8989"
}
}
}
],
"paths": {
"/api": {
"get": {
"tags": [
"ApiInfo"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/login": {
"post": {
"tags": [
"Authentication"
],
"parameters": [
{
"name": "returnUrl",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"rememberMe": {
"type": "string"
}
}
},
"encoding": {
"username": {
"style": "form"
},
"password": {
"style": "form"
},
"rememberMe": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"StaticResource"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/logout": {
"get": {
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/autotagging": {
"post": {
"tags": [
"AutoTagging"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
},
"get": {
"tags": [
"AutoTagging"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
}
}
},
"/api/v3/autotagging/{id}": {
"put": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
},
"delete": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
}
},
"/api/v3/autotagging/schema": {
"get": {
"tags": [
"AutoTagging"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/backup": {
"get": {
"tags": [
"Backup"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
}
}
}
}
}
},
"/api/v3/system/backup/{id}": {
"delete": {
"tags": [
"Backup"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/backup/restore/{id}": {
"post": {
"tags": [
"Backup"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/backup/restore/upload": {
"post": {
"tags": [
"Backup"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/blocklist": {
"get": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "seriesIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "protocols",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadProtocol"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/blocklist/{id}": {
"delete": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/blocklist/bulk": {
"delete": {
"tags": [
"Blocklist"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/calendar": {
"get": {
"tags": [
"Calendar"
],
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "end",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "unmonitored",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisodeFile",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisodeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tags",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
}
},
"/api/v3/calendar/{id}": {
"get": {
"tags": [
"Calendar"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
},
"/feed/v3/calendar/sonarr.ics": {
"get": {
"tags": [
"CalendarFeed"
],
"parameters": [
{
"name": "pastDays",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 7
}
},
{
"name": "futureDays",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 28
}
},
{
"name": "tags",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "unmonitored",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "premieresOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "asAllDay",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/command": {
"post": {
"tags": [
"Command"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
},
"get": {
"tags": [
"Command"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
}
}
},
"/api/v3/command/{id}": {
"delete": {
"tags": [
"Command"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Command"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
}
},
"/api/v3/customfilter": {
"get": {
"tags": [
"CustomFilter"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"CustomFilter"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"/api/v3/customfilter/{id}": {
"put": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"/api/v3/customformat": {
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
},
"/api/v3/customformat/{id}": {
"put": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
},
"/api/v3/customformat/bulk": {
"put": {
"tags": [
"CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/customformat/schema": {
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/wanted/cutoff": {
"get": {
"tags": [
"Cutoff"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisodeFile",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/wanted/cutoff/{id}": {
"get": {
"tags": [
"Cutoff"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
},
"/api/v3/delayprofile": {
"post": {
"tags": [
"DelayProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"DelayProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
}
}
},
"/api/v3/delayprofile/{id}": {
"delete": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
}
},
"/api/v3/delayprofile/reorder/{id}": {
"put": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
}
}
},
"/api/v3/diskspace": {
"get": {
"tags": [
"DiskSpace"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiskSpaceResource"
}
}
}
}
}
}
}
},
"/api/v3/downloadclient": {
"get": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"/api/v3/downloadclient/{id}": {
"put": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
},
"delete": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"/api/v3/downloadclient/bulk": {
"put": {
"tags": [
"DownloadClient"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
},
"delete": {
"tags": [
"DownloadClient"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/downloadclient/schema": {
"get": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
}
},
"/api/v3/downloadclient/test": {
"post": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/downloadclient/testall": {
"post": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/downloadclient/action/{name}": {
"post": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/downloadclient": {
"get": {
"tags": [
"DownloadClientConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/downloadclient/{id}": {
"put": {
"tags": [
"DownloadClientConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"DownloadClientConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
}
},
"/api/v3/episode": {
"get": {
"tags": [
"Episode"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "episodeIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "episodeFileId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisodeFile",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
}
},
"/api/v3/episode/{id}": {
"put": {
"tags": [
"Episode"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
},
"get": {
"tags": [
"Episode"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
},
"/api/v3/episode/monitor": {
"put": {
"tags": [
"Episode"
],
"parameters": [
{
"name": "includeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodesMonitoredResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/episodefile": {
"get": {
"tags": [
"EpisodeFile"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "episodeFileIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
}
}
}
}
}
}
},
"/api/v3/episodefile/{id}": {
"put": {
"tags": [
"EpisodeFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
}
}
}
}
},
"delete": {
"tags": [
"EpisodeFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"EpisodeFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
}
}
}
}
}
},
"/api/v3/episodefile/editor": {
"put": {
"tags": [
"EpisodeFile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/episodefile/bulk": {
"delete": {
"tags": [
"EpisodeFile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeFileListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"EpisodeFile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeFileResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/filesystem": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "includeFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "allowFoldersWithoutTrailingSlashes",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/filesystem/type": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/filesystem/mediafiles": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/health": {
"get": {
"tags": [
"Health"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResource"
}
}
}
}
}
}
}
},
"/api/v3/history": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "episodeId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seriesIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "languages",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "quality",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/history/since": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "date",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v3/history/series": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v3/history/failed/{id}": {
"post": {
"tags": [
"History"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/host": {
"get": {
"tags": [
"HostConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/host/{id}": {
"put": {
"tags": [
"HostConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"HostConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
}
},
"/api/v3/importlist": {
"get": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"/api/v3/importlist/{id}": {
"put": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"/api/v3/importlist/bulk": {
"put": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/schema": {
"get": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
}
},
"/api/v3/importlist/test": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/testall": {
"post": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/action/{name}": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/importlist": {
"get": {
"tags": [
"ImportListConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/importlist/{id}": {
"put": {
"tags": [
"ImportListConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"ImportListConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
}
}
}
},
"/api/v3/importlistexclusion": {
"get": {
"tags": [
"ImportListExclusion"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"/api/v3/importlistexclusion/paged": {
"get": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/importlistexclusion/{id}": {
"put": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"/api/v3/importlistexclusion/bulk": {
"delete": {
"tags": [
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/indexer": {
"get": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"/api/v3/indexer/{id}": {
"put": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"/api/v3/indexer/bulk": {
"put": {
"tags": [
"Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/indexer/schema": {
"get": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
}
},
"/api/v3/indexer/test": {
"post": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/indexer/testall": {
"post": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/indexer/action/{name}": {
"post": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/indexer": {
"get": {
"tags": [
"IndexerConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/indexer/{id}": {
"put": {
"tags": [
"IndexerConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"IndexerConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
}
},
"/api/v3/indexerflag": {
"get": {
"tags": [
"IndexerFlag"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
}
}
}
}
}
},
"/api/v3/language": {
"get": {
"tags": [
"Language"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
}
}
}
}
}
},
"/api/v3/language/{id}": {
"get": {
"tags": [
"Language"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageResource"
}
}
}
}
}
}
},
"/api/v3/languageprofile": {
"post": {
"tags": [
"LanguageProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"LanguageProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
}
}
},
"deprecated": true
}
},
"/api/v3/languageprofile/{id}": {
"delete": {
"tags": [
"LanguageProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": true
},
"put": {
"tags": [
"LanguageProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"LanguageProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
}
}
}
},
"/api/v3/languageprofile/schema": {
"get": {
"tags": [
"LanguageProfileSchema"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageProfileResource"
}
}
}
}
},
"deprecated": true
}
},
"/api/v3/localization": {
"get": {
"tags": [
"Localization"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalizationResource"
}
}
}
}
}
}
},
"/api/v3/localization/language": {
"get": {
"tags": [
"Localization"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalizationLanguageResource"
}
}
}
}
}
}
},
"/api/v3/localization/{id}": {
"get": {
"tags": [
"Localization"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalizationResource"
}
}
}
}
}
}
},
"/api/v3/log": {
"get": {
"tags": [
"Log"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "level",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/log/file": {
"get": {
"tags": [
"LogFile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v3/log/file/{filename}": {
"get": {
"tags": [
"LogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/manualimport": {
"get": {
"tags": [
"ManualImport"
],
"parameters": [
{
"name": "folder",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filterExistingFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"ManualImport"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportReprocessResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/mediacover/{seriesId}/{filename}": {
"get": {
"tags": [
"MediaCover"
],
"parameters": [
{
"name": "seriesId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "(.+)\\.(jpg|png|gif)",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/mediamanagement": {
"get": {
"tags": [
"MediaManagementConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/mediamanagement/{id}": {
"put": {
"tags": [
"MediaManagementConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"MediaManagementConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
}
},
"/api/v3/metadata": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v3/metadata/{id}": {
"put": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v3/metadata/schema": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
}
},
"/api/v3/metadata/test": {
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/metadata/testall": {
"post": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/metadata/action/{name}": {
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/wanted/missing": {
"get": {
"tags": [
"Missing"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/wanted/missing/{id}": {
"get": {
"tags": [
"Missing"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResource"
}
}
}
}
}
}
},
"/api/v3/config/naming": {
"get": {
"tags": [
"NamingConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/naming/{id}": {
"put": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/naming/examples": {
"get": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "renameEpisodes",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "replaceIllegalCharacters",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "colonReplacementFormat",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customColonReplacementFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "multiEpisodeStyle",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "standardEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "dailyEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "animeEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seriesFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seasonFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "specialsFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "resourceName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/notification": {
"get": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"/api/v3/notification/{id}": {
"put": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"/api/v3/notification/schema": {
"get": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
}
},
"/api/v3/notification/test": {
"post": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/notification/testall": {
"post": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/notification/action/{name}": {
"post": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/parse": {
"get": {
"tags": [
"Parse"
],
"parameters": [
{
"name": "title",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseResource"
}
}
}
}
}
}
},
"/ping": {
"get": {
"tags": [
"Ping"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResource"
}
}
}
}
}
},
"head": {
"tags": [
"Ping"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResource"
}
}
}
}
}
}
},
"/api/v3/qualitydefinition/{id}": {
"put": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
},
"/api/v3/qualitydefinition": {
"get": {
"tags": [
"QualityDefinition"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
}
},
"/api/v3/qualitydefinition/update": {
"put": {
"tags": [
"QualityDefinition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/qualitydefinition/limits": {
"get": {
"tags": [
"QualityDefinition"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionLimitsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionLimitsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionLimitsResource"
}
}
}
}
}
}
},
"/api/v3/qualityprofile": {
"post": {
"tags": [
"QualityProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
}
},
"/api/v3/qualityprofile/{id}": {
"delete": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v3/qualityprofile/schema": {
"get": {
"tags": [
"QualityProfileSchema"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v3/queue/{id}": {
"delete": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "removeFromClient",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skipRedownload",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "changeCategory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/queue/bulk": {
"delete": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "removeFromClient",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skipRedownload",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "changeCategory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/queue": {
"get": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeUnknownSeriesItems",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "seriesIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "protocol",
"in": "query",
"schema": {
"$ref": "#/components/schemas/DownloadProtocol"
}
},
{
"name": "languages",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "quality",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueStatus"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueResourcePagingResource"
}
}
}
}
}
}
},
"/api/v3/queue/grab/{id}": {
"post": {
"tags": [
"QueueAction"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/queue/grab/bulk": {
"post": {
"tags": [
"QueueAction"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/queue/details": {
"get": {
"tags": [
"QueueDetails"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "episodeIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
}
}
}
}
}
}
}
},
"/api/v3/queue/status": {
"get": {
"tags": [
"QueueStatus"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueStatusResource"
}
}
}
}
}
}
},
"/api/v3/release": {
"post": {
"tags": [
"Release"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Release"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "episodeId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
}
}
}
}
},
"/api/v3/releaseprofile": {
"post": {
"tags": [
"ReleaseProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"ReleaseProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
}
},
"/api/v3/releaseprofile/{id}": {
"delete": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
},
"/api/v3/release/push": {
"post": {
"tags": [
"ReleasePush"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
}
}
}
}
},
"/api/v3/remotepathmapping": {
"post": {
"tags": [
"RemotePathMapping"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
},
"get": {
"tags": [
"RemotePathMapping"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
}
}
},
"/api/v3/remotepathmapping/{id}": {
"delete": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
},
"get": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
}
},
"/api/v3/rename": {
"get": {
"tags": [
"RenameEpisode"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenameEpisodeResource"
}
}
}
}
}
}
}
},
"/api/v3/rootfolder": {
"post": {
"tags": [
"RootFolder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
},
"get": {
"tags": [
"RootFolder"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
}
}
},
"/api/v3/rootfolder/{id}": {
"delete": {
"tags": [
"RootFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"RootFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
}
},
"/api/v3/seasonpass": {
"post": {
"tags": [
"SeasonPass"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeasonPassResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/series": {
"get": {
"tags": [
"Series"
],
"parameters": [
{
"name": "tvdbId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSeasonImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Series"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
},
"/api/v3/series/{id}": {
"get": {
"tags": [
"Series"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSeasonImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
},
"put": {
"tags": [
"Series"
],
"parameters": [
{
"name": "moveFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Series"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "deleteFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "addImportListExclusion",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/series/editor": {
"put": {
"tags": [
"SeriesEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"SeriesEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SeriesEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/series/{id}/folder": {
"get": {
"tags": [
"SeriesFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/series/import": {
"post": {
"tags": [
"SeriesImport"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/series/lookup": {
"get": {
"tags": [
"SeriesLookup"
],
"parameters": [
{
"name": "term",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
}
},
"/content/{path}": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"pattern": "^(?!api/).*",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/{path}": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"pattern": "^(?!(api|feed)/).*",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/status": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemResource"
}
}
}
}
}
}
},
"/api/v3/system/routes": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/routes/duplicate": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/shutdown": {
"post": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/system/restart": {
"post": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/tag": {
"get": {
"tags": [
"Tag"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Tag"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"/api/v3/tag/{id}": {
"put": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"/api/v3/tag/detail": {
"get": {
"tags": [
"TagDetails"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
}
}
}
}
}
},
"/api/v3/tag/detail/{id}": {
"get": {
"tags": [
"TagDetails"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
}
}
}
}
},
"/api/v3/system/task": {
"get": {
"tags": [
"Task"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
}
}
}
}
}
},
"/api/v3/system/task/{id}": {
"get": {
"tags": [
"Task"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskResource"
}
}
}
}
}
}
},
"/api/v3/config/ui/{id}": {
"put": {
"tags": [
"UiConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"UiConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
}
},
"/api/v3/config/ui": {
"get": {
"tags": [
"UiConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
}
},
"/api/v3/update": {
"get": {
"tags": [
"Update"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateResource"
}
}
}
}
}
}
}
},
"/api/v3/log/file/update": {
"get": {
"tags": [
"UpdateLogFile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v3/log/file/update/{filename}": {
"get": {
"tags": [
"UpdateLogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"AddSeriesOptions": {
"type": "object",
"properties": {
"ignoreEpisodesWithFiles": {
"type": "boolean"
},
"ignoreEpisodesWithoutFiles": {
"type": "boolean"
},
"monitor": {
"$ref": "#/components/schemas/MonitorTypes"
},
"searchForMissingEpisodes": {
"type": "boolean"
},
"searchForCutoffUnmetEpisodes": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AlternateTitleResource": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"seasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sceneSeasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sceneOrigin": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ApplyTags": {
"enum": [
"add",
"remove",
"replace"
],
"type": "string"
},
"AuthenticationRequiredType": {
"enum": [
"enabled",
"disabledForLocalAddresses"
],
"type": "string"
},
"AuthenticationType": {
"enum": [
"none",
"basic",
"forms",
"external"
],
"type": "string"
},
"AutoTaggingResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"removeTagsAutomatically": {
"type": "boolean"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoTaggingSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"AutoTaggingSpecificationSchema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
}
},
"additionalProperties": false
},
"BackupResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/BackupType"
},
"size": {
"type": "integer",
"format": "int64"
},
"time": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"BackupType": {
"enum": [
"scheduled",
"manual",
"update"
],
"type": "string"
},
"BlocklistBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"BlocklistResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sourceTitle": {
"type": "string",
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"indexer": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
}
},
"additionalProperties": false
},
"BlocklistResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlocklistResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"CertificateValidationType": {
"enum": [
"enabled",
"disabledForLocalAddresses",
"disabled"
],
"type": "string"
},
"Command": {
"type": "object",
"properties": {
"sendUpdatesToClient": {
"type": "boolean"
},
"updateScheduledTask": {
"type": "boolean",
"readOnly": true
},
"completionMessage": {
"type": "string",
"nullable": true,
"readOnly": true
},
"requiresDiskAccess": {
"type": "boolean",
"readOnly": true
},
"isExclusive": {
"type": "boolean",
"readOnly": true
},
"isLongRunning": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastStartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"trigger": {
"$ref": "#/components/schemas/CommandTrigger"
},
"suppressMessages": {
"type": "boolean"
},
"clientUserAgent": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CommandPriority": {
"enum": [
"normal",
"high",
"low"
],
"type": "string"
},
"CommandResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"commandName": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"body": {
"$ref": "#/components/schemas/Command"
},
"priority": {
"$ref": "#/components/schemas/CommandPriority"
},
"status": {
"$ref": "#/components/schemas/CommandStatus"
},
"result": {
"$ref": "#/components/schemas/CommandResult"
},
"queued": {
"type": "string",
"format": "date-time"
},
"started": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ended": {
"type": "string",
"format": "date-time",
"nullable": true
},
"duration": {
"type": "string",
"format": "date-span",
"nullable": true
},
"exception": {
"type": "string",
"nullable": true
},
"trigger": {
"$ref": "#/components/schemas/CommandTrigger"
},
"clientUserAgent": {
"type": "string",
"nullable": true
},
"stateChangeTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sendUpdatesToClient": {
"type": "boolean"
},
"updateScheduledTask": {
"type": "boolean"
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CommandResult": {
"enum": [
"unknown",
"successful",
"unsuccessful"
],
"type": "string"
},
"CommandStatus": {
"enum": [
"queued",
"started",
"completed",
"failed",
"aborted",
"cancelled",
"orphaned"
],
"type": "string"
},
"CommandTrigger": {
"enum": [
"unspecified",
"manual",
"scheduled"
],
"type": "string"
},
"CustomFilterResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatBulkResource": {
"type": "object",
"properties": {
"ids": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean",
"nullable": true
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatSpecificationSchema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"DatabaseType": {
"enum": [
"sqLite",
"postgreSQL"
],
"type": "string"
},
"DelayProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"enableUsenet": {
"type": "boolean"
},
"enableTorrent": {
"type": "boolean"
},
"preferredProtocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"usenetDelay": {
"type": "integer",
"format": "int32"
},
"torrentDelay": {
"type": "integer",
"format": "int32"
},
"bypassIfHighestQuality": {
"type": "boolean"
},
"bypassIfAboveCustomFormatScore": {
"type": "boolean"
},
"minimumCustomFormatScore": {
"type": "integer",
"format": "int32"
},
"order": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"DiskSpaceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"freeSpace": {
"type": "integer",
"format": "int64"
},
"totalSpace": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"DownloadClientBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enable": {
"type": "boolean",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true
},
"removeCompletedDownloads": {
"type": "boolean",
"nullable": true
},
"removeFailedDownloads": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DownloadClientConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"downloadClientWorkingFolders": {
"type": "string",
"nullable": true
},
"enableCompletedDownloadHandling": {
"type": "boolean"
},
"autoRedownloadFailed": {
"type": "boolean"
},
"autoRedownloadFailedFromInteractiveSearch": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DownloadClientResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
},
"nullable": true
},
"enable": {
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"priority": {
"type": "integer",
"format": "int32"
},
"removeCompletedDownloads": {
"type": "boolean"
},
"removeFailedDownloads": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DownloadProtocol": {
"enum": [
"unknown",
"usenet",
"torrent"
],
"type": "string"
},
"EpisodeFileListResource": {
"type": "object",
"properties": {
"episodeFileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"sceneName": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EpisodeFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"relativePath": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64"
},
"dateAdded": {
"type": "string",
"format": "date-time"
},
"sceneName": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"indexerFlags": {
"type": "integer",
"format": "int32",
"nullable": true
},
"releaseType": {
"$ref": "#/components/schemas/ReleaseType"
},
"mediaInfo": {
"$ref": "#/components/schemas/MediaInfoResource"
},
"qualityCutoffNotMet": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EpisodeHistoryEventType": {
"enum": [
"unknown",
"grabbed",
"seriesFolderImported",
"downloadFolderImported",
"downloadFailed",
"episodeFileDeleted",
"episodeFileRenamed",
"downloadIgnored"
],
"type": "string"
},
"EpisodeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"tvdbId": {
"type": "integer",
"format": "int32"
},
"episodeFileId": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"episodeNumber": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"airDate": {
"type": "string",
"nullable": true
},
"airDateUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastSearchTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"runtime": {
"type": "integer",
"format": "int32"
},
"finaleType": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"episodeFile": {
"$ref": "#/components/schemas/EpisodeFileResource"
},
"hasFile": {
"type": "boolean"
},
"monitored": {
"type": "boolean"
},
"absoluteEpisodeNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sceneAbsoluteEpisodeNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sceneEpisodeNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sceneSeasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unverifiedSceneNumbering": {
"type": "boolean"
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"grabDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
}
},
"additionalProperties": false
},
"EpisodeResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"EpisodeTitleRequiredType": {
"enum": [
"always",
"bulkSeasonReleases",
"never"
],
"type": "string"
},
"EpisodesMonitoredResource": {
"type": "object",
"properties": {
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"monitored": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Field": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"unit": {
"type": "string",
"nullable": true
},
"helpText": {
"type": "string",
"nullable": true
},
"helpTextWarning": {
"type": "string",
"nullable": true
},
"helpLink": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"advanced": {
"type": "boolean"
},
"selectOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SelectOption"
},
"nullable": true
},
"selectOptionsProviderAction": {
"type": "string",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"hidden": {
"type": "string",
"nullable": true
},
"privacy": {
"$ref": "#/components/schemas/PrivacyLevel"
},
"placeholder": {
"type": "string",
"nullable": true
},
"isFloat": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FileDateType": {
"enum": [
"none",
"localAirDate",
"utcAirDate"
],
"type": "string"
},
"HealthCheckResult": {
"enum": [
"ok",
"notice",
"warning",
"error"
],
"type": "string"
},
"HealthResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"source": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/HealthCheckResult"
},
"message": {
"type": "string",
"nullable": true
},
"wikiUrl": {
"$ref": "#/components/schemas/HttpUri"
}
},
"additionalProperties": false
},
"HistoryResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"episodeId": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"sourceTitle": {
"type": "string",
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"qualityCutoffNotMet": {
"type": "boolean"
},
"date": {
"type": "string",
"format": "date-time"
},
"downloadId": {
"type": "string",
"nullable": true
},
"eventType": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"episode": {
"$ref": "#/components/schemas/EpisodeResource"
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
}
},
"additionalProperties": false
},
"HistoryResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"HostConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"bindAddress": {
"type": "string",
"nullable": true
},
"port": {
"type": "integer",
"format": "int32"
},
"sslPort": {
"type": "integer",
"format": "int32"
},
"enableSsl": {
"type": "boolean"
},
"launchBrowser": {
"type": "boolean"
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationType"
},
"authenticationRequired": {
"$ref": "#/components/schemas/AuthenticationRequiredType"
},
"analyticsEnabled": {
"type": "boolean"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"passwordConfirmation": {
"type": "string",
"nullable": true
},
"logLevel": {
"type": "string",
"nullable": true
},
"logSizeLimit": {
"type": "integer",
"format": "int32"
},
"consoleLogLevel": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
},
"sslCertPath": {
"type": "string",
"nullable": true
},
"sslCertPassword": {
"type": "string",
"nullable": true
},
"urlBase": {
"type": "string",
"nullable": true
},
"instanceName": {
"type": "string",
"nullable": true
},
"applicationUrl": {
"type": "string",
"nullable": true
},
"updateAutomatically": {
"type": "boolean"
},
"updateMechanism": {
"$ref": "#/components/schemas/UpdateMechanism"
},
"updateScriptPath": {
"type": "string",
"nullable": true
},
"proxyEnabled": {
"type": "boolean"
},
"proxyType": {
"$ref": "#/components/schemas/ProxyType"
},
"proxyHostname": {
"type": "string",
"nullable": true
},
"proxyPort": {
"type": "integer",
"format": "int32"
},
"proxyUsername": {
"type": "string",
"nullable": true
},
"proxyPassword": {
"type": "string",
"nullable": true
},
"proxyBypassFilter": {
"type": "string",
"nullable": true
},
"proxyBypassLocalAddresses": {
"type": "boolean"
},
"certificateValidation": {
"$ref": "#/components/schemas/CertificateValidationType"
},
"backupFolder": {
"type": "string",
"nullable": true
},
"backupInterval": {
"type": "integer",
"format": "int32"
},
"backupRetention": {
"type": "integer",
"format": "int32"
},
"trustCgnatIpAddresses": {
"type": "boolean"
}
},
"additionalProperties": false
},
"HttpUri": {
"type": "object",
"properties": {
"fullUri": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheme": {
"type": "string",
"nullable": true,
"readOnly": true
},
"host": {
"type": "string",
"nullable": true,
"readOnly": true
},
"port": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"path": {
"type": "string",
"nullable": true,
"readOnly": true
},
"query": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fragment": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ImportListBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enableAutomaticAdd": {
"type": "boolean",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ImportListConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"listSyncLevel": {
"$ref": "#/components/schemas/ListSyncLevelType"
},
"listSyncTag": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ImportListExclusionBulkResource": {
"type": "object",
"properties": {
"ids": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportListExclusionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"tvdbId": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportListExclusionResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportListResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
},
"nullable": true
},
"enableAutomaticAdd": {
"type": "boolean"
},
"searchForMissingEpisodes": {
"type": "boolean"
},
"shouldMonitor": {
"$ref": "#/components/schemas/MonitorTypes"
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32"
},
"seriesType": {
"$ref": "#/components/schemas/SeriesTypes"
},
"seasonFolder": {
"type": "boolean"
},
"listType": {
"$ref": "#/components/schemas/ImportListType"
},
"listOrder": {
"type": "integer",
"format": "int32"
},
"minRefreshInterval": {
"type": "string",
"format": "date-span"
}
},
"additionalProperties": false
},
"ImportListType": {
"enum": [
"program",
"plex",
"trakt",
"simkl",
"other",
"advanced"
],
"type": "string"
},
"ImportRejectionResource": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/RejectionType"
}
},
"additionalProperties": false
},
"IndexerBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enableRss": {
"type": "boolean",
"nullable": true
},
"enableAutomaticSearch": {
"type": "boolean",
"nullable": true
},
"enableInteractiveSearch": {
"type": "boolean",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"IndexerConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"minimumAge": {
"type": "integer",
"format": "int32"
},
"retention": {
"type": "integer",
"format": "int32"
},
"maximumSize": {
"type": "integer",
"format": "int32"
},
"rssSyncInterval": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IndexerFlagResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"nameLower": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"IndexerResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
},
"nullable": true
},
"enableRss": {
"type": "boolean"
},
"enableAutomaticSearch": {
"type": "boolean"
},
"enableInteractiveSearch": {
"type": "boolean"
},
"supportsRss": {
"type": "boolean"
},
"supportsSearch": {
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"priority": {
"type": "integer",
"format": "int32"
},
"seasonSearchMaximumSingleEpisodeAge": {
"type": "integer",
"format": "int32"
},
"downloadClientId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Language": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LanguageProfileItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"allowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"LanguageProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"upgradeAllowed": {
"type": "boolean"
},
"cutoff": {
"$ref": "#/components/schemas/Language"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageProfileItemResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"LanguageResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"nameLower": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ListSyncLevelType": {
"enum": [
"disabled",
"logOnly",
"keepAndUnmonitor",
"keepAndTag"
],
"type": "string"
},
"LocalizationLanguageResource": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LocalizationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"strings": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LogFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"filename": {
"type": "string",
"nullable": true
},
"lastWriteTime": {
"type": "string",
"format": "date-time"
},
"contentsUrl": {
"type": "string",
"nullable": true
},
"downloadUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"time": {
"type": "string",
"format": "date-time"
},
"exception": {
"type": "string",
"nullable": true
},
"exceptionType": {
"type": "string",
"nullable": true
},
"level": {
"type": "string",
"nullable": true
},
"logger": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"method": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManualImportReprocessResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
},
"nullable": true
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"downloadId": {
"type": "string",
"nullable": true
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"releaseType": {
"$ref": "#/components/schemas/ReleaseType"
},
"rejections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportRejectionResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManualImportResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"relativePath": {
"type": "string",
"nullable": true
},
"folderName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64"
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
},
"seasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
},
"nullable": true
},
"episodeFileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"qualityWeight": {
"type": "integer",
"format": "int32"
},
"downloadId": {
"type": "string",
"nullable": true
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"releaseType": {
"$ref": "#/components/schemas/ReleaseType"
},
"rejections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportRejectionResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"MediaCover": {
"type": "object",
"properties": {
"coverType": {
"$ref": "#/components/schemas/MediaCoverTypes"
},
"url": {
"type": "string",
"nullable": true
},
"remoteUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MediaCoverTypes": {
"enum": [
"unknown",
"poster",
"banner",
"fanart",
"screenshot",
"headshot",
"clearlogo"
],
"type": "string"
},
"MediaInfoResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"audioBitrate": {
"type": "integer",
"format": "int64"
},
"audioChannels": {
"type": "number",
"format": "double"
},
"audioCodec": {
"type": "string",
"nullable": true
},
"audioLanguages": {
"type": "string",
"nullable": true
},
"audioStreamCount": {
"type": "integer",
"format": "int32"
},
"videoBitDepth": {
"type": "integer",
"format": "int32"
},
"videoBitrate": {
"type": "integer",
"format": "int64"
},
"videoCodec": {
"type": "string",
"nullable": true
},
"videoFps": {
"type": "number",
"format": "double"
},
"videoDynamicRange": {
"type": "string",
"nullable": true
},
"videoDynamicRangeType": {
"type": "string",
"nullable": true
},
"resolution": {
"type": "string",
"nullable": true
},
"runTime": {
"type": "string",
"nullable": true
},
"scanType": {
"type": "string",
"nullable": true
},
"subtitles": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MediaManagementConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"autoUnmonitorPreviouslyDownloadedEpisodes": {
"type": "boolean"
},
"recycleBin": {
"type": "string",
"nullable": true
},
"recycleBinCleanupDays": {
"type": "integer",
"format": "int32"
},
"downloadPropersAndRepacks": {
"$ref": "#/components/schemas/ProperDownloadTypes"
},
"createEmptySeriesFolders": {
"type": "boolean"
},
"deleteEmptyFolders": {
"type": "boolean"
},
"fileDate": {
"$ref": "#/components/schemas/FileDateType"
},
"rescanAfterRefresh": {
"$ref": "#/components/schemas/RescanAfterRefreshType"
},
"setPermissionsLinux": {
"type": "boolean"
},
"chmodFolder": {
"type": "string",
"nullable": true
},
"chownGroup": {
"type": "string",
"nullable": true
},
"episodeTitleRequired": {
"$ref": "#/components/schemas/EpisodeTitleRequiredType"
},
"skipFreeSpaceCheckWhenImporting": {
"type": "boolean"
},
"minimumFreeSpaceWhenImporting": {
"type": "integer",
"format": "int32"
},
"copyUsingHardlinks": {
"type": "boolean"
},
"useScriptImport": {
"type": "boolean"
},
"scriptImportPath": {
"type": "string",
"nullable": true
},
"importExtraFiles": {
"type": "boolean"
},
"extraFileExtensions": {
"type": "string",
"nullable": true
},
"enableMediaInfo": {
"type": "boolean"
}
},
"additionalProperties": false
},
"MetadataResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
},
"nullable": true
},
"enable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"MonitorTypes": {
"enum": [
"unknown",
"all",
"future",
"missing",
"existing",
"firstSeason",
"lastSeason",
"latestSeason",
"pilot",
"recent",
"monitorSpecials",
"unmonitorSpecials",
"none",
"skip"
],
"type": "string"
},
"MonitoringOptions": {
"type": "object",
"properties": {
"ignoreEpisodesWithFiles": {
"type": "boolean"
},
"ignoreEpisodesWithoutFiles": {
"type": "boolean"
},
"monitor": {
"$ref": "#/components/schemas/MonitorTypes"
}
},
"additionalProperties": false
},
"NamingConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"renameEpisodes": {
"type": "boolean"
},
"replaceIllegalCharacters": {
"type": "boolean"
},
"colonReplacementFormat": {
"type": "integer",
"format": "int32"
},
"customColonReplacementFormat": {
"type": "string",
"nullable": true
},
"multiEpisodeStyle": {
"type": "integer",
"format": "int32"
},
"standardEpisodeFormat": {
"type": "string",
"nullable": true
},
"dailyEpisodeFormat": {
"type": "string",
"nullable": true
},
"animeEpisodeFormat": {
"type": "string",
"nullable": true
},
"seriesFolderFormat": {
"type": "string",
"nullable": true
},
"seasonFolderFormat": {
"type": "string",
"nullable": true
},
"specialsFolderFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NewItemMonitorTypes": {
"enum": [
"all",
"none"
],
"type": "string"
},
"NotificationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
},
"nullable": true
},
"link": {
"type": "string",
"nullable": true
},
"onGrab": {
"type": "boolean"
},
"onDownload": {
"type": "boolean"
},
"onUpgrade": {
"type": "boolean"
},
"onImportComplete": {
"type": "boolean"
},
"onRename": {
"type": "boolean"
},
"onSeriesAdd": {
"type": "boolean"
},
"onSeriesDelete": {
"type": "boolean"
},
"onEpisodeFileDelete": {
"type": "boolean"
},
"onEpisodeFileDeleteForUpgrade": {
"type": "boolean"
},
"onHealthIssue": {
"type": "boolean"
},
"includeHealthWarnings": {
"type": "boolean"
},
"onHealthRestored": {
"type": "boolean"
},
"onApplicationUpdate": {
"type": "boolean"
},
"onManualInteractionRequired": {
"type": "boolean"
},
"supportsOnGrab": {
"type": "boolean"
},
"supportsOnDownload": {
"type": "boolean"
},
"supportsOnUpgrade": {
"type": "boolean"
},
"supportsOnImportComplete": {
"type": "boolean"
},
"supportsOnRename": {
"type": "boolean"
},
"supportsOnSeriesAdd": {
"type": "boolean"
},
"supportsOnSeriesDelete": {
"type": "boolean"
},
"supportsOnEpisodeFileDelete": {
"type": "boolean"
},
"supportsOnEpisodeFileDeleteForUpgrade": {
"type": "boolean"
},
"supportsOnHealthIssue": {
"type": "boolean"
},
"supportsOnHealthRestored": {
"type": "boolean"
},
"supportsOnApplicationUpdate": {
"type": "boolean"
},
"supportsOnManualInteractionRequired": {
"type": "boolean"
},
"testCommand": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParseResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"parsedEpisodeInfo": {
"$ref": "#/components/schemas/ParsedEpisodeInfo"
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeResource"
},
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ParsedEpisodeInfo": {
"type": "object",
"properties": {
"releaseTitle": {
"type": "string",
"nullable": true
},
"seriesTitle": {
"type": "string",
"nullable": true
},
"seriesTitleInfo": {
"$ref": "#/components/schemas/SeriesTitleInfo"
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"episodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"absoluteEpisodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"specialAbsoluteEpisodeNumbers": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"airDate": {
"type": "string",
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"fullSeason": {
"type": "boolean"
},
"isPartialSeason": {
"type": "boolean"
},
"isMultiSeason": {
"type": "boolean"
},
"isSeasonExtra": {
"type": "boolean"
},
"isSplitEpisode": {
"type": "boolean"
},
"isMiniSeries": {
"type": "boolean"
},
"special": {
"type": "boolean"
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"releaseHash": {
"type": "string",
"nullable": true
},
"seasonPart": {
"type": "integer",
"format": "int32"
},
"releaseTokens": {
"type": "string",
"nullable": true
},
"dailyPart": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isDaily": {
"type": "boolean",
"readOnly": true
},
"isAbsoluteNumbering": {
"type": "boolean",
"readOnly": true
},
"isPossibleSpecialEpisode": {
"type": "boolean",
"readOnly": true
},
"isPossibleSceneSeasonSpecial": {
"type": "boolean",
"readOnly": true
},
"releaseType": {
"$ref": "#/components/schemas/ReleaseType"
}
},
"additionalProperties": false
},
"PingResource": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PrivacyLevel": {
"enum": [
"normal",
"password",
"apiKey",
"userName"
],
"type": "string"
},
"ProfileFormatItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"format": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProperDownloadTypes": {
"enum": [
"preferAndUpgrade",
"doNotUpgrade",
"doNotPrefer"
],
"type": "string"
},
"ProviderMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ProviderMessageType"
}
},
"additionalProperties": false
},
"ProviderMessageType": {
"enum": [
"info",
"warning",
"error"
],
"type": "string"
},
"ProxyType": {
"enum": [
"http",
"socks4",
"socks5"
],
"type": "string"
},
"Quality": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/QualitySource"
},
"resolution": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"QualityDefinitionLimitsResource": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int32"
},
"max": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"QualityDefinitionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"title": {
"type": "string",
"nullable": true
},
"weight": {
"type": "integer",
"format": "int32"
},
"minSize": {
"type": "number",
"format": "double",
"nullable": true
},
"maxSize": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredSize": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"QualityModel": {
"type": "object",
"properties": {
"quality": {
"$ref": "#/components/schemas/Quality"
},
"revision": {
"$ref": "#/components/schemas/Revision"
}
},
"additionalProperties": false
},
"QualityProfileQualityItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"allowed": {
"type": "boolean"
},
"minSize": {
"type": "number",
"format": "double",
"nullable": true
},
"maxSize": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredSize": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"QualityProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"upgradeAllowed": {
"type": "boolean"
},
"cutoff": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"minUpgradeFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItemResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"QualitySource": {
"enum": [
"unknown",
"television",
"televisionRaw",
"web",
"webRip",
"dvd",
"bluray",
"blurayRaw"
],
"type": "string"
},
"QueueBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"QueueResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"episodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"seasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
},
"episode": {
"$ref": "#/components/schemas/EpisodeResource"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "number",
"format": "double"
},
"title": {
"type": "string",
"nullable": true
},
"estimatedCompletionTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"added": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/QueueStatus"
},
"trackedDownloadStatus": {
"$ref": "#/components/schemas/TrackedDownloadStatus"
},
"trackedDownloadState": {
"$ref": "#/components/schemas/TrackedDownloadState"
},
"statusMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackedDownloadStatusMessage"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"downloadId": {
"type": "string",
"nullable": true
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"downloadClient": {
"type": "string",
"nullable": true
},
"downloadClientHasPostImportCategory": {
"type": "boolean"
},
"indexer": {
"type": "string",
"nullable": true
},
"outputPath": {
"type": "string",
"nullable": true
},
"episodeHasFile": {
"type": "boolean"
},
"sizeleft": {
"type": "number",
"format": "double",
"deprecated": true
},
"timeleft": {
"type": "string",
"format": "date-span",
"nullable": true,
"deprecated": true
}
},
"additionalProperties": false
},
"QueueResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"QueueStatus": {
"enum": [
"unknown",
"queued",
"paused",
"downloading",
"completed",
"failed",
"warning",
"delay",
"downloadClientUnavailable",
"fallback"
],
"type": "string"
},
"QueueStatusResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
},
"unknownCount": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "boolean"
},
"warnings": {
"type": "boolean"
},
"unknownErrors": {
"type": "boolean"
},
"unknownWarnings": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Ratings": {
"type": "object",
"properties": {
"votes": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"RejectionType": {
"enum": [
"permanent",
"temporary"
],
"type": "string"
},
"ReleaseEpisodeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"episodeNumber": {
"type": "integer",
"format": "int32"
},
"absoluteEpisodeNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"required": {
"nullable": true
},
"ignored": {
"nullable": true
},
"indexerId": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"guid": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"qualityWeight": {
"type": "integer",
"format": "int32"
},
"age": {
"type": "integer",
"format": "int32"
},
"ageHours": {
"type": "number",
"format": "double"
},
"ageMinutes": {
"type": "number",
"format": "double"
},
"size": {
"type": "integer",
"format": "int64"
},
"indexerId": {
"type": "integer",
"format": "int32"
},
"indexer": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"subGroup": {
"type": "string",
"nullable": true
},
"releaseHash": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"fullSeason": {
"type": "boolean"
},
"sceneSource": {
"type": "boolean"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"languageWeight": {
"type": "integer",
"format": "int32"
},
"airDate": {
"type": "string",
"nullable": true
},
"seriesTitle": {
"type": "string",
"nullable": true
},
"episodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"absoluteEpisodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"mappedSeasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mappedEpisodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"mappedAbsoluteEpisodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"mappedSeriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mappedEpisodeInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseEpisodeResource"
},
"nullable": true
},
"approved": {
"type": "boolean"
},
"temporarilyRejected": {
"type": "boolean"
},
"rejected": {
"type": "boolean"
},
"tvdbId": {
"type": "integer",
"format": "int32"
},
"tvRageId": {
"type": "integer",
"format": "int32"
},
"imdbId": {
"type": "string",
"nullable": true
},
"rejections": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"publishDate": {
"type": "string",
"format": "date-time"
},
"commentUrl": {
"type": "string",
"nullable": true
},
"downloadUrl": {
"type": "string",
"nullable": true
},
"infoUrl": {
"type": "string",
"nullable": true
},
"episodeRequested": {
"type": "boolean"
},
"downloadAllowed": {
"type": "boolean"
},
"releaseWeight": {
"type": "integer",
"format": "int32"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"sceneMapping": {
"$ref": "#/components/schemas/AlternateTitleResource"
},
"magnetUrl": {
"type": "string",
"nullable": true
},
"infoHash": {
"type": "string",
"nullable": true
},
"seeders": {
"type": "integer",
"format": "int32",
"nullable": true
},
"leechers": {
"type": "integer",
"format": "int32",
"nullable": true
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"isDaily": {
"type": "boolean"
},
"isAbsoluteNumbering": {
"type": "boolean"
},
"isPossibleSpecialEpisode": {
"type": "boolean"
},
"special": {
"type": "boolean"
},
"seriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"episodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"downloadClientId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"downloadClient": {
"type": "string",
"nullable": true
},
"shouldOverride": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseType": {
"enum": [
"unknown",
"singleEpisode",
"multiEpisode",
"seasonPack"
],
"type": "string"
},
"RemotePathMappingResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"host": {
"type": "string",
"nullable": true
},
"remotePath": {
"type": "string",
"nullable": true
},
"localPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RenameEpisodeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"episodeNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"episodeFileId": {
"type": "integer",
"format": "int32"
},
"existingPath": {
"type": "string",
"nullable": true
},
"newPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RescanAfterRefreshType": {
"enum": [
"always",
"afterManual",
"never"
],
"type": "string"
},
"Revision": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"format": "int32"
},
"real": {
"type": "integer",
"format": "int32"
},
"isRepack": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RootFolderResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"accessible": {
"type": "boolean"
},
"freeSpace": {
"type": "integer",
"format": "int64",
"nullable": true
},
"unmappedFolders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UnmappedFolder"
},
"nullable": true
}
},
"additionalProperties": false
},
"RuntimeMode": {
"enum": [
"console",
"service",
"tray"
],
"type": "string"
},
"SeasonPassResource": {
"type": "object",
"properties": {
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeasonPassSeriesResource"
},
"nullable": true
},
"monitoringOptions": {
"$ref": "#/components/schemas/MonitoringOptions"
}
},
"additionalProperties": false
},
"SeasonPassSeriesResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"monitored": {
"type": "boolean",
"nullable": true
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeasonResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"SeasonResource": {
"type": "object",
"properties": {
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"monitored": {
"type": "boolean"
},
"statistics": {
"$ref": "#/components/schemas/SeasonStatisticsResource"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
}
},
"additionalProperties": false
},
"SeasonStatisticsResource": {
"type": "object",
"properties": {
"nextAiring": {
"type": "string",
"format": "date-time",
"nullable": true
},
"previousAiring": {
"type": "string",
"format": "date-time",
"nullable": true
},
"episodeFileCount": {
"type": "integer",
"format": "int32"
},
"episodeCount": {
"type": "integer",
"format": "int32"
},
"totalEpisodeCount": {
"type": "integer",
"format": "int32"
},
"sizeOnDisk": {
"type": "integer",
"format": "int64"
},
"releaseGroups": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"percentOfEpisodes": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"SelectOption": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"hint": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SeriesEditorResource": {
"type": "object",
"properties": {
"seriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"monitored": {
"type": "boolean",
"nullable": true
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"seriesType": {
"$ref": "#/components/schemas/SeriesTypes"
},
"seasonFolder": {
"type": "boolean",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"moveFiles": {
"type": "boolean"
},
"deleteFiles": {
"type": "boolean"
},
"addImportListExclusion": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SeriesResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"alternateTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlternateTitleResource"
},
"nullable": true
},
"sortTitle": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SeriesStatusType"
},
"ended": {
"type": "boolean",
"readOnly": true
},
"profileName": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"nextAiring": {
"type": "string",
"format": "date-time",
"nullable": true
},
"previousAiring": {
"type": "string",
"format": "date-time",
"nullable": true
},
"network": {
"type": "string",
"nullable": true
},
"airTime": {
"type": "string",
"nullable": true
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"originalLanguage": {
"$ref": "#/components/schemas/Language"
},
"remotePoster": {
"type": "string",
"nullable": true
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeasonResource"
},
"nullable": true
},
"year": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32"
},
"seasonFolder": {
"type": "boolean"
},
"monitored": {
"type": "boolean"
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"useSceneNumbering": {
"type": "boolean"
},
"runtime": {
"type": "integer",
"format": "int32"
},
"tvdbId": {
"type": "integer",
"format": "int32"
},
"tvRageId": {
"type": "integer",
"format": "int32"
},
"tvMazeId": {
"type": "integer",
"format": "int32"
},
"tmdbId": {
"type": "integer",
"format": "int32"
},
"firstAired": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastAired": {
"type": "string",
"format": "date-time",
"nullable": true
},
"seriesType": {
"$ref": "#/components/schemas/SeriesTypes"
},
"cleanTitle": {
"type": "string",
"nullable": true
},
"imdbId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"folder": {
"type": "string",
"nullable": true
},
"certification": {
"type": "string",
"nullable": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"added": {
"type": "string",
"format": "date-time"
},
"addOptions": {
"$ref": "#/components/schemas/AddSeriesOptions"
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"statistics": {
"$ref": "#/components/schemas/SeriesStatisticsResource"
},
"episodesChanged": {
"type": "boolean",
"nullable": true
},
"languageProfileId": {
"type": "integer",
"format": "int32",
"readOnly": true,
"deprecated": true
}
},
"additionalProperties": false
},
"SeriesStatisticsResource": {
"type": "object",
"properties": {
"seasonCount": {
"type": "integer",
"format": "int32"
},
"episodeFileCount": {
"type": "integer",
"format": "int32"
},
"episodeCount": {
"type": "integer",
"format": "int32"
},
"totalEpisodeCount": {
"type": "integer",
"format": "int32"
},
"sizeOnDisk": {
"type": "integer",
"format": "int64"
},
"releaseGroups": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"percentOfEpisodes": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"SeriesStatusType": {
"enum": [
"continuing",
"ended",
"upcoming",
"deleted"
],
"type": "string"
},
"SeriesTitleInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"titleWithoutYear": {
"type": "string",
"nullable": true
},
"year": {
"type": "integer",
"format": "int32"
},
"allTitles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SeriesTypes": {
"enum": [
"standard",
"daily",
"anime"
],
"type": "string"
},
"SortDirection": {
"enum": [
"default",
"ascending",
"descending"
],
"type": "string"
},
"SystemResource": {
"type": "object",
"properties": {
"appName": {
"type": "string",
"nullable": true
},
"instanceName": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"buildTime": {
"type": "string",
"format": "date-time"
},
"isDebug": {
"type": "boolean"
},
"isProduction": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isUserInteractive": {
"type": "boolean"
},
"startupPath": {
"type": "string",
"nullable": true
},
"appData": {
"type": "string",
"nullable": true
},
"osName": {
"type": "string",
"nullable": true
},
"osVersion": {
"type": "string",
"nullable": true
},
"isNetCore": {
"type": "boolean"
},
"isLinux": {
"type": "boolean"
},
"isOsx": {
"type": "boolean"
},
"isWindows": {
"type": "boolean"
},
"isDocker": {
"type": "boolean"
},
"mode": {
"$ref": "#/components/schemas/RuntimeMode"
},
"branch": {
"type": "string",
"nullable": true
},
"authentication": {
"$ref": "#/components/schemas/AuthenticationType"
},
"sqliteVersion": {
"type": "string",
"nullable": true
},
"migrationVersion": {
"type": "integer",
"format": "int32"
},
"urlBase": {
"type": "string",
"nullable": true
},
"runtimeVersion": {
"type": "string",
"nullable": true
},
"runtimeName": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"packageVersion": {
"type": "string",
"nullable": true
},
"packageAuthor": {
"type": "string",
"nullable": true
},
"packageUpdateMechanism": {
"$ref": "#/components/schemas/UpdateMechanism"
},
"packageUpdateMechanismMessage": {
"type": "string",
"nullable": true
},
"databaseVersion": {
"type": "string",
"nullable": true
},
"databaseType": {
"$ref": "#/components/schemas/DatabaseType"
}
},
"additionalProperties": false
},
"TagDetailsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"label": {
"type": "string",
"nullable": true
},
"delayProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"importListIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"notificationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"restrictionIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"indexerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"downloadClientIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"autoTagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"seriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"TagResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"label": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TaskResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"taskName": {
"type": "string",
"nullable": true
},
"interval": {
"type": "integer",
"format": "int32"
},
"lastExecution": {
"type": "string",
"format": "date-time"
},
"lastStartTime": {
"type": "string",
"format": "date-time"
},
"nextExecution": {
"type": "string",
"format": "date-time"
},
"lastDuration": {
"type": "string",
"format": "date-span",
"readOnly": true
}
},
"additionalProperties": false
},
"TrackedDownloadState": {
"enum": [
"downloading",
"importBlocked",
"importPending",
"importing",
"imported",
"failedPending",
"failed",
"ignored"
],
"type": "string"
},
"TrackedDownloadStatus": {
"enum": [
"ok",
"warning",
"error"
],
"type": "string"
},
"TrackedDownloadStatusMessage": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"UiConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"firstDayOfWeek": {
"type": "integer",
"format": "int32"
},
"calendarWeekColumnHeader": {
"type": "string",
"nullable": true
},
"shortDateFormat": {
"type": "string",
"nullable": true
},
"longDateFormat": {
"type": "string",
"nullable": true
},
"timeFormat": {
"type": "string",
"nullable": true
},
"showRelativeDates": {
"type": "boolean"
},
"enableColorImpairedMode": {
"type": "boolean"
},
"theme": {
"type": "string",
"nullable": true
},
"uiLanguage": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"UnmappedFolder": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"relativePath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateChanges": {
"type": "object",
"properties": {
"new": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fixed": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateMechanism": {
"enum": [
"builtIn",
"script",
"external",
"apt",
"docker"
],
"type": "string"
},
"UpdateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"version": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"releaseDate": {
"type": "string",
"format": "date-time"
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"installed": {
"type": "boolean"
},
"installedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"installable": {
"type": "boolean"
},
"latest": {
"type": "boolean"
},
"changes": {
"$ref": "#/components/schemas/UpdateChanges"
},
"hash": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"X-Api-Key": {
"type": "apiKey",
"description": "Apikey passed as header",
"name": "X-Api-Key",
"in": "header"
},
"apikey": {
"type": "apiKey",
"description": "Apikey passed as query parameter",
"name": "apikey",
"in": "query"
}
}
},
"security": [
{
"X-Api-Key": []
},
{
"apikey": []
}
]
}