api.json 167 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621
  1. {
  2. "openapi": "3.0.0",
  3. "info": {
  4. "title": "Organizr API",
  5. "description": "Organizr - Accept no others",
  6. "version": "2.0"
  7. },
  8. "servers": [
  9. {
  10. "url": "https://organizr.dev/",
  11. "description": "This Organizr Install"
  12. },
  13. {
  14. "url": "https://demo.organizr.app",
  15. "description": "Organizr Demo API"
  16. },
  17. {
  18. "url": "{schema}://{hostPath}",
  19. "description": "Custom Organizr API",
  20. "variables": {
  21. "schema": {
  22. "enum": [
  23. "https",
  24. "http"
  25. ],
  26. "default": "http"
  27. },
  28. "hostPath": {
  29. "default": "localhost",
  30. "description": "Your Organizr URL"
  31. }
  32. }
  33. }
  34. ],
  35. "paths": {
  36. "/api/v2/plugins/chat/settings": {
  37. "get": {
  38. "tags": [
  39. "plugins-chat"
  40. ],
  41. "summary": "Get settings",
  42. "responses": {
  43. "200": {
  44. "description": "Success",
  45. "content": {
  46. "application/json": {
  47. "schema": {
  48. "$ref": "#/components/schemas/pluginSettingsPage"
  49. }
  50. }
  51. }
  52. },
  53. "401": {
  54. "description": "Unauthorized"
  55. }
  56. },
  57. "security": [
  58. {
  59. "api_key": []
  60. }
  61. ]
  62. }
  63. },
  64. "/api/v2/plugins/chat/message": {
  65. "get": {
  66. "tags": [
  67. "plugins-chat"
  68. ],
  69. "summary": "Get all messages",
  70. "responses": {
  71. "200": {
  72. "description": "Success",
  73. "content": {
  74. "application/json": {
  75. "schema": {
  76. "$ref": "#/components/schemas/getChatMessages"
  77. }
  78. }
  79. }
  80. },
  81. "401": {
  82. "description": "Unauthorized"
  83. }
  84. },
  85. "security": [
  86. {
  87. "api_key": []
  88. }
  89. ]
  90. },
  91. "post": {
  92. "tags": [
  93. "plugins-chat"
  94. ],
  95. "summary": "Submit a message",
  96. "requestBody": {
  97. "description": "Success",
  98. "required": true,
  99. "content": {
  100. "application/x-www-form-urlencoded": {
  101. "schema": {
  102. "properties": {
  103. "message": {
  104. "description": "message to send",
  105. "type": "string"
  106. }
  107. },
  108. "type": "object"
  109. }
  110. },
  111. "application/json": {
  112. "schema": {
  113. "$ref": "#/components/schemas/submitMessageData"
  114. }
  115. }
  116. }
  117. },
  118. "responses": {
  119. "200": {
  120. "description": "Success",
  121. "content": {
  122. "application/json": {
  123. "schema": {
  124. "$ref": "#/components/schemas/submitMessage"
  125. }
  126. }
  127. }
  128. },
  129. "401": {
  130. "description": "Unauthorized"
  131. }
  132. },
  133. "security": [
  134. {
  135. "api_key": []
  136. }
  137. ]
  138. }
  139. },
  140. "/api/v2/plugins/healthchecks/settings": {
  141. "get": {
  142. "tags": [
  143. "plugins-healthchecks"
  144. ],
  145. "summary": "Get settings",
  146. "responses": {
  147. "200": {
  148. "description": "Success",
  149. "content": {
  150. "application/json": {
  151. "schema": {
  152. "$ref": "#/components/schemas/pluginSettingsPage"
  153. }
  154. }
  155. }
  156. },
  157. "401": {
  158. "description": "Unauthorized"
  159. }
  160. },
  161. "security": [
  162. {
  163. "api_key": []
  164. }
  165. ]
  166. }
  167. },
  168. "/api/v2/plugins/healthchecks/run": {
  169. "get": {
  170. "tags": [
  171. "plugins-healthchecks"
  172. ],
  173. "summary": "Run Healthchecks.io plugin",
  174. "responses": {
  175. "200": {
  176. "description": "Success",
  177. "content": {
  178. "application/json": {
  179. "schema": {
  180. "$ref": "#/components/schemas/healthChecksRun"
  181. }
  182. }
  183. }
  184. },
  185. "401": {
  186. "description": "Unauthorized"
  187. }
  188. },
  189. "security": [
  190. {
  191. "api_key": []
  192. }
  193. ]
  194. }
  195. },
  196. "/api/v2/plugins/invites/settings": {
  197. "get": {
  198. "tags": [
  199. "plugins-invites"
  200. ],
  201. "summary": "Get settings",
  202. "responses": {
  203. "200": {
  204. "description": "Success",
  205. "content": {
  206. "application/json": {
  207. "schema": {
  208. "$ref": "#/components/schemas/pluginSettingsPage"
  209. }
  210. }
  211. }
  212. },
  213. "401": {
  214. "description": "Unauthorized"
  215. }
  216. },
  217. "security": [
  218. {
  219. "api_key": []
  220. }
  221. ]
  222. }
  223. },
  224. "/api/v2/plugins/invites": {
  225. "get": {
  226. "tags": [
  227. "plugins-invites"
  228. ],
  229. "summary": "Get All Invites",
  230. "responses": {
  231. "200": {
  232. "description": "Success",
  233. "content": {
  234. "application/json": {
  235. "schema": {
  236. "$ref": "#/components/schemas/getInvites"
  237. }
  238. }
  239. }
  240. },
  241. "401": {
  242. "description": "Unauthorized"
  243. }
  244. },
  245. "security": [
  246. {
  247. "api_key": []
  248. }
  249. ]
  250. },
  251. "post": {
  252. "tags": [
  253. "plugins-invites"
  254. ],
  255. "summary": "Create Invite Code",
  256. "responses": {
  257. "200": {
  258. "description": "Success",
  259. "content": {
  260. "application/json": {
  261. "schema": {
  262. "$ref": "#/components/schemas/createInviteCode"
  263. }
  264. }
  265. }
  266. },
  267. "401": {
  268. "description": "Unauthorized"
  269. }
  270. },
  271. "security": [
  272. {
  273. "api_key": []
  274. }
  275. ]
  276. }
  277. },
  278. "/api/v2/plugins/invites/{code}": {
  279. "get": {
  280. "tags": [
  281. "plugins-invites"
  282. ],
  283. "summary": "Verify Invite Code",
  284. "parameters": [
  285. {
  286. "name": "code",
  287. "in": "path",
  288. "description": "The Invite Code",
  289. "required": true,
  290. "schema": {
  291. "type": "integer",
  292. "format": "int64"
  293. }
  294. }
  295. ],
  296. "responses": {
  297. "200": {
  298. "description": "Success",
  299. "content": {
  300. "application/json": {
  301. "schema": {
  302. "$ref": "#/components/schemas/verifyInviteCode"
  303. }
  304. }
  305. }
  306. },
  307. "401": {
  308. "description": "Unauthorized"
  309. }
  310. }
  311. },
  312. "post": {
  313. "tags": [
  314. "plugins-invites"
  315. ],
  316. "summary": "Use Invite Code",
  317. "parameters": [
  318. {
  319. "name": "code",
  320. "in": "path",
  321. "description": "The Invite Code",
  322. "required": true,
  323. "schema": {
  324. "type": "integer",
  325. "format": "int64"
  326. }
  327. }
  328. ],
  329. "responses": {
  330. "200": {
  331. "description": "Success",
  332. "content": {
  333. "application/json": {
  334. "schema": {
  335. "$ref": "#/components/schemas/useInviteCode"
  336. }
  337. }
  338. }
  339. },
  340. "401": {
  341. "description": "Unauthorized"
  342. }
  343. }
  344. },
  345. "delete": {
  346. "tags": [
  347. "plugins-invites"
  348. ],
  349. "summary": "Delete Invite Code",
  350. "parameters": [
  351. {
  352. "name": "code",
  353. "in": "path",
  354. "description": "The Invite Code",
  355. "required": true,
  356. "schema": {
  357. "type": "integer",
  358. "format": "int64"
  359. }
  360. }
  361. ],
  362. "responses": {
  363. "200": {
  364. "description": "Success",
  365. "content": {
  366. "application/json": {
  367. "schema": {
  368. "$ref": "#/components/schemas/deleteInviteCode"
  369. }
  370. }
  371. }
  372. },
  373. "401": {
  374. "description": "Unauthorized"
  375. }
  376. },
  377. "security": [
  378. {
  379. "api_key": []
  380. }
  381. ]
  382. }
  383. },
  384. "/api/v2/plugins/php-mailer/settings": {
  385. "get": {
  386. "tags": [
  387. "plugins-php-mailer"
  388. ],
  389. "summary": "Get settings",
  390. "responses": {
  391. "200": {
  392. "description": "Success",
  393. "content": {
  394. "application/json": {
  395. "schema": {
  396. "$ref": "#/components/schemas/pluginSettingsPage"
  397. }
  398. }
  399. }
  400. },
  401. "401": {
  402. "description": "Unauthorized"
  403. }
  404. },
  405. "security": [
  406. {
  407. "api_key": []
  408. }
  409. ]
  410. }
  411. },
  412. "/api/v2/plugins/php-mailer/email/test": {
  413. "get": {
  414. "tags": [
  415. "plugins-php-mailer"
  416. ],
  417. "summary": "Send Test Email to Default Admin Email",
  418. "responses": {
  419. "200": {
  420. "description": "Success",
  421. "content": {
  422. "application/json": {
  423. "schema": {
  424. "$ref": "#/components/schemas/successNullData"
  425. }
  426. }
  427. }
  428. },
  429. "401": {
  430. "description": "Unauthorized"
  431. }
  432. },
  433. "security": [
  434. {
  435. "api_key": []
  436. }
  437. ]
  438. }
  439. },
  440. "/api/v2/plugins/php-mailer/email/send": {
  441. "post": {
  442. "tags": [
  443. "plugins-php-mailer"
  444. ],
  445. "summary": "Send Email",
  446. "requestBody": {
  447. "description": "Success",
  448. "required": true,
  449. "content": {
  450. "application/json": {
  451. "schema": {
  452. "$ref": "#/components/schemas/sendEmailData"
  453. }
  454. }
  455. }
  456. },
  457. "responses": {
  458. "200": {
  459. "description": "Success",
  460. "content": {
  461. "application/json": {
  462. "schema": {
  463. "$ref": "#/components/schemas/successNullData"
  464. }
  465. }
  466. }
  467. },
  468. "401": {
  469. "description": "Unauthorized"
  470. }
  471. },
  472. "security": [
  473. {
  474. "api_key": []
  475. }
  476. ]
  477. }
  478. },
  479. "/api/v2/plugins/php-mailer/email/list": {
  480. "get": {
  481. "tags": [
  482. "plugins-php-mailer"
  483. ],
  484. "summary": "Get List of User Emails",
  485. "responses": {
  486. "200": {
  487. "description": "Success",
  488. "content": {
  489. "application/json": {
  490. "schema": {
  491. "$ref": "#/components/schemas/php-mailer-email-list"
  492. }
  493. }
  494. }
  495. },
  496. "401": {
  497. "description": "Unauthorized"
  498. }
  499. },
  500. "security": [
  501. {
  502. "api_key": []
  503. }
  504. ]
  505. }
  506. },
  507. "/api/v2/plugins/speedtest/settings": {
  508. "get": {
  509. "tags": [
  510. "plugins-speedtest"
  511. ],
  512. "summary": "Get settings",
  513. "responses": {
  514. "200": {
  515. "description": "Success",
  516. "content": {
  517. "application/json": {
  518. "schema": {
  519. "$ref": "#/components/schemas/pluginSettingsPage"
  520. }
  521. }
  522. }
  523. },
  524. "401": {
  525. "description": "Unauthorized"
  526. }
  527. },
  528. "security": [
  529. {
  530. "api_key": []
  531. }
  532. ]
  533. }
  534. },
  535. "/api/v2/2fa": {
  536. "put": {
  537. "tags": [
  538. "2fa"
  539. ],
  540. "summary": "Save 2FA code",
  541. "requestBody": {
  542. "description": "Success",
  543. "required": true,
  544. "content": {
  545. "application/json": {
  546. "schema": {
  547. "$ref": "#/components/schemas/submit-2fa-save"
  548. }
  549. }
  550. }
  551. },
  552. "responses": {
  553. "200": {
  554. "description": "Success",
  555. "content": {
  556. "application/json": {
  557. "schema": {
  558. "$ref": "#/components/schemas/success-message"
  559. }
  560. }
  561. }
  562. },
  563. "401": {
  564. "description": "Unauthorized",
  565. "content": {
  566. "application/json": {
  567. "schema": {
  568. "$ref": "#/components/schemas/unauthorized-message"
  569. }
  570. }
  571. }
  572. },
  573. "422": {
  574. "description": "Error",
  575. "content": {
  576. "application/json": {
  577. "schema": {
  578. "$ref": "#/components/schemas/error-message"
  579. }
  580. }
  581. }
  582. }
  583. },
  584. "security": [
  585. {
  586. "api_key": []
  587. }
  588. ]
  589. },
  590. "post": {
  591. "tags": [
  592. "2fa"
  593. ],
  594. "summary": "Verify 2FA code",
  595. "requestBody": {
  596. "description": "Success",
  597. "required": true,
  598. "content": {
  599. "application/json": {
  600. "schema": {
  601. "$ref": "#/components/schemas/submit-2fa-verify"
  602. }
  603. }
  604. }
  605. },
  606. "responses": {
  607. "200": {
  608. "description": "Success",
  609. "content": {
  610. "application/json": {
  611. "schema": {
  612. "$ref": "#/components/schemas/success-message"
  613. }
  614. }
  615. }
  616. },
  617. "401": {
  618. "description": "Unauthorized",
  619. "content": {
  620. "application/json": {
  621. "schema": {
  622. "$ref": "#/components/schemas/unauthorized-message"
  623. }
  624. }
  625. }
  626. },
  627. "404": {
  628. "description": "Error",
  629. "content": {
  630. "application/json": {
  631. "schema": {
  632. "$ref": "#/components/schemas/error-message"
  633. }
  634. }
  635. }
  636. },
  637. "422": {
  638. "description": "Error",
  639. "content": {
  640. "application/json": {
  641. "schema": {
  642. "$ref": "#/components/schemas/error-message"
  643. }
  644. }
  645. }
  646. },
  647. "500": {
  648. "description": "Error",
  649. "content": {
  650. "application/json": {
  651. "schema": {
  652. "$ref": "#/components/schemas/error-message"
  653. }
  654. }
  655. }
  656. }
  657. },
  658. "security": [
  659. {
  660. "api_key": []
  661. }
  662. ]
  663. },
  664. "delete": {
  665. "tags": [
  666. "2fa"
  667. ],
  668. "summary": "Delete 2FA code",
  669. "responses": {
  670. "204": {
  671. "description": "Success"
  672. },
  673. "401": {
  674. "description": "Unauthorized",
  675. "content": {
  676. "application/json": {
  677. "schema": {
  678. "$ref": "#/components/schemas/unauthorized-message"
  679. }
  680. }
  681. }
  682. }
  683. },
  684. "security": [
  685. {
  686. "api_key": []
  687. }
  688. ]
  689. }
  690. },
  691. "/api/v2/2fa/{type}": {
  692. "post": {
  693. "tags": [
  694. "2fa"
  695. ],
  696. "summary": "Create 2FA code",
  697. "parameters": [
  698. {
  699. "name": "type",
  700. "in": "path",
  701. "description": "The type of 2FA",
  702. "required": true,
  703. "schema": {
  704. "type": "string"
  705. },
  706. "example": "google"
  707. }
  708. ],
  709. "responses": {
  710. "200": {
  711. "description": "Success",
  712. "content": {
  713. "application/json": {
  714. "schema": {
  715. "$ref": "#/components/schemas/success-message"
  716. }
  717. }
  718. }
  719. }
  720. }
  721. }
  722. },
  723. "/api/v2/categories": {
  724. "get": {
  725. "tags": [
  726. "categories"
  727. ],
  728. "summary": "Get all categories",
  729. "responses": {
  730. "200": {
  731. "description": "Success",
  732. "content": {
  733. "application/json": {
  734. "schema": {
  735. "$ref": "#/components/schemas/success-message"
  736. }
  737. }
  738. }
  739. },
  740. "401": {
  741. "description": "Unauthorized",
  742. "content": {
  743. "application/json": {
  744. "schema": {
  745. "$ref": "#/components/schemas/unauthorized-message"
  746. }
  747. }
  748. }
  749. },
  750. "404": {
  751. "description": "Error",
  752. "content": {
  753. "application/json": {
  754. "schema": {
  755. "$ref": "#/components/schemas/error-message"
  756. }
  757. }
  758. }
  759. },
  760. "422": {
  761. "description": "Error",
  762. "content": {
  763. "application/json": {
  764. "schema": {
  765. "$ref": "#/components/schemas/error-message"
  766. }
  767. }
  768. }
  769. },
  770. "500": {
  771. "description": "Error",
  772. "content": {
  773. "application/json": {
  774. "schema": {
  775. "$ref": "#/components/schemas/error-message"
  776. }
  777. }
  778. }
  779. }
  780. },
  781. "security": [
  782. {
  783. "api_key": []
  784. }
  785. ]
  786. },
  787. "put": {
  788. "tags": [
  789. "categories"
  790. ],
  791. "summary": "Update category order",
  792. "requestBody": {
  793. "description": "Success",
  794. "required": true,
  795. "content": {
  796. "application/json": {
  797. "schema": {
  798. "$ref": "#/components/schemas/submit-2fa-verify"
  799. }
  800. }
  801. }
  802. },
  803. "responses": {
  804. "200": {
  805. "description": "Success",
  806. "content": {
  807. "application/json": {
  808. "schema": {
  809. "$ref": "#/components/schemas/success-message"
  810. }
  811. }
  812. }
  813. },
  814. "401": {
  815. "description": "Unauthorized",
  816. "content": {
  817. "application/json": {
  818. "schema": {
  819. "$ref": "#/components/schemas/unauthorized-message"
  820. }
  821. }
  822. }
  823. },
  824. "404": {
  825. "description": "Error",
  826. "content": {
  827. "application/json": {
  828. "schema": {
  829. "$ref": "#/components/schemas/error-message"
  830. }
  831. }
  832. }
  833. },
  834. "422": {
  835. "description": "Error",
  836. "content": {
  837. "application/json": {
  838. "schema": {
  839. "$ref": "#/components/schemas/error-message"
  840. }
  841. }
  842. }
  843. },
  844. "500": {
  845. "description": "Error",
  846. "content": {
  847. "application/json": {
  848. "schema": {
  849. "$ref": "#/components/schemas/error-message"
  850. }
  851. }
  852. }
  853. }
  854. },
  855. "security": [
  856. {
  857. "api_key": []
  858. }
  859. ]
  860. },
  861. "post": {
  862. "tags": [
  863. "categories"
  864. ],
  865. "summary": "Add new category",
  866. "requestBody": {
  867. "description": "Success",
  868. "required": true,
  869. "content": {
  870. "application/json": {
  871. "schema": {
  872. "$ref": "#/components/schemas/submit-2fa-verify"
  873. }
  874. }
  875. }
  876. },
  877. "responses": {
  878. "200": {
  879. "description": "Success",
  880. "content": {
  881. "application/json": {
  882. "schema": {
  883. "$ref": "#/components/schemas/success-message"
  884. }
  885. }
  886. }
  887. },
  888. "401": {
  889. "description": "Unauthorized",
  890. "content": {
  891. "application/json": {
  892. "schema": {
  893. "$ref": "#/components/schemas/unauthorized-message"
  894. }
  895. }
  896. }
  897. },
  898. "404": {
  899. "description": "Error",
  900. "content": {
  901. "application/json": {
  902. "schema": {
  903. "$ref": "#/components/schemas/error-message"
  904. }
  905. }
  906. }
  907. },
  908. "422": {
  909. "description": "Error",
  910. "content": {
  911. "application/json": {
  912. "schema": {
  913. "$ref": "#/components/schemas/error-message"
  914. }
  915. }
  916. }
  917. },
  918. "500": {
  919. "description": "Error",
  920. "content": {
  921. "application/json": {
  922. "schema": {
  923. "$ref": "#/components/schemas/error-message"
  924. }
  925. }
  926. }
  927. }
  928. },
  929. "security": [
  930. {
  931. "api_key": []
  932. }
  933. ]
  934. }
  935. },
  936. "/api/v2/categories/{id}": {
  937. "put": {
  938. "tags": [
  939. "categories"
  940. ],
  941. "summary": "Update category",
  942. "requestBody": {
  943. "description": "Success",
  944. "required": true,
  945. "content": {
  946. "application/json": {
  947. "schema": {
  948. "$ref": "#/components/schemas/submit-2fa-verify"
  949. }
  950. }
  951. }
  952. },
  953. "responses": {
  954. "200": {
  955. "description": "Success",
  956. "content": {
  957. "application/json": {
  958. "schema": {
  959. "$ref": "#/components/schemas/success-message"
  960. }
  961. }
  962. }
  963. },
  964. "401": {
  965. "description": "Unauthorized",
  966. "content": {
  967. "application/json": {
  968. "schema": {
  969. "$ref": "#/components/schemas/unauthorized-message"
  970. }
  971. }
  972. }
  973. },
  974. "404": {
  975. "description": "Error",
  976. "content": {
  977. "application/json": {
  978. "schema": {
  979. "$ref": "#/components/schemas/error-message"
  980. }
  981. }
  982. }
  983. },
  984. "422": {
  985. "description": "Error",
  986. "content": {
  987. "application/json": {
  988. "schema": {
  989. "$ref": "#/components/schemas/error-message"
  990. }
  991. }
  992. }
  993. },
  994. "500": {
  995. "description": "Error",
  996. "content": {
  997. "application/json": {
  998. "schema": {
  999. "$ref": "#/components/schemas/error-message"
  1000. }
  1001. }
  1002. }
  1003. }
  1004. },
  1005. "security": [
  1006. {
  1007. "api_key": []
  1008. }
  1009. ]
  1010. },
  1011. "delete": {
  1012. "tags": [
  1013. "categories"
  1014. ],
  1015. "summary": "Delete category",
  1016. "requestBody": {
  1017. "description": "Success",
  1018. "required": true,
  1019. "content": {
  1020. "application/json": {
  1021. "schema": {
  1022. "$ref": "#/components/schemas/submit-2fa-verify"
  1023. }
  1024. }
  1025. }
  1026. },
  1027. "responses": {
  1028. "200": {
  1029. "description": "Success",
  1030. "content": {
  1031. "application/json": {
  1032. "schema": {
  1033. "$ref": "#/components/schemas/success-message"
  1034. }
  1035. }
  1036. }
  1037. },
  1038. "401": {
  1039. "description": "Unauthorized",
  1040. "content": {
  1041. "application/json": {
  1042. "schema": {
  1043. "$ref": "#/components/schemas/unauthorized-message"
  1044. }
  1045. }
  1046. }
  1047. },
  1048. "404": {
  1049. "description": "Error",
  1050. "content": {
  1051. "application/json": {
  1052. "schema": {
  1053. "$ref": "#/components/schemas/error-message"
  1054. }
  1055. }
  1056. }
  1057. },
  1058. "422": {
  1059. "description": "Error",
  1060. "content": {
  1061. "application/json": {
  1062. "schema": {
  1063. "$ref": "#/components/schemas/error-message"
  1064. }
  1065. }
  1066. }
  1067. },
  1068. "500": {
  1069. "description": "Error",
  1070. "content": {
  1071. "application/json": {
  1072. "schema": {
  1073. "$ref": "#/components/schemas/error-message"
  1074. }
  1075. }
  1076. }
  1077. }
  1078. },
  1079. "security": [
  1080. {
  1081. "api_key": []
  1082. }
  1083. ]
  1084. }
  1085. },
  1086. "/api/v2/config": {
  1087. "get": {
  1088. "tags": [
  1089. "config"
  1090. ],
  1091. "summary": "Get Organizr Coniguration Items",
  1092. "responses": {
  1093. "200": {
  1094. "description": "Success",
  1095. "content": {
  1096. "application/json": {
  1097. "schema": {
  1098. "$ref": "#/components/schemas/success-message"
  1099. }
  1100. }
  1101. }
  1102. },
  1103. "401": {
  1104. "description": "Unauthorized"
  1105. }
  1106. },
  1107. "security": [
  1108. {
  1109. "api_key": []
  1110. }
  1111. ]
  1112. },
  1113. "put": {
  1114. "tags": [
  1115. "config"
  1116. ],
  1117. "summary": "Update Organizr Coniguration Item(s)",
  1118. "requestBody": {
  1119. "description": "Success",
  1120. "required": true,
  1121. "content": {
  1122. "application/json": {
  1123. "schema": {
  1124. "$ref": "#/components/schemas/config-items-example"
  1125. }
  1126. }
  1127. }
  1128. },
  1129. "responses": {
  1130. "200": {
  1131. "description": "Success",
  1132. "content": {
  1133. "application/json": {
  1134. "schema": {
  1135. "$ref": "#/components/schemas/success-message"
  1136. }
  1137. }
  1138. }
  1139. },
  1140. "401": {
  1141. "description": "Unauthorized"
  1142. }
  1143. },
  1144. "security": [
  1145. {
  1146. "api_key": []
  1147. }
  1148. ]
  1149. }
  1150. },
  1151. "/api/v2/config/{item}": {
  1152. "get": {
  1153. "tags": [
  1154. "config"
  1155. ],
  1156. "summary": "Get Organizr Coniguration Item",
  1157. "parameters": [
  1158. {
  1159. "name": "item",
  1160. "in": "path",
  1161. "description": "The key of the item you want to grab",
  1162. "required": true,
  1163. "schema": {
  1164. "type": "string"
  1165. },
  1166. "example": "configVersion"
  1167. }
  1168. ],
  1169. "responses": {
  1170. "200": {
  1171. "description": "Success",
  1172. "content": {
  1173. "application/json": {
  1174. "schema": {
  1175. "$ref": "#/components/schemas/success-message"
  1176. }
  1177. }
  1178. }
  1179. },
  1180. "401": {
  1181. "description": "Unauthorized"
  1182. }
  1183. },
  1184. "security": [
  1185. {
  1186. "api_key": []
  1187. }
  1188. ]
  1189. }
  1190. },
  1191. "/api/v2/config/search/{term}": {
  1192. "get": {
  1193. "tags": [
  1194. "config"
  1195. ],
  1196. "summary": "Search Organizr Coniguration Items",
  1197. "parameters": [
  1198. {
  1199. "name": "term",
  1200. "in": "path",
  1201. "description": "The term of the items you want to grab",
  1202. "required": true,
  1203. "schema": {
  1204. "type": "string"
  1205. },
  1206. "example": "version"
  1207. }
  1208. ],
  1209. "responses": {
  1210. "200": {
  1211. "description": "Success",
  1212. "content": {
  1213. "application/json": {
  1214. "schema": {
  1215. "$ref": "#/components/schemas/success-message"
  1216. }
  1217. }
  1218. }
  1219. },
  1220. "401": {
  1221. "description": "Unauthorized"
  1222. }
  1223. },
  1224. "security": [
  1225. {
  1226. "api_key": []
  1227. }
  1228. ]
  1229. }
  1230. },
  1231. "/api/v2/test/ldap": {
  1232. "post": {
  1233. "tags": [
  1234. "test connection"
  1235. ],
  1236. "summary": "Test LDAP connection",
  1237. "responses": {
  1238. "200": {
  1239. "description": "Success",
  1240. "content": {
  1241. "application/json": {
  1242. "schema": {
  1243. "$ref": "#/components/schemas/success-message"
  1244. }
  1245. }
  1246. }
  1247. },
  1248. "401": {
  1249. "description": "Unauthorized",
  1250. "content": {
  1251. "application/json": {
  1252. "schema": {
  1253. "$ref": "#/components/schemas/unauthorized-message"
  1254. }
  1255. }
  1256. }
  1257. },
  1258. "404": {
  1259. "description": "Error",
  1260. "content": {
  1261. "application/json": {
  1262. "schema": {
  1263. "$ref": "#/components/schemas/error-message"
  1264. }
  1265. }
  1266. }
  1267. },
  1268. "409": {
  1269. "description": "Error",
  1270. "content": {
  1271. "application/json": {
  1272. "schema": {
  1273. "$ref": "#/components/schemas/error-message"
  1274. }
  1275. }
  1276. }
  1277. }
  1278. },
  1279. "security": [
  1280. {
  1281. "api_key": []
  1282. }
  1283. ]
  1284. }
  1285. },
  1286. "/api/v2/test/ldap/login": {
  1287. "post": {
  1288. "tags": [
  1289. "test connection"
  1290. ],
  1291. "summary": "Test LDAP connection using account login",
  1292. "responses": {
  1293. "200": {
  1294. "description": "Success",
  1295. "content": {
  1296. "application/json": {
  1297. "schema": {
  1298. "$ref": "#/components/schemas/success-message"
  1299. }
  1300. }
  1301. }
  1302. },
  1303. "401": {
  1304. "description": "Unauthorized",
  1305. "content": {
  1306. "application/json": {
  1307. "schema": {
  1308. "$ref": "#/components/schemas/unauthorized-message"
  1309. }
  1310. }
  1311. }
  1312. },
  1313. "404": {
  1314. "description": "Error",
  1315. "content": {
  1316. "application/json": {
  1317. "schema": {
  1318. "$ref": "#/components/schemas/error-message"
  1319. }
  1320. }
  1321. }
  1322. },
  1323. "409": {
  1324. "description": "Error",
  1325. "content": {
  1326. "application/json": {
  1327. "schema": {
  1328. "$ref": "#/components/schemas/error-message"
  1329. }
  1330. }
  1331. }
  1332. }
  1333. },
  1334. "security": [
  1335. {
  1336. "api_key": []
  1337. }
  1338. ]
  1339. }
  1340. },
  1341. "/api/v2/test/iframe": {
  1342. "post": {
  1343. "tags": [
  1344. "test connection"
  1345. ],
  1346. "summary": "Test if URL can be iFramed",
  1347. "responses": {
  1348. "200": {
  1349. "description": "Success",
  1350. "content": {
  1351. "application/json": {
  1352. "schema": {
  1353. "$ref": "#/components/schemas/success-message"
  1354. }
  1355. }
  1356. }
  1357. },
  1358. "401": {
  1359. "description": "Unauthorized",
  1360. "content": {
  1361. "application/json": {
  1362. "schema": {
  1363. "$ref": "#/components/schemas/unauthorized-message"
  1364. }
  1365. }
  1366. }
  1367. },
  1368. "404": {
  1369. "description": "Error",
  1370. "content": {
  1371. "application/json": {
  1372. "schema": {
  1373. "$ref": "#/components/schemas/error-message"
  1374. }
  1375. }
  1376. }
  1377. },
  1378. "409": {
  1379. "description": "Error",
  1380. "content": {
  1381. "application/json": {
  1382. "schema": {
  1383. "$ref": "#/components/schemas/error-message"
  1384. }
  1385. }
  1386. }
  1387. }
  1388. },
  1389. "security": [
  1390. {
  1391. "api_key": []
  1392. }
  1393. ]
  1394. }
  1395. },
  1396. "/api/v2/test/path": {
  1397. "post": {
  1398. "tags": [
  1399. "test connection"
  1400. ],
  1401. "summary": "Test if path has correct permissions",
  1402. "responses": {
  1403. "200": {
  1404. "description": "Success",
  1405. "content": {
  1406. "application/json": {
  1407. "schema": {
  1408. "$ref": "#/components/schemas/success-message"
  1409. }
  1410. }
  1411. }
  1412. },
  1413. "401": {
  1414. "description": "Unauthorized",
  1415. "content": {
  1416. "application/json": {
  1417. "schema": {
  1418. "$ref": "#/components/schemas/unauthorized-message"
  1419. }
  1420. }
  1421. }
  1422. },
  1423. "404": {
  1424. "description": "Error",
  1425. "content": {
  1426. "application/json": {
  1427. "schema": {
  1428. "$ref": "#/components/schemas/error-message"
  1429. }
  1430. }
  1431. }
  1432. }
  1433. },
  1434. "security": [
  1435. {
  1436. "api_key": []
  1437. }
  1438. ]
  1439. }
  1440. },
  1441. "/api/v2/test/plex": {
  1442. "post": {
  1443. "tags": [
  1444. "test connection"
  1445. ],
  1446. "summary": "Test connection to Plex",
  1447. "responses": {
  1448. "200": {
  1449. "description": "Success",
  1450. "content": {
  1451. "application/json": {
  1452. "schema": {
  1453. "$ref": "#/components/schemas/success-message"
  1454. }
  1455. }
  1456. }
  1457. },
  1458. "401": {
  1459. "description": "Unauthorized",
  1460. "content": {
  1461. "application/json": {
  1462. "schema": {
  1463. "$ref": "#/components/schemas/unauthorized-message"
  1464. }
  1465. }
  1466. }
  1467. },
  1468. "422": {
  1469. "description": "Error",
  1470. "content": {
  1471. "application/json": {
  1472. "schema": {
  1473. "$ref": "#/components/schemas/error-message"
  1474. }
  1475. }
  1476. }
  1477. },
  1478. "500": {
  1479. "description": "Error",
  1480. "content": {
  1481. "application/json": {
  1482. "schema": {
  1483. "$ref": "#/components/schemas/error-message"
  1484. }
  1485. }
  1486. }
  1487. }
  1488. },
  1489. "security": [
  1490. {
  1491. "api_key": []
  1492. }
  1493. ]
  1494. }
  1495. },
  1496. "/api/v2/test/emby": {
  1497. "post": {
  1498. "tags": [
  1499. "test connection"
  1500. ],
  1501. "summary": "Test connection to Emby",
  1502. "responses": {
  1503. "200": {
  1504. "description": "Success",
  1505. "content": {
  1506. "application/json": {
  1507. "schema": {
  1508. "$ref": "#/components/schemas/success-message"
  1509. }
  1510. }
  1511. }
  1512. },
  1513. "401": {
  1514. "description": "Unauthorized",
  1515. "content": {
  1516. "application/json": {
  1517. "schema": {
  1518. "$ref": "#/components/schemas/unauthorized-message"
  1519. }
  1520. }
  1521. }
  1522. },
  1523. "422": {
  1524. "description": "Error",
  1525. "content": {
  1526. "application/json": {
  1527. "schema": {
  1528. "$ref": "#/components/schemas/error-message"
  1529. }
  1530. }
  1531. }
  1532. },
  1533. "500": {
  1534. "description": "Error",
  1535. "content": {
  1536. "application/json": {
  1537. "schema": {
  1538. "$ref": "#/components/schemas/error-message"
  1539. }
  1540. }
  1541. }
  1542. }
  1543. },
  1544. "security": [
  1545. {
  1546. "api_key": []
  1547. }
  1548. ]
  1549. }
  1550. },
  1551. "/api/v2/test/jellyfin": {
  1552. "post": {
  1553. "tags": [
  1554. "test connection"
  1555. ],
  1556. "summary": "Test connection to Jellyfin",
  1557. "responses": {
  1558. "200": {
  1559. "description": "Success",
  1560. "content": {
  1561. "application/json": {
  1562. "schema": {
  1563. "$ref": "#/components/schemas/success-message"
  1564. }
  1565. }
  1566. }
  1567. },
  1568. "401": {
  1569. "description": "Unauthorized",
  1570. "content": {
  1571. "application/json": {
  1572. "schema": {
  1573. "$ref": "#/components/schemas/unauthorized-message"
  1574. }
  1575. }
  1576. }
  1577. },
  1578. "422": {
  1579. "description": "Error",
  1580. "content": {
  1581. "application/json": {
  1582. "schema": {
  1583. "$ref": "#/components/schemas/error-message"
  1584. }
  1585. }
  1586. }
  1587. },
  1588. "500": {
  1589. "description": "Error",
  1590. "content": {
  1591. "application/json": {
  1592. "schema": {
  1593. "$ref": "#/components/schemas/error-message"
  1594. }
  1595. }
  1596. }
  1597. }
  1598. },
  1599. "security": [
  1600. {
  1601. "api_key": []
  1602. }
  1603. ]
  1604. }
  1605. },
  1606. "/api/v2/test/sabnzbd": {
  1607. "post": {
  1608. "tags": [
  1609. "test connection"
  1610. ],
  1611. "summary": "Test connection to SabNZBd",
  1612. "responses": {
  1613. "200": {
  1614. "description": "Success",
  1615. "content": {
  1616. "application/json": {
  1617. "schema": {
  1618. "$ref": "#/components/schemas/success-message"
  1619. }
  1620. }
  1621. }
  1622. },
  1623. "401": {
  1624. "description": "Unauthorized",
  1625. "content": {
  1626. "application/json": {
  1627. "schema": {
  1628. "$ref": "#/components/schemas/unauthorized-message"
  1629. }
  1630. }
  1631. }
  1632. },
  1633. "422": {
  1634. "description": "Error",
  1635. "content": {
  1636. "application/json": {
  1637. "schema": {
  1638. "$ref": "#/components/schemas/error-message"
  1639. }
  1640. }
  1641. }
  1642. },
  1643. "500": {
  1644. "description": "Error",
  1645. "content": {
  1646. "application/json": {
  1647. "schema": {
  1648. "$ref": "#/components/schemas/error-message"
  1649. }
  1650. }
  1651. }
  1652. }
  1653. },
  1654. "security": [
  1655. {
  1656. "api_key": []
  1657. }
  1658. ]
  1659. }
  1660. },
  1661. "/api/v2/test/pihole": {
  1662. "post": {
  1663. "tags": [
  1664. "test connection"
  1665. ],
  1666. "summary": "Test connection to PiHole",
  1667. "responses": {
  1668. "200": {
  1669. "description": "Success",
  1670. "content": {
  1671. "application/json": {
  1672. "schema": {
  1673. "$ref": "#/components/schemas/success-message"
  1674. }
  1675. }
  1676. }
  1677. },
  1678. "401": {
  1679. "description": "Unauthorized",
  1680. "content": {
  1681. "application/json": {
  1682. "schema": {
  1683. "$ref": "#/components/schemas/unauthorized-message"
  1684. }
  1685. }
  1686. }
  1687. },
  1688. "422": {
  1689. "description": "Error",
  1690. "content": {
  1691. "application/json": {
  1692. "schema": {
  1693. "$ref": "#/components/schemas/error-message"
  1694. }
  1695. }
  1696. }
  1697. },
  1698. "500": {
  1699. "description": "Error",
  1700. "content": {
  1701. "application/json": {
  1702. "schema": {
  1703. "$ref": "#/components/schemas/error-message"
  1704. }
  1705. }
  1706. }
  1707. }
  1708. },
  1709. "security": [
  1710. {
  1711. "api_key": []
  1712. }
  1713. ]
  1714. }
  1715. },
  1716. "/api/v2/test/adguard": {
  1717. "post": {
  1718. "tags": [
  1719. "test connection"
  1720. ],
  1721. "summary": "Test connection to AdGuard",
  1722. "responses": {
  1723. "200": {
  1724. "description": "Success",
  1725. "content": {
  1726. "application/json": {
  1727. "schema": {
  1728. "$ref": "#/components/schemas/success-message"
  1729. }
  1730. }
  1731. }
  1732. },
  1733. "401": {
  1734. "description": "Unauthorized",
  1735. "content": {
  1736. "application/json": {
  1737. "schema": {
  1738. "$ref": "#/components/schemas/unauthorized-message"
  1739. }
  1740. }
  1741. }
  1742. },
  1743. "422": {
  1744. "description": "Error",
  1745. "content": {
  1746. "application/json": {
  1747. "schema": {
  1748. "$ref": "#/components/schemas/error-message"
  1749. }
  1750. }
  1751. }
  1752. },
  1753. "500": {
  1754. "description": "Error",
  1755. "content": {
  1756. "application/json": {
  1757. "schema": {
  1758. "$ref": "#/components/schemas/error-message"
  1759. }
  1760. }
  1761. }
  1762. }
  1763. },
  1764. "security": [
  1765. {
  1766. "api_key": []
  1767. }
  1768. ]
  1769. }
  1770. },
  1771. "/api/v2/test/rtorrent": {
  1772. "post": {
  1773. "tags": [
  1774. "test connection"
  1775. ],
  1776. "summary": "Test connection to rTorrent",
  1777. "responses": {
  1778. "200": {
  1779. "description": "Success",
  1780. "content": {
  1781. "application/json": {
  1782. "schema": {
  1783. "$ref": "#/components/schemas/success-message"
  1784. }
  1785. }
  1786. }
  1787. },
  1788. "401": {
  1789. "description": "Unauthorized",
  1790. "content": {
  1791. "application/json": {
  1792. "schema": {
  1793. "$ref": "#/components/schemas/unauthorized-message"
  1794. }
  1795. }
  1796. }
  1797. },
  1798. "422": {
  1799. "description": "Error",
  1800. "content": {
  1801. "application/json": {
  1802. "schema": {
  1803. "$ref": "#/components/schemas/error-message"
  1804. }
  1805. }
  1806. }
  1807. },
  1808. "500": {
  1809. "description": "Error",
  1810. "content": {
  1811. "application/json": {
  1812. "schema": {
  1813. "$ref": "#/components/schemas/error-message"
  1814. }
  1815. }
  1816. }
  1817. }
  1818. },
  1819. "security": [
  1820. {
  1821. "api_key": []
  1822. }
  1823. ]
  1824. }
  1825. },
  1826. "/api/v2/test/sonarr": {
  1827. "post": {
  1828. "tags": [
  1829. "test connection"
  1830. ],
  1831. "summary": "Test connection to Sonarr",
  1832. "responses": {
  1833. "200": {
  1834. "description": "Success",
  1835. "content": {
  1836. "application/json": {
  1837. "schema": {
  1838. "$ref": "#/components/schemas/success-message"
  1839. }
  1840. }
  1841. }
  1842. },
  1843. "401": {
  1844. "description": "Unauthorized",
  1845. "content": {
  1846. "application/json": {
  1847. "schema": {
  1848. "$ref": "#/components/schemas/unauthorized-message"
  1849. }
  1850. }
  1851. }
  1852. },
  1853. "422": {
  1854. "description": "Error",
  1855. "content": {
  1856. "application/json": {
  1857. "schema": {
  1858. "$ref": "#/components/schemas/error-message"
  1859. }
  1860. }
  1861. }
  1862. },
  1863. "500": {
  1864. "description": "Error",
  1865. "content": {
  1866. "application/json": {
  1867. "schema": {
  1868. "$ref": "#/components/schemas/error-message"
  1869. }
  1870. }
  1871. }
  1872. }
  1873. },
  1874. "security": [
  1875. {
  1876. "api_key": []
  1877. }
  1878. ]
  1879. }
  1880. },
  1881. "/api/v2/test/radarr": {
  1882. "post": {
  1883. "tags": [
  1884. "test connection"
  1885. ],
  1886. "summary": "Test connection to Radarr",
  1887. "responses": {
  1888. "200": {
  1889. "description": "Success",
  1890. "content": {
  1891. "application/json": {
  1892. "schema": {
  1893. "$ref": "#/components/schemas/success-message"
  1894. }
  1895. }
  1896. }
  1897. },
  1898. "401": {
  1899. "description": "Unauthorized",
  1900. "content": {
  1901. "application/json": {
  1902. "schema": {
  1903. "$ref": "#/components/schemas/unauthorized-message"
  1904. }
  1905. }
  1906. }
  1907. },
  1908. "422": {
  1909. "description": "Error",
  1910. "content": {
  1911. "application/json": {
  1912. "schema": {
  1913. "$ref": "#/components/schemas/error-message"
  1914. }
  1915. }
  1916. }
  1917. },
  1918. "500": {
  1919. "description": "Error",
  1920. "content": {
  1921. "application/json": {
  1922. "schema": {
  1923. "$ref": "#/components/schemas/error-message"
  1924. }
  1925. }
  1926. }
  1927. }
  1928. },
  1929. "security": [
  1930. {
  1931. "api_key": []
  1932. }
  1933. ]
  1934. }
  1935. },
  1936. "/api/v2/test/lidarr": {
  1937. "post": {
  1938. "tags": [
  1939. "test connection"
  1940. ],
  1941. "summary": "Test connection to Lidarr",
  1942. "responses": {
  1943. "200": {
  1944. "description": "Success",
  1945. "content": {
  1946. "application/json": {
  1947. "schema": {
  1948. "$ref": "#/components/schemas/success-message"
  1949. }
  1950. }
  1951. }
  1952. },
  1953. "401": {
  1954. "description": "Unauthorized",
  1955. "content": {
  1956. "application/json": {
  1957. "schema": {
  1958. "$ref": "#/components/schemas/unauthorized-message"
  1959. }
  1960. }
  1961. }
  1962. },
  1963. "422": {
  1964. "description": "Error",
  1965. "content": {
  1966. "application/json": {
  1967. "schema": {
  1968. "$ref": "#/components/schemas/error-message"
  1969. }
  1970. }
  1971. }
  1972. },
  1973. "500": {
  1974. "description": "Error",
  1975. "content": {
  1976. "application/json": {
  1977. "schema": {
  1978. "$ref": "#/components/schemas/error-message"
  1979. }
  1980. }
  1981. }
  1982. }
  1983. },
  1984. "security": [
  1985. {
  1986. "api_key": []
  1987. }
  1988. ]
  1989. }
  1990. },
  1991. "/api/v2/test/sickrage": {
  1992. "post": {
  1993. "tags": [
  1994. "test connection"
  1995. ],
  1996. "summary": "Test connection to SickRage",
  1997. "responses": {
  1998. "200": {
  1999. "description": "Success",
  2000. "content": {
  2001. "application/json": {
  2002. "schema": {
  2003. "$ref": "#/components/schemas/success-message"
  2004. }
  2005. }
  2006. }
  2007. },
  2008. "401": {
  2009. "description": "Unauthorized",
  2010. "content": {
  2011. "application/json": {
  2012. "schema": {
  2013. "$ref": "#/components/schemas/unauthorized-message"
  2014. }
  2015. }
  2016. }
  2017. },
  2018. "422": {
  2019. "description": "Error",
  2020. "content": {
  2021. "application/json": {
  2022. "schema": {
  2023. "$ref": "#/components/schemas/error-message"
  2024. }
  2025. }
  2026. }
  2027. },
  2028. "500": {
  2029. "description": "Error",
  2030. "content": {
  2031. "application/json": {
  2032. "schema": {
  2033. "$ref": "#/components/schemas/error-message"
  2034. }
  2035. }
  2036. }
  2037. }
  2038. },
  2039. "security": [
  2040. {
  2041. "api_key": []
  2042. }
  2043. ]
  2044. }
  2045. },
  2046. "/api/v2/test/ombi": {
  2047. "post": {
  2048. "tags": [
  2049. "test connection"
  2050. ],
  2051. "summary": "Test connection to Ombi",
  2052. "responses": {
  2053. "200": {
  2054. "description": "Success",
  2055. "content": {
  2056. "application/json": {
  2057. "schema": {
  2058. "$ref": "#/components/schemas/success-message"
  2059. }
  2060. }
  2061. }
  2062. },
  2063. "401": {
  2064. "description": "Unauthorized",
  2065. "content": {
  2066. "application/json": {
  2067. "schema": {
  2068. "$ref": "#/components/schemas/unauthorized-message"
  2069. }
  2070. }
  2071. }
  2072. },
  2073. "422": {
  2074. "description": "Error",
  2075. "content": {
  2076. "application/json": {
  2077. "schema": {
  2078. "$ref": "#/components/schemas/error-message"
  2079. }
  2080. }
  2081. }
  2082. },
  2083. "500": {
  2084. "description": "Error",
  2085. "content": {
  2086. "application/json": {
  2087. "schema": {
  2088. "$ref": "#/components/schemas/error-message"
  2089. }
  2090. }
  2091. }
  2092. }
  2093. },
  2094. "security": [
  2095. {
  2096. "api_key": []
  2097. }
  2098. ]
  2099. }
  2100. },
  2101. "/api/v2/test/overseerr": {
  2102. "post": {
  2103. "tags": [
  2104. "test connection"
  2105. ],
  2106. "summary": "Test connection to Overseerr",
  2107. "responses": {
  2108. "200": {
  2109. "description": "Success",
  2110. "content": {
  2111. "application/json": {
  2112. "schema": {
  2113. "$ref": "#/components/schemas/success-message"
  2114. }
  2115. }
  2116. }
  2117. },
  2118. "401": {
  2119. "description": "Unauthorized",
  2120. "content": {
  2121. "application/json": {
  2122. "schema": {
  2123. "$ref": "#/components/schemas/unauthorized-message"
  2124. }
  2125. }
  2126. }
  2127. },
  2128. "422": {
  2129. "description": "Error",
  2130. "content": {
  2131. "application/json": {
  2132. "schema": {
  2133. "$ref": "#/components/schemas/error-message"
  2134. }
  2135. }
  2136. }
  2137. },
  2138. "500": {
  2139. "description": "Error",
  2140. "content": {
  2141. "application/json": {
  2142. "schema": {
  2143. "$ref": "#/components/schemas/error-message"
  2144. }
  2145. }
  2146. }
  2147. }
  2148. },
  2149. "security": [
  2150. {
  2151. "api_key": []
  2152. }
  2153. ]
  2154. }
  2155. },
  2156. "/api/v2/test/nzbget": {
  2157. "post": {
  2158. "tags": [
  2159. "test connection"
  2160. ],
  2161. "summary": "Test connection to NzbGet",
  2162. "responses": {
  2163. "200": {
  2164. "description": "Success",
  2165. "content": {
  2166. "application/json": {
  2167. "schema": {
  2168. "$ref": "#/components/schemas/success-message"
  2169. }
  2170. }
  2171. }
  2172. },
  2173. "401": {
  2174. "description": "Unauthorized",
  2175. "content": {
  2176. "application/json": {
  2177. "schema": {
  2178. "$ref": "#/components/schemas/unauthorized-message"
  2179. }
  2180. }
  2181. }
  2182. },
  2183. "422": {
  2184. "description": "Error",
  2185. "content": {
  2186. "application/json": {
  2187. "schema": {
  2188. "$ref": "#/components/schemas/error-message"
  2189. }
  2190. }
  2191. }
  2192. },
  2193. "500": {
  2194. "description": "Error",
  2195. "content": {
  2196. "application/json": {
  2197. "schema": {
  2198. "$ref": "#/components/schemas/error-message"
  2199. }
  2200. }
  2201. }
  2202. }
  2203. },
  2204. "security": [
  2205. {
  2206. "api_key": []
  2207. }
  2208. ]
  2209. }
  2210. },
  2211. "/api/v2/test/utorrent": {
  2212. "post": {
  2213. "tags": [
  2214. "test connection"
  2215. ],
  2216. "summary": "Test connection to uTorrent",
  2217. "responses": {
  2218. "200": {
  2219. "description": "Success",
  2220. "content": {
  2221. "application/json": {
  2222. "schema": {
  2223. "$ref": "#/components/schemas/success-message"
  2224. }
  2225. }
  2226. }
  2227. },
  2228. "401": {
  2229. "description": "Unauthorized",
  2230. "content": {
  2231. "application/json": {
  2232. "schema": {
  2233. "$ref": "#/components/schemas/unauthorized-message"
  2234. }
  2235. }
  2236. }
  2237. },
  2238. "400": {
  2239. "description": "Error",
  2240. "content": {
  2241. "application/json": {
  2242. "schema": {
  2243. "$ref": "#/components/schemas/error-message"
  2244. }
  2245. }
  2246. }
  2247. },
  2248. "500": {
  2249. "description": "Error",
  2250. "content": {
  2251. "application/json": {
  2252. "schema": {
  2253. "$ref": "#/components/schemas/error-message"
  2254. }
  2255. }
  2256. }
  2257. }
  2258. },
  2259. "security": [
  2260. {
  2261. "api_key": []
  2262. }
  2263. ]
  2264. }
  2265. },
  2266. "/api/v2/test/deluge": {
  2267. "post": {
  2268. "tags": [
  2269. "test connection"
  2270. ],
  2271. "summary": "Test connection to Deluge",
  2272. "responses": {
  2273. "200": {
  2274. "description": "Success",
  2275. "content": {
  2276. "application/json": {
  2277. "schema": {
  2278. "$ref": "#/components/schemas/success-message"
  2279. }
  2280. }
  2281. }
  2282. },
  2283. "401": {
  2284. "description": "Unauthorized",
  2285. "content": {
  2286. "application/json": {
  2287. "schema": {
  2288. "$ref": "#/components/schemas/unauthorized-message"
  2289. }
  2290. }
  2291. }
  2292. },
  2293. "422": {
  2294. "description": "Error",
  2295. "content": {
  2296. "application/json": {
  2297. "schema": {
  2298. "$ref": "#/components/schemas/error-message"
  2299. }
  2300. }
  2301. }
  2302. },
  2303. "500": {
  2304. "description": "Error",
  2305. "content": {
  2306. "application/json": {
  2307. "schema": {
  2308. "$ref": "#/components/schemas/error-message"
  2309. }
  2310. }
  2311. }
  2312. }
  2313. },
  2314. "security": [
  2315. {
  2316. "api_key": []
  2317. }
  2318. ]
  2319. }
  2320. },
  2321. "/api/v2/test/jdownloader": {
  2322. "post": {
  2323. "tags": [
  2324. "test connection"
  2325. ],
  2326. "summary": "Test connection to jDownloader",
  2327. "responses": {
  2328. "200": {
  2329. "description": "Success",
  2330. "content": {
  2331. "application/json": {
  2332. "schema": {
  2333. "$ref": "#/components/schemas/success-message"
  2334. }
  2335. }
  2336. }
  2337. },
  2338. "401": {
  2339. "description": "Unauthorized",
  2340. "content": {
  2341. "application/json": {
  2342. "schema": {
  2343. "$ref": "#/components/schemas/unauthorized-message"
  2344. }
  2345. }
  2346. }
  2347. },
  2348. "422": {
  2349. "description": "Error",
  2350. "content": {
  2351. "application/json": {
  2352. "schema": {
  2353. "$ref": "#/components/schemas/error-message"
  2354. }
  2355. }
  2356. }
  2357. },
  2358. "500": {
  2359. "description": "Error",
  2360. "content": {
  2361. "application/json": {
  2362. "schema": {
  2363. "$ref": "#/components/schemas/error-message"
  2364. }
  2365. }
  2366. }
  2367. }
  2368. },
  2369. "security": [
  2370. {
  2371. "api_key": []
  2372. }
  2373. ]
  2374. }
  2375. },
  2376. "/api/v2/test/transmission": {
  2377. "post": {
  2378. "tags": [
  2379. "test connection"
  2380. ],
  2381. "summary": "Test connection to Transmission",
  2382. "responses": {
  2383. "200": {
  2384. "description": "Success",
  2385. "content": {
  2386. "application/json": {
  2387. "schema": {
  2388. "$ref": "#/components/schemas/success-message"
  2389. }
  2390. }
  2391. }
  2392. },
  2393. "401": {
  2394. "description": "Unauthorized",
  2395. "content": {
  2396. "application/json": {
  2397. "schema": {
  2398. "$ref": "#/components/schemas/unauthorized-message"
  2399. }
  2400. }
  2401. }
  2402. },
  2403. "422": {
  2404. "description": "Error",
  2405. "content": {
  2406. "application/json": {
  2407. "schema": {
  2408. "$ref": "#/components/schemas/error-message"
  2409. }
  2410. }
  2411. }
  2412. },
  2413. "500": {
  2414. "description": "Error",
  2415. "content": {
  2416. "application/json": {
  2417. "schema": {
  2418. "$ref": "#/components/schemas/error-message"
  2419. }
  2420. }
  2421. }
  2422. }
  2423. },
  2424. "security": [
  2425. {
  2426. "api_key": []
  2427. }
  2428. ]
  2429. }
  2430. },
  2431. "/api/v2/test/qbittorrent": {
  2432. "post": {
  2433. "tags": [
  2434. "test connection"
  2435. ],
  2436. "summary": "Test connection to qBittorrent",
  2437. "responses": {
  2438. "200": {
  2439. "description": "Success",
  2440. "content": {
  2441. "application/json": {
  2442. "schema": {
  2443. "$ref": "#/components/schemas/success-message"
  2444. }
  2445. }
  2446. }
  2447. },
  2448. "401": {
  2449. "description": "Unauthorized",
  2450. "content": {
  2451. "application/json": {
  2452. "schema": {
  2453. "$ref": "#/components/schemas/unauthorized-message"
  2454. }
  2455. }
  2456. }
  2457. },
  2458. "422": {
  2459. "description": "Error",
  2460. "content": {
  2461. "application/json": {
  2462. "schema": {
  2463. "$ref": "#/components/schemas/error-message"
  2464. }
  2465. }
  2466. }
  2467. },
  2468. "500": {
  2469. "description": "Error",
  2470. "content": {
  2471. "application/json": {
  2472. "schema": {
  2473. "$ref": "#/components/schemas/error-message"
  2474. }
  2475. }
  2476. }
  2477. }
  2478. },
  2479. "security": [
  2480. {
  2481. "api_key": []
  2482. }
  2483. ]
  2484. }
  2485. },
  2486. "/api/v2/test/unifi": {
  2487. "post": {
  2488. "tags": [
  2489. "test connection"
  2490. ],
  2491. "summary": "Test connection to Unifi",
  2492. "responses": {
  2493. "200": {
  2494. "description": "Success",
  2495. "content": {
  2496. "application/json": {
  2497. "schema": {
  2498. "$ref": "#/components/schemas/success-message"
  2499. }
  2500. }
  2501. }
  2502. },
  2503. "401": {
  2504. "description": "Unauthorized",
  2505. "content": {
  2506. "application/json": {
  2507. "schema": {
  2508. "$ref": "#/components/schemas/unauthorized-message"
  2509. }
  2510. }
  2511. }
  2512. },
  2513. "422": {
  2514. "description": "Error",
  2515. "content": {
  2516. "application/json": {
  2517. "schema": {
  2518. "$ref": "#/components/schemas/error-message"
  2519. }
  2520. }
  2521. }
  2522. },
  2523. "500": {
  2524. "description": "Error",
  2525. "content": {
  2526. "application/json": {
  2527. "schema": {
  2528. "$ref": "#/components/schemas/error-message"
  2529. }
  2530. }
  2531. }
  2532. }
  2533. },
  2534. "security": [
  2535. {
  2536. "api_key": []
  2537. }
  2538. ]
  2539. }
  2540. },
  2541. "/api/v2/test/unifi/site": {
  2542. "post": {
  2543. "tags": [
  2544. "test connection"
  2545. ],
  2546. "summary": "Test connection to Unifi Sites",
  2547. "responses": {
  2548. "200": {
  2549. "description": "Success",
  2550. "content": {
  2551. "application/json": {
  2552. "schema": {
  2553. "$ref": "#/components/schemas/success-message"
  2554. }
  2555. }
  2556. }
  2557. },
  2558. "401": {
  2559. "description": "Unauthorized",
  2560. "content": {
  2561. "application/json": {
  2562. "schema": {
  2563. "$ref": "#/components/schemas/unauthorized-message"
  2564. }
  2565. }
  2566. }
  2567. },
  2568. "422": {
  2569. "description": "Error",
  2570. "content": {
  2571. "application/json": {
  2572. "schema": {
  2573. "$ref": "#/components/schemas/error-message"
  2574. }
  2575. }
  2576. }
  2577. },
  2578. "500": {
  2579. "description": "Error",
  2580. "content": {
  2581. "application/json": {
  2582. "schema": {
  2583. "$ref": "#/components/schemas/error-message"
  2584. }
  2585. }
  2586. }
  2587. }
  2588. },
  2589. "security": [
  2590. {
  2591. "api_key": []
  2592. }
  2593. ]
  2594. }
  2595. },
  2596. "/api/v2/test/tautulli": {
  2597. "post": {
  2598. "tags": [
  2599. "test connection"
  2600. ],
  2601. "summary": "Test connection to Tautulli",
  2602. "responses": {
  2603. "200": {
  2604. "description": "Success",
  2605. "content": {
  2606. "application/json": {
  2607. "schema": {
  2608. "$ref": "#/components/schemas/success-message"
  2609. }
  2610. }
  2611. }
  2612. },
  2613. "401": {
  2614. "description": "Unauthorized",
  2615. "content": {
  2616. "application/json": {
  2617. "schema": {
  2618. "$ref": "#/components/schemas/unauthorized-message"
  2619. }
  2620. }
  2621. }
  2622. },
  2623. "422": {
  2624. "description": "Error",
  2625. "content": {
  2626. "application/json": {
  2627. "schema": {
  2628. "$ref": "#/components/schemas/error-message"
  2629. }
  2630. }
  2631. }
  2632. },
  2633. "500": {
  2634. "description": "Error",
  2635. "content": {
  2636. "application/json": {
  2637. "schema": {
  2638. "$ref": "#/components/schemas/error-message"
  2639. }
  2640. }
  2641. }
  2642. }
  2643. },
  2644. "security": [
  2645. {
  2646. "api_key": []
  2647. }
  2648. ]
  2649. }
  2650. },
  2651. "/api/v2/test/cron": {
  2652. "get": {
  2653. "tags": [
  2654. "test connection"
  2655. ],
  2656. "summary": "Test if cron is setup correctly",
  2657. "responses": {
  2658. "200": {
  2659. "description": "Success",
  2660. "content": {
  2661. "application/json": {
  2662. "schema": {
  2663. "$ref": "#/components/schemas/success-message"
  2664. }
  2665. }
  2666. }
  2667. },
  2668. "401": {
  2669. "description": "Unauthorized",
  2670. "content": {
  2671. "application/json": {
  2672. "schema": {
  2673. "$ref": "#/components/schemas/unauthorized-message"
  2674. }
  2675. }
  2676. }
  2677. },
  2678. "422": {
  2679. "description": "Error",
  2680. "content": {
  2681. "application/json": {
  2682. "schema": {
  2683. "$ref": "#/components/schemas/error-message"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "500": {
  2689. "description": "Error",
  2690. "content": {
  2691. "application/json": {
  2692. "schema": {
  2693. "$ref": "#/components/schemas/error-message"
  2694. }
  2695. }
  2696. }
  2697. }
  2698. },
  2699. "security": [
  2700. {
  2701. "api_key": []
  2702. }
  2703. ]
  2704. },
  2705. "post": {
  2706. "tags": [
  2707. "test connection"
  2708. ],
  2709. "summary": "Test cron schedule",
  2710. "responses": {
  2711. "200": {
  2712. "description": "Success",
  2713. "content": {
  2714. "application/json": {
  2715. "schema": {
  2716. "$ref": "#/components/schemas/success-message"
  2717. }
  2718. }
  2719. }
  2720. },
  2721. "401": {
  2722. "description": "Unauthorized",
  2723. "content": {
  2724. "application/json": {
  2725. "schema": {
  2726. "$ref": "#/components/schemas/unauthorized-message"
  2727. }
  2728. }
  2729. }
  2730. },
  2731. "422": {
  2732. "description": "Error",
  2733. "content": {
  2734. "application/json": {
  2735. "schema": {
  2736. "$ref": "#/components/schemas/error-message"
  2737. }
  2738. }
  2739. }
  2740. },
  2741. "500": {
  2742. "description": "Error",
  2743. "content": {
  2744. "application/json": {
  2745. "schema": {
  2746. "$ref": "#/components/schemas/error-message"
  2747. }
  2748. }
  2749. }
  2750. }
  2751. },
  2752. "security": [
  2753. {
  2754. "api_key": []
  2755. }
  2756. ]
  2757. }
  2758. },
  2759. "/api/v2/test/folder": {
  2760. "post": {
  2761. "tags": [
  2762. "test connection"
  2763. ],
  2764. "summary": "Test folder path",
  2765. "responses": {
  2766. "200": {
  2767. "description": "Success",
  2768. "content": {
  2769. "application/json": {
  2770. "schema": {
  2771. "$ref": "#/components/schemas/success-message"
  2772. }
  2773. }
  2774. }
  2775. },
  2776. "401": {
  2777. "description": "Unauthorized",
  2778. "content": {
  2779. "application/json": {
  2780. "schema": {
  2781. "$ref": "#/components/schemas/unauthorized-message"
  2782. }
  2783. }
  2784. }
  2785. },
  2786. "422": {
  2787. "description": "Error",
  2788. "content": {
  2789. "application/json": {
  2790. "schema": {
  2791. "$ref": "#/components/schemas/error-message"
  2792. }
  2793. }
  2794. }
  2795. },
  2796. "500": {
  2797. "description": "Error",
  2798. "content": {
  2799. "application/json": {
  2800. "schema": {
  2801. "$ref": "#/components/schemas/error-message"
  2802. }
  2803. }
  2804. }
  2805. }
  2806. },
  2807. "security": [
  2808. {
  2809. "api_key": []
  2810. }
  2811. ]
  2812. }
  2813. },
  2814. "/api/v2/test/database": {
  2815. "post": {
  2816. "tags": [
  2817. "test connection"
  2818. ],
  2819. "summary": "Test Database connection",
  2820. "responses": {
  2821. "200": {
  2822. "description": "Success",
  2823. "content": {
  2824. "application/json": {
  2825. "schema": {
  2826. "$ref": "#/components/schemas/success-message"
  2827. }
  2828. }
  2829. }
  2830. },
  2831. "401": {
  2832. "description": "Unauthorized",
  2833. "content": {
  2834. "application/json": {
  2835. "schema": {
  2836. "$ref": "#/components/schemas/unauthorized-message"
  2837. }
  2838. }
  2839. }
  2840. },
  2841. "422": {
  2842. "description": "Error",
  2843. "content": {
  2844. "application/json": {
  2845. "schema": {
  2846. "$ref": "#/components/schemas/error-message"
  2847. }
  2848. }
  2849. }
  2850. },
  2851. "500": {
  2852. "description": "Error",
  2853. "content": {
  2854. "application/json": {
  2855. "schema": {
  2856. "$ref": "#/components/schemas/error-message"
  2857. }
  2858. }
  2859. }
  2860. }
  2861. },
  2862. "security": [
  2863. {
  2864. "api_key": []
  2865. }
  2866. ]
  2867. }
  2868. },
  2869. "/api/v2/test/jackett": {
  2870. "post": {
  2871. "tags": [
  2872. "test connection"
  2873. ],
  2874. "summary": "Test connection to Jackett",
  2875. "responses": {
  2876. "200": {
  2877. "description": "Success",
  2878. "content": {
  2879. "application/json": {
  2880. "schema": {
  2881. "$ref": "#/components/schemas/success-message"
  2882. }
  2883. }
  2884. }
  2885. },
  2886. "401": {
  2887. "description": "Unauthorized",
  2888. "content": {
  2889. "application/json": {
  2890. "schema": {
  2891. "$ref": "#/components/schemas/unauthorized-message"
  2892. }
  2893. }
  2894. }
  2895. },
  2896. "422": {
  2897. "description": "Error",
  2898. "content": {
  2899. "application/json": {
  2900. "schema": {
  2901. "$ref": "#/components/schemas/error-message"
  2902. }
  2903. }
  2904. }
  2905. },
  2906. "500": {
  2907. "description": "Error",
  2908. "content": {
  2909. "application/json": {
  2910. "schema": {
  2911. "$ref": "#/components/schemas/error-message"
  2912. }
  2913. }
  2914. }
  2915. }
  2916. },
  2917. "security": [
  2918. {
  2919. "api_key": []
  2920. }
  2921. ]
  2922. }
  2923. },
  2924. "/api/v2/test/prowlarr": {
  2925. "post": {
  2926. "tags": [
  2927. "test connection"
  2928. ],
  2929. "summary": "Test connection to prowlarr",
  2930. "responses": {
  2931. "200": {
  2932. "description": "Success",
  2933. "content": {
  2934. "application/json": {
  2935. "schema": {
  2936. "$ref": "#/components/schemas/success-message"
  2937. }
  2938. }
  2939. }
  2940. },
  2941. "401": {
  2942. "description": "Unauthorized",
  2943. "content": {
  2944. "application/json": {
  2945. "schema": {
  2946. "$ref": "#/components/schemas/unauthorized-message"
  2947. }
  2948. }
  2949. }
  2950. },
  2951. "422": {
  2952. "description": "Error",
  2953. "content": {
  2954. "application/json": {
  2955. "schema": {
  2956. "$ref": "#/components/schemas/error-message"
  2957. }
  2958. }
  2959. }
  2960. },
  2961. "500": {
  2962. "description": "Error",
  2963. "content": {
  2964. "application/json": {
  2965. "schema": {
  2966. "$ref": "#/components/schemas/error-message"
  2967. }
  2968. }
  2969. }
  2970. }
  2971. },
  2972. "security": [
  2973. {
  2974. "api_key": []
  2975. }
  2976. ]
  2977. }
  2978. },
  2979. "/api/v2/test/slack-logs": {
  2980. "post": {
  2981. "tags": [
  2982. "test connection"
  2983. ],
  2984. "summary": "Test connection to Slack/Discord",
  2985. "responses": {
  2986. "200": {
  2987. "description": "Success",
  2988. "content": {
  2989. "application/json": {
  2990. "schema": {
  2991. "$ref": "#/components/schemas/success-message"
  2992. }
  2993. }
  2994. }
  2995. },
  2996. "401": {
  2997. "description": "Unauthorized",
  2998. "content": {
  2999. "application/json": {
  3000. "schema": {
  3001. "$ref": "#/components/schemas/unauthorized-message"
  3002. }
  3003. }
  3004. }
  3005. },
  3006. "422": {
  3007. "description": "Error",
  3008. "content": {
  3009. "application/json": {
  3010. "schema": {
  3011. "$ref": "#/components/schemas/error-message"
  3012. }
  3013. }
  3014. }
  3015. },
  3016. "500": {
  3017. "description": "Error",
  3018. "content": {
  3019. "application/json": {
  3020. "schema": {
  3021. "$ref": "#/components/schemas/error-message"
  3022. }
  3023. }
  3024. }
  3025. }
  3026. },
  3027. "security": [
  3028. {
  3029. "api_key": []
  3030. }
  3031. ]
  3032. }
  3033. },
  3034. "/api/v2/emby/register": {
  3035. "post": {
  3036. "tags": [
  3037. "emby"
  3038. ],
  3039. "summary": "Register a user using Emby API",
  3040. "responses": {
  3041. "200": {
  3042. "description": "Success",
  3043. "content": {
  3044. "application/json": {
  3045. "schema": {
  3046. "$ref": "#/components/schemas/status"
  3047. }
  3048. }
  3049. }
  3050. },
  3051. "401": {
  3052. "description": "Unauthorized"
  3053. }
  3054. }
  3055. }
  3056. },
  3057. "/api/v2/organizr/{page}": {
  3058. "get": {
  3059. "tags": [
  3060. "page"
  3061. ],
  3062. "summary": "Get HTML for Organizr Pages",
  3063. "parameters": [
  3064. {
  3065. "name": "page",
  3066. "in": "path",
  3067. "description": "Page to get",
  3068. "required": true,
  3069. "schema": {
  3070. "type": "string"
  3071. }
  3072. }
  3073. ],
  3074. "responses": {
  3075. "200": {
  3076. "description": "Success",
  3077. "content": {
  3078. "application/json": {
  3079. "schema": {
  3080. "$ref": "#/components/schemas/get-html"
  3081. }
  3082. }
  3083. }
  3084. },
  3085. "401": {
  3086. "description": "Unauthorized"
  3087. }
  3088. },
  3089. "security": [
  3090. {
  3091. "api_key": []
  3092. }
  3093. ]
  3094. }
  3095. },
  3096. "/api/v2/page/{page}": {
  3097. "get": {
  3098. "tags": [
  3099. "page"
  3100. ],
  3101. "summary": "Get HTML for Organizr Pages",
  3102. "parameters": [
  3103. {
  3104. "name": "page",
  3105. "in": "path",
  3106. "description": "Page to get",
  3107. "required": true,
  3108. "schema": {
  3109. "type": "string"
  3110. }
  3111. }
  3112. ],
  3113. "responses": {
  3114. "200": {
  3115. "description": "Success",
  3116. "content": {
  3117. "application/json": {
  3118. "schema": {
  3119. "$ref": "#/components/schemas/get-html"
  3120. }
  3121. }
  3122. }
  3123. },
  3124. "401": {
  3125. "description": "Unauthorized"
  3126. }
  3127. },
  3128. "security": [
  3129. {
  3130. "api_key": []
  3131. }
  3132. ]
  3133. }
  3134. },
  3135. "/api/v2/page": {
  3136. "get": {
  3137. "tags": [
  3138. "page"
  3139. ],
  3140. "summary": "Get list of all Organizr Pages",
  3141. "responses": {
  3142. "200": {
  3143. "description": "Success",
  3144. "content": {
  3145. "application/json": {
  3146. "schema": {
  3147. "$ref": "#/components/schemas/get-html"
  3148. }
  3149. }
  3150. }
  3151. },
  3152. "401": {
  3153. "description": "Unauthorized"
  3154. }
  3155. },
  3156. "security": [
  3157. {
  3158. "api_key": []
  3159. }
  3160. ]
  3161. }
  3162. },
  3163. "/api/v2/ping": {
  3164. "get": {
  3165. "summary": "Ping the Organizr API",
  3166. "responses": {
  3167. "200": {
  3168. "description": "Success",
  3169. "content": {
  3170. "application/json": {
  3171. "schema": {
  3172. "$ref": "#/components/schemas/ping"
  3173. }
  3174. }
  3175. }
  3176. },
  3177. "401": {
  3178. "description": "Unauthorized"
  3179. }
  3180. }
  3181. }
  3182. },
  3183. "/api/v2/plex/register": {
  3184. "post": {
  3185. "tags": [
  3186. "plex"
  3187. ],
  3188. "summary": "Register a user using Plex API",
  3189. "requestBody": {
  3190. "description": "Success",
  3191. "required": true,
  3192. "content": {
  3193. "application/json": {
  3194. "schema": {
  3195. "$ref": "#/components/schemas/plexRegister"
  3196. }
  3197. }
  3198. }
  3199. },
  3200. "responses": {
  3201. "200": {
  3202. "description": "Success",
  3203. "content": {
  3204. "application/json": {
  3205. "schema": {
  3206. "$ref": "#/components/schemas/status"
  3207. }
  3208. }
  3209. }
  3210. },
  3211. "401": {
  3212. "description": "Unauthorized"
  3213. }
  3214. }
  3215. }
  3216. },
  3217. "/api/v2/status": {
  3218. "get": {
  3219. "summary": "Query Organizr API to perform a Status Check",
  3220. "responses": {
  3221. "200": {
  3222. "description": "Success",
  3223. "content": {
  3224. "application/json": {
  3225. "schema": {
  3226. "$ref": "#/components/schemas/status"
  3227. }
  3228. }
  3229. }
  3230. },
  3231. "401": {
  3232. "description": "Unauthorized"
  3233. }
  3234. }
  3235. }
  3236. },
  3237. "/api/v2/update": {
  3238. "get": {
  3239. "tags": [
  3240. "update"
  3241. ],
  3242. "summary": "Update Organizr install using update script",
  3243. "responses": {
  3244. "200": {
  3245. "description": "Success",
  3246. "content": {
  3247. "application/json": {
  3248. "schema": {
  3249. "$ref": "#/components/schemas/success-message"
  3250. }
  3251. }
  3252. }
  3253. },
  3254. "401": {
  3255. "description": "Unauthorized",
  3256. "content": {
  3257. "application/json": {
  3258. "schema": {
  3259. "$ref": "#/components/schemas/unauthorized-message"
  3260. }
  3261. }
  3262. }
  3263. },
  3264. "404": {
  3265. "description": "Error",
  3266. "content": {
  3267. "application/json": {
  3268. "schema": {
  3269. "$ref": "#/components/schemas/error-message"
  3270. }
  3271. }
  3272. }
  3273. },
  3274. "422": {
  3275. "description": "Error",
  3276. "content": {
  3277. "application/json": {
  3278. "schema": {
  3279. "$ref": "#/components/schemas/error-message"
  3280. }
  3281. }
  3282. }
  3283. },
  3284. "500": {
  3285. "description": "Error",
  3286. "content": {
  3287. "application/json": {
  3288. "schema": {
  3289. "$ref": "#/components/schemas/error-message"
  3290. }
  3291. }
  3292. }
  3293. }
  3294. },
  3295. "security": [
  3296. {
  3297. "api_key": []
  3298. }
  3299. ]
  3300. }
  3301. },
  3302. "/api/v2/update/download/{branch}": {
  3303. "get": {
  3304. "tags": [
  3305. "update"
  3306. ],
  3307. "summary": "Download Organizr Update Files",
  3308. "responses": {
  3309. "200": {
  3310. "description": "Success",
  3311. "content": {
  3312. "application/json": {
  3313. "schema": {
  3314. "$ref": "#/components/schemas/success-message"
  3315. }
  3316. }
  3317. }
  3318. },
  3319. "401": {
  3320. "description": "Unauthorized",
  3321. "content": {
  3322. "application/json": {
  3323. "schema": {
  3324. "$ref": "#/components/schemas/unauthorized-message"
  3325. }
  3326. }
  3327. }
  3328. },
  3329. "404": {
  3330. "description": "Error",
  3331. "content": {
  3332. "application/json": {
  3333. "schema": {
  3334. "$ref": "#/components/schemas/error-message"
  3335. }
  3336. }
  3337. }
  3338. },
  3339. "422": {
  3340. "description": "Error",
  3341. "content": {
  3342. "application/json": {
  3343. "schema": {
  3344. "$ref": "#/components/schemas/error-message"
  3345. }
  3346. }
  3347. }
  3348. },
  3349. "500": {
  3350. "description": "Error",
  3351. "content": {
  3352. "application/json": {
  3353. "schema": {
  3354. "$ref": "#/components/schemas/error-message"
  3355. }
  3356. }
  3357. }
  3358. }
  3359. },
  3360. "security": [
  3361. {
  3362. "api_key": []
  3363. }
  3364. ]
  3365. }
  3366. },
  3367. "/api/v2/update/unzip/{branch}": {
  3368. "get": {
  3369. "tags": [
  3370. "update"
  3371. ],
  3372. "summary": "Unzip Organizr Update Files",
  3373. "responses": {
  3374. "200": {
  3375. "description": "Success",
  3376. "content": {
  3377. "application/json": {
  3378. "schema": {
  3379. "$ref": "#/components/schemas/success-message"
  3380. }
  3381. }
  3382. }
  3383. },
  3384. "401": {
  3385. "description": "Unauthorized",
  3386. "content": {
  3387. "application/json": {
  3388. "schema": {
  3389. "$ref": "#/components/schemas/unauthorized-message"
  3390. }
  3391. }
  3392. }
  3393. },
  3394. "404": {
  3395. "description": "Error",
  3396. "content": {
  3397. "application/json": {
  3398. "schema": {
  3399. "$ref": "#/components/schemas/error-message"
  3400. }
  3401. }
  3402. }
  3403. },
  3404. "422": {
  3405. "description": "Error",
  3406. "content": {
  3407. "application/json": {
  3408. "schema": {
  3409. "$ref": "#/components/schemas/error-message"
  3410. }
  3411. }
  3412. }
  3413. },
  3414. "500": {
  3415. "description": "Error",
  3416. "content": {
  3417. "application/json": {
  3418. "schema": {
  3419. "$ref": "#/components/schemas/error-message"
  3420. }
  3421. }
  3422. }
  3423. }
  3424. },
  3425. "security": [
  3426. {
  3427. "api_key": []
  3428. }
  3429. ]
  3430. }
  3431. },
  3432. "/api/v2/update/move/{branch}": {
  3433. "get": {
  3434. "tags": [
  3435. "update"
  3436. ],
  3437. "summary": "Move Organizr Update Files",
  3438. "responses": {
  3439. "200": {
  3440. "description": "Success",
  3441. "content": {
  3442. "application/json": {
  3443. "schema": {
  3444. "$ref": "#/components/schemas/success-message"
  3445. }
  3446. }
  3447. }
  3448. },
  3449. "401": {
  3450. "description": "Unauthorized",
  3451. "content": {
  3452. "application/json": {
  3453. "schema": {
  3454. "$ref": "#/components/schemas/unauthorized-message"
  3455. }
  3456. }
  3457. }
  3458. },
  3459. "404": {
  3460. "description": "Error",
  3461. "content": {
  3462. "application/json": {
  3463. "schema": {
  3464. "$ref": "#/components/schemas/error-message"
  3465. }
  3466. }
  3467. }
  3468. },
  3469. "422": {
  3470. "description": "Error",
  3471. "content": {
  3472. "application/json": {
  3473. "schema": {
  3474. "$ref": "#/components/schemas/error-message"
  3475. }
  3476. }
  3477. }
  3478. },
  3479. "500": {
  3480. "description": "Error",
  3481. "content": {
  3482. "application/json": {
  3483. "schema": {
  3484. "$ref": "#/components/schemas/error-message"
  3485. }
  3486. }
  3487. }
  3488. }
  3489. },
  3490. "security": [
  3491. {
  3492. "api_key": []
  3493. }
  3494. ]
  3495. }
  3496. },
  3497. "/api/v2/update/cleanup/{branch}": {
  3498. "get": {
  3499. "tags": [
  3500. "update"
  3501. ],
  3502. "summary": "Cleanup Organizr Update Files",
  3503. "responses": {
  3504. "200": {
  3505. "description": "Success",
  3506. "content": {
  3507. "application/json": {
  3508. "schema": {
  3509. "$ref": "#/components/schemas/success-message"
  3510. }
  3511. }
  3512. }
  3513. },
  3514. "401": {
  3515. "description": "Unauthorized",
  3516. "content": {
  3517. "application/json": {
  3518. "schema": {
  3519. "$ref": "#/components/schemas/unauthorized-message"
  3520. }
  3521. }
  3522. }
  3523. },
  3524. "404": {
  3525. "description": "Error",
  3526. "content": {
  3527. "application/json": {
  3528. "schema": {
  3529. "$ref": "#/components/schemas/error-message"
  3530. }
  3531. }
  3532. }
  3533. },
  3534. "422": {
  3535. "description": "Error",
  3536. "content": {
  3537. "application/json": {
  3538. "schema": {
  3539. "$ref": "#/components/schemas/error-message"
  3540. }
  3541. }
  3542. }
  3543. },
  3544. "500": {
  3545. "description": "Error",
  3546. "content": {
  3547. "application/json": {
  3548. "schema": {
  3549. "$ref": "#/components/schemas/error-message"
  3550. }
  3551. }
  3552. }
  3553. }
  3554. },
  3555. "security": [
  3556. {
  3557. "api_key": []
  3558. }
  3559. ]
  3560. }
  3561. },
  3562. "/api/v2/update/docker": {
  3563. "get": {
  3564. "tags": [
  3565. "update"
  3566. ],
  3567. "summary": "Update Organizr install using Docker Container script",
  3568. "responses": {
  3569. "200": {
  3570. "description": "Success",
  3571. "content": {
  3572. "application/json": {
  3573. "schema": {
  3574. "$ref": "#/components/schemas/success-message"
  3575. }
  3576. }
  3577. }
  3578. },
  3579. "401": {
  3580. "description": "Unauthorized",
  3581. "content": {
  3582. "application/json": {
  3583. "schema": {
  3584. "$ref": "#/components/schemas/unauthorized-message"
  3585. }
  3586. }
  3587. }
  3588. },
  3589. "404": {
  3590. "description": "Error",
  3591. "content": {
  3592. "application/json": {
  3593. "schema": {
  3594. "$ref": "#/components/schemas/error-message"
  3595. }
  3596. }
  3597. }
  3598. },
  3599. "422": {
  3600. "description": "Error",
  3601. "content": {
  3602. "application/json": {
  3603. "schema": {
  3604. "$ref": "#/components/schemas/error-message"
  3605. }
  3606. }
  3607. }
  3608. },
  3609. "500": {
  3610. "description": "Error",
  3611. "content": {
  3612. "application/json": {
  3613. "schema": {
  3614. "$ref": "#/components/schemas/error-message"
  3615. }
  3616. }
  3617. }
  3618. }
  3619. },
  3620. "security": [
  3621. {
  3622. "api_key": []
  3623. }
  3624. ]
  3625. }
  3626. },
  3627. "/api/v2/update/windows": {
  3628. "get": {
  3629. "tags": [
  3630. "update"
  3631. ],
  3632. "summary": "Update Organizr install using Windows script",
  3633. "responses": {
  3634. "200": {
  3635. "description": "Success",
  3636. "content": {
  3637. "application/json": {
  3638. "schema": {
  3639. "$ref": "#/components/schemas/success-message"
  3640. }
  3641. }
  3642. }
  3643. },
  3644. "401": {
  3645. "description": "Unauthorized",
  3646. "content": {
  3647. "application/json": {
  3648. "schema": {
  3649. "$ref": "#/components/schemas/unauthorized-message"
  3650. }
  3651. }
  3652. }
  3653. },
  3654. "404": {
  3655. "description": "Error",
  3656. "content": {
  3657. "application/json": {
  3658. "schema": {
  3659. "$ref": "#/components/schemas/error-message"
  3660. }
  3661. }
  3662. }
  3663. },
  3664. "422": {
  3665. "description": "Error",
  3666. "content": {
  3667. "application/json": {
  3668. "schema": {
  3669. "$ref": "#/components/schemas/error-message"
  3670. }
  3671. }
  3672. }
  3673. },
  3674. "500": {
  3675. "description": "Error",
  3676. "content": {
  3677. "application/json": {
  3678. "schema": {
  3679. "$ref": "#/components/schemas/error-message"
  3680. }
  3681. }
  3682. }
  3683. }
  3684. },
  3685. "security": [
  3686. {
  3687. "api_key": []
  3688. }
  3689. ]
  3690. }
  3691. },
  3692. "/api/v2/update/linux": {
  3693. "get": {
  3694. "tags": [
  3695. "update"
  3696. ],
  3697. "summary": "Update Organizr install using Linux script",
  3698. "responses": {
  3699. "200": {
  3700. "description": "Success",
  3701. "content": {
  3702. "application/json": {
  3703. "schema": {
  3704. "$ref": "#/components/schemas/success-message"
  3705. }
  3706. }
  3707. }
  3708. },
  3709. "401": {
  3710. "description": "Unauthorized",
  3711. "content": {
  3712. "application/json": {
  3713. "schema": {
  3714. "$ref": "#/components/schemas/unauthorized-message"
  3715. }
  3716. }
  3717. }
  3718. },
  3719. "404": {
  3720. "description": "Error",
  3721. "content": {
  3722. "application/json": {
  3723. "schema": {
  3724. "$ref": "#/components/schemas/error-message"
  3725. }
  3726. }
  3727. }
  3728. },
  3729. "422": {
  3730. "description": "Error",
  3731. "content": {
  3732. "application/json": {
  3733. "schema": {
  3734. "$ref": "#/components/schemas/error-message"
  3735. }
  3736. }
  3737. }
  3738. },
  3739. "500": {
  3740. "description": "Error",
  3741. "content": {
  3742. "application/json": {
  3743. "schema": {
  3744. "$ref": "#/components/schemas/error-message"
  3745. }
  3746. }
  3747. }
  3748. }
  3749. },
  3750. "security": [
  3751. {
  3752. "api_key": []
  3753. }
  3754. ]
  3755. }
  3756. },
  3757. "/api/v2/update/migrate/{version}": {
  3758. "get": {
  3759. "tags": [
  3760. "update"
  3761. ],
  3762. "summary": "Run Organizr Version Mirgation for specific version",
  3763. "responses": {
  3764. "200": {
  3765. "description": "Success",
  3766. "content": {
  3767. "application/json": {
  3768. "schema": {
  3769. "$ref": "#/components/schemas/success-message"
  3770. }
  3771. }
  3772. }
  3773. },
  3774. "401": {
  3775. "description": "Unauthorized",
  3776. "content": {
  3777. "application/json": {
  3778. "schema": {
  3779. "$ref": "#/components/schemas/unauthorized-message"
  3780. }
  3781. }
  3782. }
  3783. },
  3784. "404": {
  3785. "description": "Error",
  3786. "content": {
  3787. "application/json": {
  3788. "schema": {
  3789. "$ref": "#/components/schemas/error-message"
  3790. }
  3791. }
  3792. }
  3793. },
  3794. "422": {
  3795. "description": "Error",
  3796. "content": {
  3797. "application/json": {
  3798. "schema": {
  3799. "$ref": "#/components/schemas/error-message"
  3800. }
  3801. }
  3802. }
  3803. },
  3804. "500": {
  3805. "description": "Error",
  3806. "content": {
  3807. "application/json": {
  3808. "schema": {
  3809. "$ref": "#/components/schemas/error-message"
  3810. }
  3811. }
  3812. }
  3813. }
  3814. },
  3815. "security": [
  3816. {
  3817. "api_key": []
  3818. }
  3819. ]
  3820. }
  3821. },
  3822. "/api/v2/update/reset/{feature}": {
  3823. "get": {
  3824. "tags": [
  3825. "update"
  3826. ],
  3827. "summary": "Reset an Organizr feature back to default values",
  3828. "responses": {
  3829. "200": {
  3830. "description": "Success",
  3831. "content": {
  3832. "application/json": {
  3833. "schema": {
  3834. "$ref": "#/components/schemas/success-message"
  3835. }
  3836. }
  3837. }
  3838. },
  3839. "401": {
  3840. "description": "Unauthorized",
  3841. "content": {
  3842. "application/json": {
  3843. "schema": {
  3844. "$ref": "#/components/schemas/unauthorized-message"
  3845. }
  3846. }
  3847. }
  3848. },
  3849. "404": {
  3850. "description": "Error",
  3851. "content": {
  3852. "application/json": {
  3853. "schema": {
  3854. "$ref": "#/components/schemas/error-message"
  3855. }
  3856. }
  3857. }
  3858. },
  3859. "422": {
  3860. "description": "Error",
  3861. "content": {
  3862. "application/json": {
  3863. "schema": {
  3864. "$ref": "#/components/schemas/error-message"
  3865. }
  3866. }
  3867. }
  3868. },
  3869. "500": {
  3870. "description": "Error",
  3871. "content": {
  3872. "application/json": {
  3873. "schema": {
  3874. "$ref": "#/components/schemas/error-message"
  3875. }
  3876. }
  3877. }
  3878. }
  3879. },
  3880. "security": [
  3881. {
  3882. "api_key": []
  3883. }
  3884. ]
  3885. }
  3886. }
  3887. },
  3888. "components": {
  3889. "schemas": {
  3890. "getChatMessages": {
  3891. "properties": {
  3892. "response": {
  3893. "properties": {
  3894. "result": {
  3895. "description": "success or error",
  3896. "type": "string",
  3897. "example": "success"
  3898. },
  3899. "message": {
  3900. "description": "success or error message",
  3901. "type": "string",
  3902. "example": null
  3903. },
  3904. "data": {
  3905. "description": "data from api",
  3906. "type": "array",
  3907. "items": {
  3908. "properties": {
  3909. "username": {
  3910. "type": "string",
  3911. "example": "causefx"
  3912. },
  3913. "date": {
  3914. "type": "string",
  3915. "example": "2018-09-01 02:02:24"
  3916. },
  3917. "gravatar": {
  3918. "type": "string",
  3919. "example": "https://www.gravatar.com/avatar/a47c4a4b915ddf9601cd228f890bc366?s=100&d=mm"
  3920. },
  3921. "message": {
  3922. "type": "string",
  3923. "example": "ok first message!"
  3924. },
  3925. "uid": {
  3926. "type": "string",
  3927. "example": "f5287"
  3928. }
  3929. },
  3930. "type": "object"
  3931. }
  3932. }
  3933. },
  3934. "type": "object"
  3935. }
  3936. },
  3937. "type": "object"
  3938. },
  3939. "submitMessageData": {
  3940. "properties": {
  3941. "message": {
  3942. "type": "string",
  3943. "example": "This is my message"
  3944. }
  3945. },
  3946. "type": "object"
  3947. },
  3948. "submitMessage": {
  3949. "properties": {
  3950. "response": {
  3951. "properties": {
  3952. "result": {
  3953. "description": "success or error",
  3954. "type": "string",
  3955. "example": "success"
  3956. },
  3957. "message": {
  3958. "description": "success or error message",
  3959. "type": "string",
  3960. "example": "message has been accepted"
  3961. },
  3962. "data": {
  3963. "description": "data from api",
  3964. "type": "string",
  3965. "example": null
  3966. }
  3967. },
  3968. "type": "object"
  3969. }
  3970. },
  3971. "type": "object"
  3972. },
  3973. "healthChecksRun": {
  3974. "properties": {
  3975. "response": {
  3976. "properties": {
  3977. "result": {
  3978. "description": "success or error",
  3979. "type": "string",
  3980. "example": "success"
  3981. },
  3982. "message": {
  3983. "description": "success or error message",
  3984. "type": "string",
  3985. "example": null
  3986. },
  3987. "data": {
  3988. "description": "data from api",
  3989. "type": "array",
  3990. "items": {
  3991. "properties": {
  3992. "Service Name": {
  3993. "type": "string",
  3994. "example": "Radarr"
  3995. },
  3996. "UUID": {
  3997. "type": "string",
  3998. "example": "883f0097-8f4c-4ca5-a9cf-053cfab8e334"
  3999. },
  4000. "External URL": {
  4001. "type": "string",
  4002. "example": "https://radarr.com"
  4003. },
  4004. "Internal URL": {
  4005. "type": "string",
  4006. "example": "http://radarr:7878"
  4007. },
  4008. "Enabled": {
  4009. "type": "string",
  4010. "example": "true"
  4011. },
  4012. "results": {
  4013. "type": "array",
  4014. "items": {
  4015. "properties": {
  4016. "internal": {
  4017. "type": "string",
  4018. "example": "Success"
  4019. },
  4020. "external": {
  4021. "type": "string",
  4022. "example": "Success"
  4023. }
  4024. },
  4025. "type": "object"
  4026. }
  4027. }
  4028. },
  4029. "type": "object"
  4030. }
  4031. }
  4032. },
  4033. "type": "object"
  4034. }
  4035. },
  4036. "type": "object"
  4037. },
  4038. "getInvites": {
  4039. "properties": {
  4040. "response": {
  4041. "properties": {
  4042. "result": {
  4043. "description": "success or error",
  4044. "type": "string",
  4045. "example": "success"
  4046. },
  4047. "message": {
  4048. "description": "success or error message",
  4049. "type": "string",
  4050. "example": null
  4051. },
  4052. "data": {
  4053. "description": "data from api",
  4054. "type": "array",
  4055. "items": {
  4056. "properties": {
  4057. "id": {
  4058. "type": "number",
  4059. "example": 1
  4060. },
  4061. "code": {
  4062. "type": "string",
  4063. "example": "NN9JH9"
  4064. },
  4065. "date": {
  4066. "type": "string",
  4067. "example": "2018-09-01 02:02:24"
  4068. },
  4069. "email": {
  4070. "type": "string",
  4071. "example": "causefX@organizr.app"
  4072. },
  4073. "username": {
  4074. "type": "string",
  4075. "example": "causefx"
  4076. },
  4077. "dateused": {
  4078. "type": "string",
  4079. "example": "2018-09-01 02:02:24"
  4080. },
  4081. "usedby": {
  4082. "type": "string",
  4083. "example": "causefx"
  4084. },
  4085. "ip": {
  4086. "type": "string",
  4087. "example": "10.0.0.0"
  4088. },
  4089. "valid": {
  4090. "type": "string",
  4091. "example": "No"
  4092. },
  4093. "type": {
  4094. "type": "string",
  4095. "example": "Plex"
  4096. }
  4097. },
  4098. "type": "object"
  4099. }
  4100. }
  4101. },
  4102. "type": "object"
  4103. }
  4104. },
  4105. "type": "object"
  4106. },
  4107. "createInviteCode": {
  4108. "properties": {
  4109. "response": {
  4110. "properties": {
  4111. "result": {
  4112. "description": "success or error",
  4113. "type": "string",
  4114. "example": "success"
  4115. },
  4116. "message": {
  4117. "description": "success or error message",
  4118. "type": "string",
  4119. "example": "Invite Code: XYXYXY has been created"
  4120. },
  4121. "data": {
  4122. "description": "data from api",
  4123. "type": "string",
  4124. "example": null
  4125. }
  4126. },
  4127. "type": "object"
  4128. }
  4129. },
  4130. "type": "object"
  4131. },
  4132. "verifyInviteCode": {
  4133. "properties": {
  4134. "response": {
  4135. "properties": {
  4136. "result": {
  4137. "description": "success or error",
  4138. "type": "string",
  4139. "example": "success"
  4140. },
  4141. "message": {
  4142. "description": "success or error message",
  4143. "type": "string",
  4144. "example": "Code has been verified"
  4145. },
  4146. "data": {
  4147. "description": "data from api",
  4148. "type": "string",
  4149. "example": null
  4150. }
  4151. },
  4152. "type": "object"
  4153. }
  4154. },
  4155. "type": "object"
  4156. },
  4157. "useInviteCode": {
  4158. "properties": {
  4159. "response": {
  4160. "properties": {
  4161. "result": {
  4162. "description": "success or error",
  4163. "type": "string",
  4164. "example": "success"
  4165. },
  4166. "message": {
  4167. "description": "success or error message",
  4168. "type": "string",
  4169. "example": "Plex/Emby User now has access to system"
  4170. },
  4171. "data": {
  4172. "description": "data from api",
  4173. "type": "string",
  4174. "example": null
  4175. }
  4176. },
  4177. "type": "object"
  4178. }
  4179. },
  4180. "type": "object"
  4181. },
  4182. "deleteInviteCode": {
  4183. "properties": {
  4184. "response": {
  4185. "properties": {
  4186. "result": {
  4187. "description": "success or error",
  4188. "type": "string",
  4189. "example": "success"
  4190. },
  4191. "message": {
  4192. "description": "success or error message",
  4193. "type": "string",
  4194. "example": "Code has been deleted"
  4195. },
  4196. "data": {
  4197. "description": "data from api",
  4198. "type": "string",
  4199. "example": null
  4200. }
  4201. },
  4202. "type": "object"
  4203. }
  4204. },
  4205. "type": "object"
  4206. },
  4207. "sendEmailData": {
  4208. "properties": {
  4209. "bcc": {
  4210. "description": "email of recipients (csv)",
  4211. "type": "string",
  4212. "example": "causefx@organizr.app,elmer@organizr.app"
  4213. },
  4214. "subject": {
  4215. "type": "string",
  4216. "example": "Hey There Buddy?!"
  4217. },
  4218. "body": {
  4219. "type": "string",
  4220. "example": "Hi! Boy, has it been a long time! Have you seen rox in socks?"
  4221. }
  4222. },
  4223. "type": "object"
  4224. },
  4225. "submit-2fa-verify": {
  4226. "properties": {
  4227. "secret": {
  4228. "type": "string",
  4229. "example": "OX1R4GA3425GSDF"
  4230. },
  4231. "code": {
  4232. "type": "string",
  4233. "example": "145047"
  4234. },
  4235. "type": {
  4236. "type": "string",
  4237. "example": "google"
  4238. }
  4239. },
  4240. "type": "object"
  4241. },
  4242. "submit-2fa-save": {
  4243. "properties": {
  4244. "secret": {
  4245. "type": "string",
  4246. "example": "OX1R4GA3425GSDF"
  4247. },
  4248. "type": {
  4249. "type": "string",
  4250. "example": "google"
  4251. }
  4252. },
  4253. "type": "object"
  4254. },
  4255. "submit-2fa-create": {
  4256. "properties": {
  4257. "type": {
  4258. "type": "string",
  4259. "example": "google"
  4260. }
  4261. },
  4262. "type": "object"
  4263. },
  4264. "get-html": {
  4265. "properties": {
  4266. "response": {
  4267. "properties": {
  4268. "result": {
  4269. "description": "success or error",
  4270. "type": "string",
  4271. "example": "success"
  4272. },
  4273. "message": {
  4274. "description": "success message or error message",
  4275. "type": "string",
  4276. "example": null
  4277. },
  4278. "data": {
  4279. "description": "data from api",
  4280. "type": "string",
  4281. "example": "\\r\\n\\u003Cscript\\u003E\\r\\n (function() {\\r\\n updateCheck();\\r\\n authDebugCheck();\\r\\n sponsorLoad();\\r\\n newsLoad();\\r\\n checkCommitLoad();\\r\\n [].slice.call(document.querySelectorAll('.sttabs-main-settings-div')).forEach(function(el) {\\r\\n new CBPFWTabs(el);\\r\\n });\\r\\n })();\\r\\n\\u003C/script\\u003E\\r\\n"
  4282. }
  4283. },
  4284. "type": "object"
  4285. }
  4286. },
  4287. "type": "object"
  4288. },
  4289. "plexRegister": {
  4290. "properties": {
  4291. "username": {
  4292. "type": "string",
  4293. "example": "causefx"
  4294. },
  4295. "email": {
  4296. "type": "string",
  4297. "example": "causefx@organizr.app"
  4298. },
  4299. "password": {
  4300. "type": "string",
  4301. "example": "iCanHazPa$$w0Rd"
  4302. }
  4303. },
  4304. "type": "object"
  4305. },
  4306. "ping": {
  4307. "properties": {
  4308. "response": {
  4309. "properties": {
  4310. "result": {
  4311. "description": "success or error",
  4312. "type": "string",
  4313. "example": "success"
  4314. },
  4315. "message": {
  4316. "description": "success or error message",
  4317. "type": "string",
  4318. "example": null
  4319. },
  4320. "data": {
  4321. "description": "data from api",
  4322. "type": "string",
  4323. "example": "pong"
  4324. }
  4325. },
  4326. "type": "object"
  4327. }
  4328. },
  4329. "type": "object"
  4330. },
  4331. "status": {
  4332. "properties": {
  4333. "response": {
  4334. "properties": {
  4335. "result": {
  4336. "description": "success or error",
  4337. "type": "string",
  4338. "example": "success"
  4339. },
  4340. "message": {
  4341. "description": "success or error message",
  4342. "type": "string",
  4343. "example": null
  4344. },
  4345. "data": {
  4346. "description": "data from api",
  4347. "properties": {
  4348. "status": {
  4349. "description": "success or error",
  4350. "type": "string",
  4351. "example": "ok"
  4352. },
  4353. "api_version": {
  4354. "type": "string",
  4355. "example": "2.0"
  4356. },
  4357. "organizr_version": {
  4358. "type": "string",
  4359. "example": "2.0.650"
  4360. }
  4361. },
  4362. "type": "object"
  4363. }
  4364. },
  4365. "type": "object"
  4366. }
  4367. },
  4368. "type": "object"
  4369. },
  4370. "pluginSettingsPage": {
  4371. "properties": {
  4372. "response": {
  4373. "properties": {
  4374. "result": {
  4375. "description": "success or error",
  4376. "type": "string",
  4377. "example": "success"
  4378. },
  4379. "message": {
  4380. "description": "success or error message",
  4381. "type": "string",
  4382. "example": null
  4383. },
  4384. "data": {
  4385. "description": "data from api",
  4386. "properties": {
  4387. "settingsPageObjectItem1": {
  4388. "type": "object"
  4389. },
  4390. "settingsPageObjectItem2": {
  4391. "type": "object"
  4392. },
  4393. "settingsPageObjectItem3": {
  4394. "type": "object"
  4395. }
  4396. },
  4397. "type": "object"
  4398. }
  4399. },
  4400. "type": "object"
  4401. }
  4402. },
  4403. "type": "object"
  4404. },
  4405. "successNullData": {
  4406. "properties": {
  4407. "response": {
  4408. "properties": {
  4409. "result": {
  4410. "description": "success or error",
  4411. "type": "string",
  4412. "example": "success"
  4413. },
  4414. "message": {
  4415. "description": "success message or error message",
  4416. "type": "string",
  4417. "example": null
  4418. },
  4419. "data": {
  4420. "description": "data from api",
  4421. "type": "string",
  4422. "example": null
  4423. }
  4424. },
  4425. "type": "object"
  4426. }
  4427. },
  4428. "type": "object"
  4429. },
  4430. "success-message": {
  4431. "properties": {
  4432. "response": {
  4433. "properties": {
  4434. "result": {
  4435. "description": "success or error",
  4436. "type": "string",
  4437. "example": "success"
  4438. },
  4439. "message": {
  4440. "description": "success message or error message",
  4441. "type": "string",
  4442. "example": "Successful message here"
  4443. },
  4444. "data": {
  4445. "description": "data from api",
  4446. "type": "string",
  4447. "example": null
  4448. }
  4449. },
  4450. "type": "object"
  4451. }
  4452. },
  4453. "type": "object"
  4454. },
  4455. "error-message": {
  4456. "properties": {
  4457. "response": {
  4458. "properties": {
  4459. "result": {
  4460. "description": "success or error",
  4461. "type": "string",
  4462. "example": "error"
  4463. },
  4464. "message": {
  4465. "description": "success message or error message",
  4466. "type": "string",
  4467. "example": "Error message here"
  4468. },
  4469. "data": {
  4470. "description": "data from api",
  4471. "type": "string",
  4472. "example": null
  4473. }
  4474. },
  4475. "type": "object"
  4476. }
  4477. },
  4478. "type": "object"
  4479. },
  4480. "unauthorized-message": {
  4481. "properties": {
  4482. "response": {
  4483. "properties": {
  4484. "result": {
  4485. "description": "success or error",
  4486. "type": "string",
  4487. "example": "error"
  4488. },
  4489. "message": {
  4490. "description": "success message or error message",
  4491. "type": "string",
  4492. "example": "User is not authorized"
  4493. },
  4494. "data": {
  4495. "description": "data from api",
  4496. "type": "string",
  4497. "example": null
  4498. }
  4499. },
  4500. "type": "object"
  4501. }
  4502. },
  4503. "type": "object"
  4504. },
  4505. "php-mailer-email-list": {
  4506. "properties": {
  4507. "response": {
  4508. "properties": {
  4509. "result": {
  4510. "description": "success or error",
  4511. "type": "string",
  4512. "example": "success"
  4513. },
  4514. "message": {
  4515. "description": "success or error message",
  4516. "type": "string",
  4517. "example": null
  4518. },
  4519. "data": {
  4520. "description": "data from api",
  4521. "type": "array",
  4522. "items": {
  4523. "properties": {
  4524. "causefx": {
  4525. "type": "string",
  4526. "example": "causefx@organizr.app"
  4527. }
  4528. },
  4529. "type": "object"
  4530. }
  4531. }
  4532. },
  4533. "type": "object"
  4534. }
  4535. },
  4536. "type": "object"
  4537. },
  4538. "config-items-example": {
  4539. "description": "list of config items to update",
  4540. "properties": {
  4541. "branch": {
  4542. "description": "config item name",
  4543. "type": "string",
  4544. "example": "v2-master"
  4545. },
  4546. "hideRegistration": {
  4547. "type": "boolean",
  4548. "example": false
  4549. },
  4550. "homepageUnifiAuth": {
  4551. "type": "string",
  4552. "example": "1"
  4553. }
  4554. },
  4555. "type": "object"
  4556. }
  4557. },
  4558. "securitySchemes": {
  4559. "api_key": {
  4560. "type": "apiKey",
  4561. "name": "Token",
  4562. "in": "header"
  4563. }
  4564. }
  4565. },
  4566. "tags": [
  4567. {
  4568. "name": "plugins-chat",
  4569. "description": "Pusher Chat Plugin"
  4570. },
  4571. {
  4572. "name": "plugins-healthchecks",
  4573. "description": "Healthchecks.io Ping Plugin"
  4574. },
  4575. {
  4576. "name": "plugins-invites",
  4577. "description": "Media Invite Plugin"
  4578. },
  4579. {
  4580. "name": "plugins-php-mailer",
  4581. "description": "PHP Mailer Plugin"
  4582. },
  4583. {
  4584. "name": "plugins-speedtest",
  4585. "description": "SpeedTest Plugin"
  4586. },
  4587. {
  4588. "name": "2fa",
  4589. "description": "Two Form Authentication"
  4590. },
  4591. {
  4592. "name": "categories",
  4593. "description": "Category Information"
  4594. },
  4595. {
  4596. "name": "config",
  4597. "description": "Organizr Configuration Items"
  4598. },
  4599. {
  4600. "name": "test connection",
  4601. "description": "Test Connections"
  4602. },
  4603. {
  4604. "name": "emby"
  4605. },
  4606. {
  4607. "name": "page",
  4608. "description": "HTML for Organizr Pages"
  4609. },
  4610. {
  4611. "name": "plex"
  4612. },
  4613. {
  4614. "name": "plugins"
  4615. },
  4616. {
  4617. "name": "update",
  4618. "description": "Organizr Update"
  4619. }
  4620. ]
  4621. }