mirror of
https://github.com/BreizhHardware/Jellystat.git
synced 2026-01-18 16:27:20 +01:00
4181 lines
89 KiB
JSON
4181 lines
89 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Jellystat API Documentation",
|
|
"description": "",
|
|
"version": "1.0.0"
|
|
},
|
|
"host": "",
|
|
"basePath": "/",
|
|
"tags": [
|
|
{
|
|
"name": "API",
|
|
"description": "Jellystat API Endpoints"
|
|
},
|
|
{
|
|
"name": "Auth",
|
|
"description": "Jellystat Auth Endpoints"
|
|
},
|
|
{
|
|
"name": "Proxy",
|
|
"description": "Jellyfin Proxied Endpoints"
|
|
},
|
|
{
|
|
"name": "Stats",
|
|
"description": "Jellystat Statisitc Endpoints"
|
|
},
|
|
{
|
|
"name": "Sync",
|
|
"description": "Jellystat Sync Endpoints"
|
|
},
|
|
{
|
|
"name": "Backup",
|
|
"description": "Jellystat Backup/Restore Endpoints"
|
|
},
|
|
{
|
|
"name": "Logs",
|
|
"description": "Jellystat Log Endpoints"
|
|
}
|
|
],
|
|
"schemes": [
|
|
"http",
|
|
"https"
|
|
],
|
|
"securityDefinitions": {
|
|
"apiKey": {
|
|
"type": "apiKey",
|
|
"name": "x-api-token",
|
|
"in": "header"
|
|
}
|
|
},
|
|
"paths": {
|
|
"/auth/login": {
|
|
"post": {
|
|
"tags": [
|
|
"Auth"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"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/isConfigured": {
|
|
"get": {
|
|
"tags": [
|
|
"Auth"
|
|
],
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/createuser": {
|
|
"post": {
|
|
"tags": [
|
|
"Auth"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"example": "any"
|
|
},
|
|
"password": {
|
|
"example": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/configSetup": {
|
|
"post": {
|
|
"tags": [
|
|
"Auth"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/web/assets/img/devices/": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "devicename",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/Items/Images/Backdrop/": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "fillWidth",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "quality",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "blur",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/Items/Images/Primary/": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "fillWidth",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "quality",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/Users/Images/Primary/": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "fillWidth",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "quality",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/getSessions": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"503": {
|
|
"description": "Service Unavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/getAdminUsers": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"503": {
|
|
"description": "Service Unavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/getRecentlyAdded": {
|
|
"get": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "libraryid",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"503": {
|
|
"description": "Service Unavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/proxy/validateSettings": {
|
|
"post": {
|
|
"tags": [
|
|
"Proxy"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"example": "any"
|
|
},
|
|
"apikey": {
|
|
"example": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/getconfig": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/getRecentlyAdded": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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/setconfig": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/setExternalUrl": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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/updateCredentials": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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/updatePassword": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/UntrackedUsers": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/keys": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/getTaskSettings": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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/CheckForUpdates": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/getUserDetails": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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/getLibrary": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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/getLibraryItems": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/getSeasons": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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/getActivityTimeLine": {
|
|
"post": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"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/stopTask": {
|
|
"get": {
|
|
"tags": [
|
|
"API"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/stats/getLibraryOverview": {
|
|
"get": {
|
|
"tags": [
|
|
"Stats"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"503": {
|
|
"description": "Service Unavailable"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/stats/getAllUserActivity": {
|
|
"get": {
|
|
"tags": [
|
|
"Stats"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/stats/getUserLastPlayed": {
|
|
"post": {
|
|
"tags": [
|
|
"Stats"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"503": {
|
|
"description": "Service Unavailable"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Stats"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/stats/getLibraryItemsPlayMethodStats": {
|
|
"post": {
|
|
"tags": [
|
|
"Stats"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Backup"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/logs/getLogs": {
|
|
"get": {
|
|
"tags": [
|
|
"Logs"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/utils/geolocateIp": {
|
|
"post": {
|
|
"tags": [
|
|
"Utils"
|
|
],
|
|
"description": "",
|
|
"parameters": [
|
|
{
|
|
"name": "authorization",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "x-api-token",
|
|
"in": "header",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "req",
|
|
"in": "query",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
]
|
|
} |