api.json 146 KB

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