{ "swagger": "2.0", "info": { "title": "JellyGlance API", "description": "JellyGlance REST API. Widget and most /api routes accept a Glance API key as x-api-token, or a session Bearer token.", "version": "1.0.0" }, "host": "", "basePath": "/", "tags": [ { "name": "API", "description": "JellyGlance API Endpoints" }, { "name": "Widgets", "description": "Token-auth snapshots for Homepage, Homarr, and automation" }, { "name": "Auth", "description": "JellyGlance Auth Endpoints" }, { "name": "Proxy", "description": "Jellyfin Proxied Endpoints" }, { "name": "Stats", "description": "JellyGlance Statisitc Endpoints" }, { "name": "Sync", "description": "JellyGlance Sync Endpoints" }, { "name": "Backup", "description": "JellyGlance Backup/Restore Endpoints" }, { "name": "Logs", "description": "JellyGlance Log Endpoints" } ], "schemes": [ "http", "https" ], "securityDefinitions": { "apiKey": { "type": "apiKey", "name": "x-api-token", "in": "header" } }, "paths": { "/backup/first-run/restore": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/first-run/restore/status": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/webhook-cards/{id.jpg}": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "image/jpeg" ], "parameters": [ { "name": "id.jpg", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/backup-download/{filename}": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "ticket", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/swagger.json": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/auth/login": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "username": { "example": "any" }, "password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/jellyfin-quick-connect/initiate": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "502": { "description": "Bad Gateway" } } } }, "/auth/jellyfin-quick-connect/status": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "secret", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "502": { "description": "Bad Gateway" } } } }, "/auth/jellyfin-quick-connect/complete": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "secret": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "502": { "description": "Bad Gateway" } } } }, "/auth/oidc/login": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/oidc/callback": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "code", "in": "query", "type": "string" }, { "name": "state", "in": "query", "type": "string" }, { "name": "error", "in": "query", "type": "string" }, { "name": "error_description", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/isConfigured": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/background-posters": { "get": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "limit", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/createuser": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "username": { "example": "any" }, "password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/setup-auth": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "mode": { "example": "any" }, "username": { "example": "any" }, "password": { "example": "any" }, "issuerUrl": { "example": "any" }, "clientId": { "example": "any" }, "clientSecret": { "example": "any" }, "redirectUri": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/test-jellyfin": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "JF_HOST": { "example": "any" }, "JF_API_KEY": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/auth/configSetup": { "post": { "tags": [ "Auth" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "JF_HOST": { "example": "any" }, "JF_API_KEY": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/item-glance/{id}": { "get": { "tags": [ "Widgets" ], "summary": "One title across Jellyfin, Seerr, Arr, and downloads", "description": "One Jellyfin title correlated with Seerr, Arr, and downloads.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "description": "Jellyfin item id" }, { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "One title across Jellyfin, Seerr, Arr, and downloads" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Item not found" }, "503": { "description": "Unable to load widget" } } } }, "/api/downloads/stitched": { "get": { "tags": [ "Widgets" ], "summary": "Download queue matched to Seerr requests", "description": "Download queue matched to Seerr requests", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Download queue matched to Seerr requests" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/ops-digest": { "get": { "tags": [ "Widgets" ], "summary": "Ops items that need attention", "description": "Stalled downloads, failed webhooks, and recent audit failures.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Ops items that need attention" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/library-storage": { "get": { "tags": [ "Widgets" ], "summary": "Per-library sizes and upcoming estimate", "description": "Per-library sizes and upcoming estimate", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Per-library sizes and upcoming estimate" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets": { "get": { "tags": [ "Widgets" ], "summary": "Catalog of token-auth widget endpoints", "description": "Catalog of compact token-auth widget endpoints. Send the Glance API key as x-api-token.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Catalog of token-auth widget endpoints" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/homepage": { "get": { "tags": [ "Widgets" ], "summary": "Dashboard snapshot: sessions, catalog, downloads, digest, storage, invites, calendar", "description": "Dashboard snapshot: sessions, catalog, downloads, digest, storage, invites, calendar", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Dashboard snapshot: sessions, catalog, downloads, digest, storage, invites, calendar" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/sessions": { "get": { "tags": [ "Widgets" ], "summary": "Recent, today, and 24h playback counts", "description": "Recent, today, and 24h playback counts", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Recent, today, and 24h playback counts" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/downloads": { "get": { "tags": [ "Widgets" ], "summary": "Queue counts plus a compact item list", "description": "Queue counts plus a compact item list", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Queue counts plus a compact item list" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/calendar": { "get": { "tags": [ "Widgets" ], "summary": "Arr releases today and upcoming", "description": "Arr releases today and upcoming", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Arr releases today and upcoming" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/libraries": { "get": { "tags": [ "Widgets" ], "summary": "Per-library sizes and catalog totals", "description": "Per-library sizes and catalog totals", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Per-library sizes and catalog totals" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/health": { "get": { "tags": [ "Widgets" ], "summary": "Digest, live Jellyfin ping, and backup hint", "description": "Digest, live Jellyfin ping, and backup hint", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Digest, live Jellyfin ping, and backup hint" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/requests": { "get": { "tags": [ "Widgets" ], "summary": "Seerr request counts by status", "description": "Seerr request counts by status", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Seerr request counts by status" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/sessions/stop": { "post": { "tags": [ "Widgets" ], "summary": "Stop a live Jellyfin session", "description": "Requires a widgets-write or full API key, or an admin session. Body: { sessionId }.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Session stopped" }, "400": { "description": "Missing sessionId" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to stop session" } } } }, "/api/widgets/downloads/pause": { "post": { "tags": [ "Widgets" ], "summary": "Pause or resume a download", "description": "Requires a widgets-write or full API key, or an admin session. Body: { id, paused }.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Download updated" }, "400": { "description": "Missing download id" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to update download" } } } }, "/api/widgets/requests/actions": { "post": { "tags": [ "Widgets" ], "summary": "Approve, decline, or retry a Seerr request", "description": "Requires a widgets-write or full API key, or an admin session. Body: { requestId, sourceId, action }.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Request updated" }, "400": { "description": "Missing requestId or action" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to update request" } } } }, "/api/widgets/repair/refresh": { "post": { "tags": [ "Widgets" ], "summary": "Refresh a Jellyfin item", "description": "Requires a widgets-write or full API key, or an admin session. Body: { itemId, recursive? }.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Refresh queued" }, "400": { "description": "Missing itemId" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to refresh item" } } } }, "/api/admin-audit/export": { "get": { "tags": [ "API" ], "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/admin-audit/retention": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/setBackupDestination": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "kind": { "example": "any" }, "url": { "example": "any" }, "username": { "example": "any" }, "secret": { "example": "any" }, "bucket": { "example": "any" }, "region": { "example": "any" }, "prefix": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/autobrr/hits": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/retry-grab": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } } } }, "/api/preferences": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } }, "put": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/jellyfin/status": { "get": { "tags": [ "Widgets" ], "summary": "Live Jellyfin reachability and version", "description": "Live Jellyfin reachability, server name, and version.", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Live Jellyfin reachability and version" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/jellyfin/refresh-item": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/jellyfin/refresh-library": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/health": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/home/operations": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/admin-audit": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/home": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/summary": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/search": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/media-detail": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/options": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/automation-health": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/issues": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/issues/{issueId}/actions": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "issueId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/{requestId}/detail": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/media": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/{requestId}/actions": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/requests/{requestId}/edit": { "put": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/users/{userId}/media-lists": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/users/{userId}/media/{itemId}/actions": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" }, { "name": "itemId", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getconfig": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/notification-settings": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } }, "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getLibraries": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getRecentlyAdded": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "libraryid", "in": "query", "type": "string" }, { "name": "limit", "in": "query", "type": "string" }, { "name": "GroupResults", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getRecentlyAddedShelves": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "limit", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setconfig": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "JF_HOST": { "example": "any" }, "JF_API_KEY": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/setExternalUrl": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "ExternalUrl": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setPreferredAdmin": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "userid": { "example": "any" }, "username": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/setRequireLogin": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "REQUIRE_LOGIN": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/setAuthMode": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "mode": { "example": "any" }, "username": { "example": "any" }, "password": { "example": "any" }, "issuerUrl": { "example": "any" }, "clientId": { "example": "any" }, "clientSecret": { "example": "any" }, "redirectUri": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable" } } } }, "/api/updateCredentials": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "username": { "example": "any" }, "current_password": { "example": "any" }, "new_password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/userAccess": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable" } } } }, "/api/roles": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "role": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/api/roles/{role}": { "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "role", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/roles/{role}/permissions": { "patch": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "role", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "permissions": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/localUsers": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "username": { "example": "any" }, "password": { "example": "any" }, "role": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/api/localUsers/{id}": { "patch": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "role": { "example": "any" }, "password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/primaryLocalPassword": { "patch": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/userRoles/{userid}": { "patch": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "userid", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "role": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/updatePassword": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "current_password": { "example": "any" }, "new_password": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/TrackedLibraries": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setExcludedLibraries": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryID": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/library-display-settings": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "showLibraryCardNames": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/UntrackedUsers": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setUntrackedUsers": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "userId": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/keys": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "key": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "name": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "key": { "example": "any" }, "scope": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getTaskSettings": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setTaskSettings": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "taskname": { "example": "any" }, "Interval": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getActivityMonitorSettings": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setActivityMonitorSettings": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "activeSessionsInterval": { "example": "any" }, "idleInterval": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/CheckForUpdates": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/CheckForUpdates/releases": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/github/contributors": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getUserDetails": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "userid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getLibrary": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getLibraryItems": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getSeasons": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "Id": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getEpisodes": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "Id": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getItemDetails": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "Id": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/item/purge": { "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "id": { "example": "any" }, "withActivity": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/library/purge": { "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "id": { "example": "any" }, "withActivity": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/libraryItems/purge": { "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "id": { "example": "any" }, "withActivity": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getBackupTables": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/setExcludedBackupTable": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "table": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getHistory": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string", "enum": [ "UserName", "RemoteEndPoint", "NowPlayingItemName", "Client", "DeviceName", "ActivityDateInserted", "PlaybackDuration", "TotalPlays" ] }, { "name": "desc", "in": "query", "type": "string" }, { "name": "filters", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/getLibraryHistory": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string", "enum": [ "UserName", "RemoteEndPoint", "NowPlayingItemName", "Client", "DeviceName", "ActivityDateInserted", "PlaybackDuration", "TotalPlays" ] }, { "name": "desc", "in": "query", "type": "string" }, { "name": "filters", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getItemHistory": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string", "enum": [ "UserName", "RemoteEndPoint", "NowPlayingItemName", "Client", "DeviceName", "ActivityDateInserted", "PlaybackDuration" ] }, { "name": "desc", "in": "query", "type": "string" }, { "name": "filters", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "itemid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getUserHistory": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string", "enum": [ "UserName", "RemoteEndPoint", "NowPlayingItemName", "Client", "DeviceName", "ActivityDateInserted", "PlaybackDuration" ] }, { "name": "desc", "in": "query", "type": "string" }, { "name": "filters", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "userid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/deletePlaybackActivity": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "ids": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getTimelineUsers": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/getActivityTimeLine": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "limit": { "example": "any" }, "offset": { "example": "any" }, "userId": { "example": "any" }, "libraries": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } }, "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/first-run/extras-complete": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/first-run/start-sync": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations/health-history": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations/test-all": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations/test": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "integration": { "example": "any" }, "type": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/maintainerr": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/maintainerr/actions": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "action": { "example": "any" }, "collectionId": { "example": "any" }, "itemId": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/wizarr/summary": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/wizarr/invitations": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "serverIds": { "example": "any" }, "libraryIds": { "example": "any" }, "expiresInDays": { "example": "any" }, "duration": { "example": "any" }, "wizardBundleId": { "example": "any" }, "customCode": { "example": "any" }, "sendEmail": { "example": "any" }, "emailRecipient": { "example": "any" }, "unlimited": { "example": "any" }, "allowDownloads": { "example": "any" }, "allowLiveTv": { "example": "any" }, "allowMobileUploads": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/wizarr/invitations/{id}": { "delete": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/tdarr/transcodes": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/tdarr/actions": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations/calendar": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/integrations/downloads": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/downloads/add": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "client": { "example": "any" }, "instanceId": { "example": "any" }, "value": { "example": "any" }, "fileName": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/downloads/remove": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/downloads/pause": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/sessions/stop": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/sessions/message": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/stopTask": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "task", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/server-management/status": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/server-management/action": { "post": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "triggers": { "example": "any" }, "action": { "example": "any" }, "taskId": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/jellyfin/devices": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/jellyfin/plugins": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/api/startTask": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "task", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } } } }, "/api/newsletter/my-subscriptions": { "get": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } }, "put": { "tags": [ "API" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "extraRecipients": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/repair-hub": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getLibraryOverview": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getHomeDashboard": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getMostViewedByType": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" }, "type": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getMostPopularByType": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" }, "type": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getMostViewedLibraries": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getMostUsedClient": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getMostActiveUsers": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getPlaybackActivity": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string" }, { "name": "desc", "in": "query", "type": "string" }, { "name": "filters", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getAllUserActivity": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/stats/getUserWrapUp": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getUserProfileWrapUp": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "user", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getUserLastPlayed": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "userid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getGlobalUserStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "hours": { "example": "any" }, "userid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getGlobalItemStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "hours": { "example": "any" }, "itemid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getGlobalLibraryStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "hours": { "example": "any" }, "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getLibraryCardStats": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } }, "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getLibraryMetadata": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getLibraryItemsWithStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "search", "in": "query", "type": "string" }, { "name": "sort", "in": "query", "type": "string" }, { "name": "desc", "in": "query", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/stats/getLibraryItemsPlayMethodStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" }, "startDate": { "example": "any" }, "endDate": { "example": "any" }, "hours": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/stats/getPlaybackMethodStats": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "days": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getLibraryLastPlayed": { "post": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "libraryid": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getViewsOverTime": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "days", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getViewsByDays": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "days", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getViewsByHour": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "days", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getViewsByLibraryType": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "days", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getGenreUserStats": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "userid", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/stats/getGenreLibraryStats": { "get": { "tags": [ "Stats" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "size", "in": "query", "type": "string" }, { "name": "page", "in": "query", "type": "string" }, { "name": "libraryid", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/backup/beginBackup": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/restore/{filename}": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/files": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/summary": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/files/{filename}/ticket": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/files/{filename}": { "get": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/backup/upload": { "post": { "tags": [ "Backup" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/tautulli/backups": { "get": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "path", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/preview": { "post": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/upload-preview": { "post": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/import": { "post": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/unmatched": { "get": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "limit", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/unmatched-users": { "get": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/search-media": { "get": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "search", "in": "query", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/link-media": { "post": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "ids": { "example": "any" }, "Id": { "example": "any" }, "id": { "example": "any" }, "Type": { "example": "any" }, "type": { "example": "any" }, "SeriesId": { "example": "any" }, "Name": { "example": "any" }, "name": { "example": "any" }, "EpisodeId": { "example": "any" }, "SeasonId": { "example": "any" }, "SeriesName": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/tautulli/link-user": { "post": { "tags": [ "Tautulli" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "Id": { "example": "any" }, "Name": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/jellystat/upload-preview": { "post": { "tags": [ "Jellystat" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/jellystat/import": { "post": { "tags": [ "Jellystat" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/jellystat/unmatched-users": { "get": { "tags": [ "Jellystat" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/jellystat/link-user": { "post": { "tags": [ "Jellystat" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "Id": { "example": "any" }, "Name": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/logs/getLogs": { "get": { "tags": [ "Logs" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/utils/geolocateIp": { "post": { "tags": [ "Utils" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "ipAddress": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "501": { "description": "Not Implemented" }, "503": { "description": "Service Unavailable" } } } }, "/webhooks/": { "get": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "name": { "example": "any" }, "url": { "example": "any" }, "headers": { "example": "any" }, "payload": { "example": "any" }, "method": { "example": "any" }, "webhook_type": { "example": "any" }, "trigger_type": { "example": "any" }, "schedule": { "example": "any" }, "event_type": { "example": "any" }, "enabled": { "example": "any" }, "retry_on_failure": { "example": "any" }, "max_retries": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/event-status": { "get": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/delivery-history": { "get": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/quiet-hours": { "get": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "events": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/retry/{id}": { "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "name": { "example": "any" }, "url": { "example": "any" }, "headers": { "example": "any" }, "payload": { "example": "any" }, "method": { "example": "any" }, "webhook_type": { "example": "any" }, "trigger_type": { "example": "any" }, "schedule": { "example": "any" }, "event_type": { "example": "any" }, "enabled": { "example": "any" }, "retry_on_failure": { "example": "any" }, "max_retries": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/{id}/test": { "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/{id}/trigger-monthly": { "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/webhooks/toggle-event/{eventType}": { "post": { "tags": [ "Webhooks" ], "description": "", "produces": [ "nosniff" ], "parameters": [ { "name": "eventType", "in": "path", "required": true, "type": "string" }, { "name": "map((item", "in": "query", "type": "string" }, { "name": "authorization", "in": "header", "type": "string" }, { "name": "x-api-token", "in": "header", "type": "string" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "url": { "example": "any" }, "enabled": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/item-glance/{id}": { "get": { "tags": [ "Widgets" ], "summary": "Item glance", "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" }, "503": { "description": "Service Unavailable" } } } }, "/downloads/stitched": { "get": { "tags": [ "Widgets" ], "summary": "Downloads with matching requests", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/ops-digest": { "get": { "tags": [ "Widgets" ], "summary": "Ops digest", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/library-storage": { "get": { "tags": [ "Widgets" ], "summary": "Library storage", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets": { "get": { "tags": [ "Widgets" ], "summary": "List widget endpoints", "description": "", "responses": { "200": { "description": "OK" } } } }, "/widgets/homepage": { "get": { "tags": [ "Widgets" ], "summary": "Dashboard snapshot", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/sessions": { "get": { "tags": [ "Widgets" ], "summary": "Playback counts", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/downloads": { "get": { "tags": [ "Widgets" ], "summary": "Download queue snapshot", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/calendar": { "get": { "tags": [ "Widgets" ], "summary": "Arr calendar snapshot", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/libraries": { "get": { "tags": [ "Widgets" ], "summary": "Library sizes", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/health": { "get": { "tags": [ "Widgets" ], "summary": "Ops and Jellyfin health", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/requests": { "get": { "tags": [ "Widgets" ], "summary": "Seerr request counts", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/sessions/stop": { "post": { "tags": [ "Widgets" ], "summary": "Stop a live session", "description": "", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/downloads/pause": { "post": { "tags": [ "Widgets" ], "summary": "Pause or resume a download", "description": "", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/requests/actions": { "post": { "tags": [ "Widgets" ], "summary": "Approve, decline, or retry a request", "description": "", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "503": { "description": "Service Unavailable" } } } }, "/widgets/repair/refresh": { "post": { "tags": [ "Widgets" ], "summary": "Refresh a Jellyfin item", "description": "", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "503": { "description": "Service Unavailable" } } } }, "/admin-audit/export": { "get": { "description": "", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/admin-audit/retention": { "post": { "description": "", "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } } } }, "/setBackupDestination": { "post": { "description": "", "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "kind": { "example": "any" }, "url": { "example": "any" }, "username": { "example": "any" }, "secret": { "example": "any" }, "bucket": { "example": "any" }, "region": { "example": "any" }, "prefix": { "example": "any" } } } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } } } }, "/autobrr/hits": { "get": { "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/retry-grab": { "post": { "description": "", "responses": { "200": { "description": "OK" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } } } }, "/preferences": { "get": { "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } }, "put": { "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/jellyfin/status": { "get": { "tags": [ "Widgets" ], "summary": "Jellyfin status", "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/jellyfin/refresh-item": { "post": { "description": "", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "503": { "description": "Service Unavailable" } } } }, "/jellyfin/refresh-library": { "post": { "description": "", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/api/widgets/catalog": { "get": { "tags": [ "Widgets" ], "summary": "Movies, shows, episodes, and items added this week", "description": "Movies, shows, episodes, and items added this week", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Movies, shows, episodes, and items added this week" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/storage": { "get": { "tags": [ "Widgets" ], "summary": "Library storage total and upcoming Arr estimate", "description": "Library storage total and upcoming Arr estimate", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Library storage total and upcoming Arr estimate" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/nowplaying": { "get": { "tags": [ "Widgets" ], "summary": "Live Jellyfin sessions playing right now", "description": "Live Jellyfin sessions playing right now", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Live Jellyfin sessions playing right now" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/viewers": { "get": { "tags": [ "Widgets" ], "summary": "Distinct viewers today and synced user count", "description": "Distinct viewers today and synced user count", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Distinct viewers today and synced user count" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/users": { "get": { "tags": [ "Widgets" ], "summary": "User roster with last activity", "description": "User roster with last activity", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "User roster with last activity" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/activity": { "get": { "tags": [ "Widgets" ], "summary": "Latest playback rows", "description": "Latest playback rows", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Latest playback rows" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/watch": { "get": { "tags": [ "Widgets" ], "summary": "Watch-time totals for today, week, and all time", "description": "Watch-time totals for today, week, and all time", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Watch-time totals for today, week, and all time" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/statistics": { "get": { "tags": [ "Widgets" ], "summary": "Top titles and users this week", "description": "Top titles and users this week", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Top titles and users this week" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/repair": { "get": { "tags": [ "Widgets" ], "summary": "Missing posters, runtime, and unmatched imports", "description": "Missing posters, runtime, and unmatched imports", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Missing posters, runtime, and unmatched imports" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/recent": { "get": { "tags": [ "Widgets" ], "summary": "Recently added library titles", "description": "Recently added library titles", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Recently added library titles" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/stalled": { "get": { "tags": [ "Widgets" ], "summary": "Stalled or failed download items", "description": "Stalled or failed download items", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Stalled or failed download items" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/stitched": { "get": { "tags": [ "Widgets" ], "summary": "Cached download queue without a live Seerr call", "description": "Cached download queue without a live Seerr call", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Cached download queue without a live Seerr call" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/today": { "get": { "tags": [ "Widgets" ], "summary": "Arr releases due today", "description": "Arr releases due today", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Arr releases due today" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/issues": { "get": { "tags": [ "Widgets" ], "summary": "Seerr issue counts by status", "description": "Seerr issue counts by status", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Seerr issue counts by status" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/invites": { "get": { "tags": [ "Widgets" ], "summary": "Cached Wizarr invite links", "description": "Cached Wizarr invite links", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Cached Wizarr invite links" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/autobrr": { "get": { "tags": [ "Widgets" ], "summary": "Cached autobrr release hits", "description": "Cached autobrr release hits", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Cached autobrr release hits" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/transcodes": { "get": { "tags": [ "Widgets" ], "summary": "Tdarr active, queued, and error counts", "description": "Tdarr active, queued, and error counts", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Tdarr active, queued, and error counts" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/maintainerr": { "get": { "tags": [ "Widgets" ], "summary": "Maintainerr cleanup counts and reclaimable size", "description": "Maintainerr cleanup counts and reclaimable size", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Maintainerr cleanup counts and reclaimable size" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/automation": { "get": { "tags": [ "Widgets" ], "summary": "Latest integration health results", "description": "Latest integration health results", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Latest integration health results" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/devices": { "get": { "tags": [ "Widgets" ], "summary": "Known Jellyfin client devices", "description": "Known Jellyfin client devices", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Known Jellyfin client devices" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/digest": { "get": { "tags": [ "Widgets" ], "summary": "Ops digest items that need attention", "description": "Ops digest items that need attention", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Ops digest items that need attention" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/backup": { "get": { "tags": [ "Widgets" ], "summary": "Last backup hint and destination kind", "description": "Last backup hint and destination kind", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Last backup hint and destination kind" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/webhooks": { "get": { "tags": [ "Widgets" ], "summary": "Recent webhook deliveries", "description": "Recent webhook deliveries", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Recent webhook deliveries" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/jobs": { "get": { "tags": [ "Widgets" ], "summary": "Latest Glance task runs", "description": "Latest Glance task runs", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Latest Glance task runs" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/jellyfin-jobs": { "get": { "tags": [ "Widgets" ], "summary": "Live Jellyfin scheduled tasks", "description": "Live Jellyfin scheduled tasks", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Live Jellyfin scheduled tasks" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } }, "/api/widgets/newsletter": { "get": { "tags": [ "Widgets" ], "summary": "Last newsletter send and next digest", "description": "Last newsletter send and next digest", "parameters": [ { "name": "x-api-token", "in": "header", "type": "string", "required": true }, { "name": "authorization", "in": "header", "type": "string", "description": "Bearer session token also works" } ], "responses": { "200": { "description": "Last newsletter send and next digest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "503": { "description": "Unable to load widget" } } } } }, "security": [ { "apiKey": [] } ], "definitions": { "WidgetSnapshot": { "type": "object", "properties": { "jellyglance": { "type": "boolean", "example": true }, "sessionsRecent": { "type": "integer" }, "sessionsToday": { "type": "integer" }, "downloads": { "type": "integer" }, "digest": { "type": "integer" }, "digestOk": { "type": "boolean" }, "storage": { "type": "string" }, "updatedAt": { "type": "string" } } } } }