api.json 171 KB

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