api.json 145 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999
  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/test/ldap": {
  1192. "post": {
  1193. "tags": [
  1194. "test connection"
  1195. ],
  1196. "summary": "Test LDAP connection",
  1197. "responses": {
  1198. "200": {
  1199. "description": "Success",
  1200. "content": {
  1201. "application/json": {
  1202. "schema": {
  1203. "$ref": "#/components/schemas/success-message"
  1204. }
  1205. }
  1206. }
  1207. },
  1208. "401": {
  1209. "description": "Unauthorized",
  1210. "content": {
  1211. "application/json": {
  1212. "schema": {
  1213. "$ref": "#/components/schemas/unauthorized-message"
  1214. }
  1215. }
  1216. }
  1217. },
  1218. "404": {
  1219. "description": "Error",
  1220. "content": {
  1221. "application/json": {
  1222. "schema": {
  1223. "$ref": "#/components/schemas/error-message"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "409": {
  1229. "description": "Error",
  1230. "content": {
  1231. "application/json": {
  1232. "schema": {
  1233. "$ref": "#/components/schemas/error-message"
  1234. }
  1235. }
  1236. }
  1237. }
  1238. },
  1239. "security": [
  1240. {
  1241. "api_key": []
  1242. }
  1243. ]
  1244. }
  1245. },
  1246. "/api/v2/test/ldap/login": {
  1247. "post": {
  1248. "tags": [
  1249. "test connection"
  1250. ],
  1251. "summary": "Test LDAP connection using account login",
  1252. "responses": {
  1253. "200": {
  1254. "description": "Success",
  1255. "content": {
  1256. "application/json": {
  1257. "schema": {
  1258. "$ref": "#/components/schemas/success-message"
  1259. }
  1260. }
  1261. }
  1262. },
  1263. "401": {
  1264. "description": "Unauthorized",
  1265. "content": {
  1266. "application/json": {
  1267. "schema": {
  1268. "$ref": "#/components/schemas/unauthorized-message"
  1269. }
  1270. }
  1271. }
  1272. },
  1273. "404": {
  1274. "description": "Error",
  1275. "content": {
  1276. "application/json": {
  1277. "schema": {
  1278. "$ref": "#/components/schemas/error-message"
  1279. }
  1280. }
  1281. }
  1282. },
  1283. "409": {
  1284. "description": "Error",
  1285. "content": {
  1286. "application/json": {
  1287. "schema": {
  1288. "$ref": "#/components/schemas/error-message"
  1289. }
  1290. }
  1291. }
  1292. }
  1293. },
  1294. "security": [
  1295. {
  1296. "api_key": []
  1297. }
  1298. ]
  1299. }
  1300. },
  1301. "/api/v2/test/iframe": {
  1302. "post": {
  1303. "tags": [
  1304. "test connection"
  1305. ],
  1306. "summary": "Test if URL can be iFramed",
  1307. "responses": {
  1308. "200": {
  1309. "description": "Success",
  1310. "content": {
  1311. "application/json": {
  1312. "schema": {
  1313. "$ref": "#/components/schemas/success-message"
  1314. }
  1315. }
  1316. }
  1317. },
  1318. "401": {
  1319. "description": "Unauthorized",
  1320. "content": {
  1321. "application/json": {
  1322. "schema": {
  1323. "$ref": "#/components/schemas/unauthorized-message"
  1324. }
  1325. }
  1326. }
  1327. },
  1328. "404": {
  1329. "description": "Error",
  1330. "content": {
  1331. "application/json": {
  1332. "schema": {
  1333. "$ref": "#/components/schemas/error-message"
  1334. }
  1335. }
  1336. }
  1337. },
  1338. "409": {
  1339. "description": "Error",
  1340. "content": {
  1341. "application/json": {
  1342. "schema": {
  1343. "$ref": "#/components/schemas/error-message"
  1344. }
  1345. }
  1346. }
  1347. }
  1348. },
  1349. "security": [
  1350. {
  1351. "api_key": []
  1352. }
  1353. ]
  1354. }
  1355. },
  1356. "/api/v2/test/path": {
  1357. "post": {
  1358. "tags": [
  1359. "test connection"
  1360. ],
  1361. "summary": "Test if path has correct permissions",
  1362. "responses": {
  1363. "200": {
  1364. "description": "Success",
  1365. "content": {
  1366. "application/json": {
  1367. "schema": {
  1368. "$ref": "#/components/schemas/success-message"
  1369. }
  1370. }
  1371. }
  1372. },
  1373. "401": {
  1374. "description": "Unauthorized",
  1375. "content": {
  1376. "application/json": {
  1377. "schema": {
  1378. "$ref": "#/components/schemas/unauthorized-message"
  1379. }
  1380. }
  1381. }
  1382. },
  1383. "404": {
  1384. "description": "Error",
  1385. "content": {
  1386. "application/json": {
  1387. "schema": {
  1388. "$ref": "#/components/schemas/error-message"
  1389. }
  1390. }
  1391. }
  1392. }
  1393. },
  1394. "security": [
  1395. {
  1396. "api_key": []
  1397. }
  1398. ]
  1399. }
  1400. },
  1401. "/api/v2/test/plex": {
  1402. "post": {
  1403. "tags": [
  1404. "test connection"
  1405. ],
  1406. "summary": "Test connection to Plex",
  1407. "responses": {
  1408. "200": {
  1409. "description": "Success",
  1410. "content": {
  1411. "application/json": {
  1412. "schema": {
  1413. "$ref": "#/components/schemas/success-message"
  1414. }
  1415. }
  1416. }
  1417. },
  1418. "401": {
  1419. "description": "Unauthorized",
  1420. "content": {
  1421. "application/json": {
  1422. "schema": {
  1423. "$ref": "#/components/schemas/unauthorized-message"
  1424. }
  1425. }
  1426. }
  1427. },
  1428. "422": {
  1429. "description": "Error",
  1430. "content": {
  1431. "application/json": {
  1432. "schema": {
  1433. "$ref": "#/components/schemas/error-message"
  1434. }
  1435. }
  1436. }
  1437. },
  1438. "500": {
  1439. "description": "Error",
  1440. "content": {
  1441. "application/json": {
  1442. "schema": {
  1443. "$ref": "#/components/schemas/error-message"
  1444. }
  1445. }
  1446. }
  1447. }
  1448. },
  1449. "security": [
  1450. {
  1451. "api_key": []
  1452. }
  1453. ]
  1454. }
  1455. },
  1456. "/api/v2/test/emby": {
  1457. "post": {
  1458. "tags": [
  1459. "test connection"
  1460. ],
  1461. "summary": "Test connection to Emby",
  1462. "responses": {
  1463. "200": {
  1464. "description": "Success",
  1465. "content": {
  1466. "application/json": {
  1467. "schema": {
  1468. "$ref": "#/components/schemas/success-message"
  1469. }
  1470. }
  1471. }
  1472. },
  1473. "401": {
  1474. "description": "Unauthorized",
  1475. "content": {
  1476. "application/json": {
  1477. "schema": {
  1478. "$ref": "#/components/schemas/unauthorized-message"
  1479. }
  1480. }
  1481. }
  1482. },
  1483. "422": {
  1484. "description": "Error",
  1485. "content": {
  1486. "application/json": {
  1487. "schema": {
  1488. "$ref": "#/components/schemas/error-message"
  1489. }
  1490. }
  1491. }
  1492. },
  1493. "500": {
  1494. "description": "Error",
  1495. "content": {
  1496. "application/json": {
  1497. "schema": {
  1498. "$ref": "#/components/schemas/error-message"
  1499. }
  1500. }
  1501. }
  1502. }
  1503. },
  1504. "security": [
  1505. {
  1506. "api_key": []
  1507. }
  1508. ]
  1509. }
  1510. },
  1511. "/api/v2/test/jellyfin": {
  1512. "post": {
  1513. "tags": [
  1514. "test connection"
  1515. ],
  1516. "summary": "Test connection to Jellyfin",
  1517. "responses": {
  1518. "200": {
  1519. "description": "Success",
  1520. "content": {
  1521. "application/json": {
  1522. "schema": {
  1523. "$ref": "#/components/schemas/success-message"
  1524. }
  1525. }
  1526. }
  1527. },
  1528. "401": {
  1529. "description": "Unauthorized",
  1530. "content": {
  1531. "application/json": {
  1532. "schema": {
  1533. "$ref": "#/components/schemas/unauthorized-message"
  1534. }
  1535. }
  1536. }
  1537. },
  1538. "422": {
  1539. "description": "Error",
  1540. "content": {
  1541. "application/json": {
  1542. "schema": {
  1543. "$ref": "#/components/schemas/error-message"
  1544. }
  1545. }
  1546. }
  1547. },
  1548. "500": {
  1549. "description": "Error",
  1550. "content": {
  1551. "application/json": {
  1552. "schema": {
  1553. "$ref": "#/components/schemas/error-message"
  1554. }
  1555. }
  1556. }
  1557. }
  1558. },
  1559. "security": [
  1560. {
  1561. "api_key": []
  1562. }
  1563. ]
  1564. }
  1565. },
  1566. "/api/v2/test/sabnzbd": {
  1567. "post": {
  1568. "tags": [
  1569. "test connection"
  1570. ],
  1571. "summary": "Test connection to SabNZBd",
  1572. "responses": {
  1573. "200": {
  1574. "description": "Success",
  1575. "content": {
  1576. "application/json": {
  1577. "schema": {
  1578. "$ref": "#/components/schemas/success-message"
  1579. }
  1580. }
  1581. }
  1582. },
  1583. "401": {
  1584. "description": "Unauthorized",
  1585. "content": {
  1586. "application/json": {
  1587. "schema": {
  1588. "$ref": "#/components/schemas/unauthorized-message"
  1589. }
  1590. }
  1591. }
  1592. },
  1593. "422": {
  1594. "description": "Error",
  1595. "content": {
  1596. "application/json": {
  1597. "schema": {
  1598. "$ref": "#/components/schemas/error-message"
  1599. }
  1600. }
  1601. }
  1602. },
  1603. "500": {
  1604. "description": "Error",
  1605. "content": {
  1606. "application/json": {
  1607. "schema": {
  1608. "$ref": "#/components/schemas/error-message"
  1609. }
  1610. }
  1611. }
  1612. }
  1613. },
  1614. "security": [
  1615. {
  1616. "api_key": []
  1617. }
  1618. ]
  1619. }
  1620. },
  1621. "/api/v2/test/pihole": {
  1622. "post": {
  1623. "tags": [
  1624. "test connection"
  1625. ],
  1626. "summary": "Test connection to PiHole",
  1627. "responses": {
  1628. "200": {
  1629. "description": "Success",
  1630. "content": {
  1631. "application/json": {
  1632. "schema": {
  1633. "$ref": "#/components/schemas/success-message"
  1634. }
  1635. }
  1636. }
  1637. },
  1638. "401": {
  1639. "description": "Unauthorized",
  1640. "content": {
  1641. "application/json": {
  1642. "schema": {
  1643. "$ref": "#/components/schemas/unauthorized-message"
  1644. }
  1645. }
  1646. }
  1647. },
  1648. "422": {
  1649. "description": "Error",
  1650. "content": {
  1651. "application/json": {
  1652. "schema": {
  1653. "$ref": "#/components/schemas/error-message"
  1654. }
  1655. }
  1656. }
  1657. },
  1658. "500": {
  1659. "description": "Error",
  1660. "content": {
  1661. "application/json": {
  1662. "schema": {
  1663. "$ref": "#/components/schemas/error-message"
  1664. }
  1665. }
  1666. }
  1667. }
  1668. },
  1669. "security": [
  1670. {
  1671. "api_key": []
  1672. }
  1673. ]
  1674. }
  1675. },
  1676. "/api/v2/test/rtorrent": {
  1677. "post": {
  1678. "tags": [
  1679. "test connection"
  1680. ],
  1681. "summary": "Test connection to rTorrent",
  1682. "responses": {
  1683. "200": {
  1684. "description": "Success",
  1685. "content": {
  1686. "application/json": {
  1687. "schema": {
  1688. "$ref": "#/components/schemas/success-message"
  1689. }
  1690. }
  1691. }
  1692. },
  1693. "401": {
  1694. "description": "Unauthorized",
  1695. "content": {
  1696. "application/json": {
  1697. "schema": {
  1698. "$ref": "#/components/schemas/unauthorized-message"
  1699. }
  1700. }
  1701. }
  1702. },
  1703. "422": {
  1704. "description": "Error",
  1705. "content": {
  1706. "application/json": {
  1707. "schema": {
  1708. "$ref": "#/components/schemas/error-message"
  1709. }
  1710. }
  1711. }
  1712. },
  1713. "500": {
  1714. "description": "Error",
  1715. "content": {
  1716. "application/json": {
  1717. "schema": {
  1718. "$ref": "#/components/schemas/error-message"
  1719. }
  1720. }
  1721. }
  1722. }
  1723. },
  1724. "security": [
  1725. {
  1726. "api_key": []
  1727. }
  1728. ]
  1729. }
  1730. },
  1731. "/api/v2/test/sonarr": {
  1732. "post": {
  1733. "tags": [
  1734. "test connection"
  1735. ],
  1736. "summary": "Test connection to Sonarr",
  1737. "responses": {
  1738. "200": {
  1739. "description": "Success",
  1740. "content": {
  1741. "application/json": {
  1742. "schema": {
  1743. "$ref": "#/components/schemas/success-message"
  1744. }
  1745. }
  1746. }
  1747. },
  1748. "401": {
  1749. "description": "Unauthorized",
  1750. "content": {
  1751. "application/json": {
  1752. "schema": {
  1753. "$ref": "#/components/schemas/unauthorized-message"
  1754. }
  1755. }
  1756. }
  1757. },
  1758. "422": {
  1759. "description": "Error",
  1760. "content": {
  1761. "application/json": {
  1762. "schema": {
  1763. "$ref": "#/components/schemas/error-message"
  1764. }
  1765. }
  1766. }
  1767. },
  1768. "500": {
  1769. "description": "Error",
  1770. "content": {
  1771. "application/json": {
  1772. "schema": {
  1773. "$ref": "#/components/schemas/error-message"
  1774. }
  1775. }
  1776. }
  1777. }
  1778. },
  1779. "security": [
  1780. {
  1781. "api_key": []
  1782. }
  1783. ]
  1784. }
  1785. },
  1786. "/api/v2/test/radarr": {
  1787. "post": {
  1788. "tags": [
  1789. "test connection"
  1790. ],
  1791. "summary": "Test connection to Radarr",
  1792. "responses": {
  1793. "200": {
  1794. "description": "Success",
  1795. "content": {
  1796. "application/json": {
  1797. "schema": {
  1798. "$ref": "#/components/schemas/success-message"
  1799. }
  1800. }
  1801. }
  1802. },
  1803. "401": {
  1804. "description": "Unauthorized",
  1805. "content": {
  1806. "application/json": {
  1807. "schema": {
  1808. "$ref": "#/components/schemas/unauthorized-message"
  1809. }
  1810. }
  1811. }
  1812. },
  1813. "422": {
  1814. "description": "Error",
  1815. "content": {
  1816. "application/json": {
  1817. "schema": {
  1818. "$ref": "#/components/schemas/error-message"
  1819. }
  1820. }
  1821. }
  1822. },
  1823. "500": {
  1824. "description": "Error",
  1825. "content": {
  1826. "application/json": {
  1827. "schema": {
  1828. "$ref": "#/components/schemas/error-message"
  1829. }
  1830. }
  1831. }
  1832. }
  1833. },
  1834. "security": [
  1835. {
  1836. "api_key": []
  1837. }
  1838. ]
  1839. }
  1840. },
  1841. "/api/v2/test/lidarr": {
  1842. "post": {
  1843. "tags": [
  1844. "test connection"
  1845. ],
  1846. "summary": "Test connection to Lidarr",
  1847. "responses": {
  1848. "200": {
  1849. "description": "Success",
  1850. "content": {
  1851. "application/json": {
  1852. "schema": {
  1853. "$ref": "#/components/schemas/success-message"
  1854. }
  1855. }
  1856. }
  1857. },
  1858. "401": {
  1859. "description": "Unauthorized",
  1860. "content": {
  1861. "application/json": {
  1862. "schema": {
  1863. "$ref": "#/components/schemas/unauthorized-message"
  1864. }
  1865. }
  1866. }
  1867. },
  1868. "422": {
  1869. "description": "Error",
  1870. "content": {
  1871. "application/json": {
  1872. "schema": {
  1873. "$ref": "#/components/schemas/error-message"
  1874. }
  1875. }
  1876. }
  1877. },
  1878. "500": {
  1879. "description": "Error",
  1880. "content": {
  1881. "application/json": {
  1882. "schema": {
  1883. "$ref": "#/components/schemas/error-message"
  1884. }
  1885. }
  1886. }
  1887. }
  1888. },
  1889. "security": [
  1890. {
  1891. "api_key": []
  1892. }
  1893. ]
  1894. }
  1895. },
  1896. "/api/v2/test/sickrage": {
  1897. "post": {
  1898. "tags": [
  1899. "test connection"
  1900. ],
  1901. "summary": "Test connection to SickRage",
  1902. "responses": {
  1903. "200": {
  1904. "description": "Success",
  1905. "content": {
  1906. "application/json": {
  1907. "schema": {
  1908. "$ref": "#/components/schemas/success-message"
  1909. }
  1910. }
  1911. }
  1912. },
  1913. "401": {
  1914. "description": "Unauthorized",
  1915. "content": {
  1916. "application/json": {
  1917. "schema": {
  1918. "$ref": "#/components/schemas/unauthorized-message"
  1919. }
  1920. }
  1921. }
  1922. },
  1923. "422": {
  1924. "description": "Error",
  1925. "content": {
  1926. "application/json": {
  1927. "schema": {
  1928. "$ref": "#/components/schemas/error-message"
  1929. }
  1930. }
  1931. }
  1932. },
  1933. "500": {
  1934. "description": "Error",
  1935. "content": {
  1936. "application/json": {
  1937. "schema": {
  1938. "$ref": "#/components/schemas/error-message"
  1939. }
  1940. }
  1941. }
  1942. }
  1943. },
  1944. "security": [
  1945. {
  1946. "api_key": []
  1947. }
  1948. ]
  1949. }
  1950. },
  1951. "/api/v2/test/ombi": {
  1952. "post": {
  1953. "tags": [
  1954. "test connection"
  1955. ],
  1956. "summary": "Test connection to Ombi",
  1957. "responses": {
  1958. "200": {
  1959. "description": "Success",
  1960. "content": {
  1961. "application/json": {
  1962. "schema": {
  1963. "$ref": "#/components/schemas/success-message"
  1964. }
  1965. }
  1966. }
  1967. },
  1968. "401": {
  1969. "description": "Unauthorized",
  1970. "content": {
  1971. "application/json": {
  1972. "schema": {
  1973. "$ref": "#/components/schemas/unauthorized-message"
  1974. }
  1975. }
  1976. }
  1977. },
  1978. "422": {
  1979. "description": "Error",
  1980. "content": {
  1981. "application/json": {
  1982. "schema": {
  1983. "$ref": "#/components/schemas/error-message"
  1984. }
  1985. }
  1986. }
  1987. },
  1988. "500": {
  1989. "description": "Error",
  1990. "content": {
  1991. "application/json": {
  1992. "schema": {
  1993. "$ref": "#/components/schemas/error-message"
  1994. }
  1995. }
  1996. }
  1997. }
  1998. },
  1999. "security": [
  2000. {
  2001. "api_key": []
  2002. }
  2003. ]
  2004. }
  2005. },
  2006. "/api/v2/test/overseerr": {
  2007. "post": {
  2008. "tags": [
  2009. "test connection"
  2010. ],
  2011. "summary": "Test connection to Overseerr",
  2012. "responses": {
  2013. "200": {
  2014. "description": "Success",
  2015. "content": {
  2016. "application/json": {
  2017. "schema": {
  2018. "$ref": "#/components/schemas/success-message"
  2019. }
  2020. }
  2021. }
  2022. },
  2023. "401": {
  2024. "description": "Unauthorized",
  2025. "content": {
  2026. "application/json": {
  2027. "schema": {
  2028. "$ref": "#/components/schemas/unauthorized-message"
  2029. }
  2030. }
  2031. }
  2032. },
  2033. "422": {
  2034. "description": "Error",
  2035. "content": {
  2036. "application/json": {
  2037. "schema": {
  2038. "$ref": "#/components/schemas/error-message"
  2039. }
  2040. }
  2041. }
  2042. },
  2043. "500": {
  2044. "description": "Error",
  2045. "content": {
  2046. "application/json": {
  2047. "schema": {
  2048. "$ref": "#/components/schemas/error-message"
  2049. }
  2050. }
  2051. }
  2052. }
  2053. },
  2054. "security": [
  2055. {
  2056. "api_key": []
  2057. }
  2058. ]
  2059. }
  2060. },
  2061. "/api/v2/test/nzbget": {
  2062. "post": {
  2063. "tags": [
  2064. "test connection"
  2065. ],
  2066. "summary": "Test connection to NzbGet",
  2067. "responses": {
  2068. "200": {
  2069. "description": "Success",
  2070. "content": {
  2071. "application/json": {
  2072. "schema": {
  2073. "$ref": "#/components/schemas/success-message"
  2074. }
  2075. }
  2076. }
  2077. },
  2078. "401": {
  2079. "description": "Unauthorized",
  2080. "content": {
  2081. "application/json": {
  2082. "schema": {
  2083. "$ref": "#/components/schemas/unauthorized-message"
  2084. }
  2085. }
  2086. }
  2087. },
  2088. "422": {
  2089. "description": "Error",
  2090. "content": {
  2091. "application/json": {
  2092. "schema": {
  2093. "$ref": "#/components/schemas/error-message"
  2094. }
  2095. }
  2096. }
  2097. },
  2098. "500": {
  2099. "description": "Error",
  2100. "content": {
  2101. "application/json": {
  2102. "schema": {
  2103. "$ref": "#/components/schemas/error-message"
  2104. }
  2105. }
  2106. }
  2107. }
  2108. },
  2109. "security": [
  2110. {
  2111. "api_key": []
  2112. }
  2113. ]
  2114. }
  2115. },
  2116. "/api/v2/test/utorrent": {
  2117. "post": {
  2118. "tags": [
  2119. "test connection"
  2120. ],
  2121. "summary": "Test connection to uTorrent",
  2122. "responses": {
  2123. "200": {
  2124. "description": "Success",
  2125. "content": {
  2126. "application/json": {
  2127. "schema": {
  2128. "$ref": "#/components/schemas/success-message"
  2129. }
  2130. }
  2131. }
  2132. },
  2133. "401": {
  2134. "description": "Unauthorized",
  2135. "content": {
  2136. "application/json": {
  2137. "schema": {
  2138. "$ref": "#/components/schemas/unauthorized-message"
  2139. }
  2140. }
  2141. }
  2142. },
  2143. "400": {
  2144. "description": "Error",
  2145. "content": {
  2146. "application/json": {
  2147. "schema": {
  2148. "$ref": "#/components/schemas/error-message"
  2149. }
  2150. }
  2151. }
  2152. },
  2153. "500": {
  2154. "description": "Error",
  2155. "content": {
  2156. "application/json": {
  2157. "schema": {
  2158. "$ref": "#/components/schemas/error-message"
  2159. }
  2160. }
  2161. }
  2162. }
  2163. },
  2164. "security": [
  2165. {
  2166. "api_key": []
  2167. }
  2168. ]
  2169. }
  2170. },
  2171. "/api/v2/test/deluge": {
  2172. "post": {
  2173. "tags": [
  2174. "test connection"
  2175. ],
  2176. "summary": "Test connection to Deluge",
  2177. "responses": {
  2178. "200": {
  2179. "description": "Success",
  2180. "content": {
  2181. "application/json": {
  2182. "schema": {
  2183. "$ref": "#/components/schemas/success-message"
  2184. }
  2185. }
  2186. }
  2187. },
  2188. "401": {
  2189. "description": "Unauthorized",
  2190. "content": {
  2191. "application/json": {
  2192. "schema": {
  2193. "$ref": "#/components/schemas/unauthorized-message"
  2194. }
  2195. }
  2196. }
  2197. },
  2198. "422": {
  2199. "description": "Error",
  2200. "content": {
  2201. "application/json": {
  2202. "schema": {
  2203. "$ref": "#/components/schemas/error-message"
  2204. }
  2205. }
  2206. }
  2207. },
  2208. "500": {
  2209. "description": "Error",
  2210. "content": {
  2211. "application/json": {
  2212. "schema": {
  2213. "$ref": "#/components/schemas/error-message"
  2214. }
  2215. }
  2216. }
  2217. }
  2218. },
  2219. "security": [
  2220. {
  2221. "api_key": []
  2222. }
  2223. ]
  2224. }
  2225. },
  2226. "/api/v2/test/jdownloader": {
  2227. "post": {
  2228. "tags": [
  2229. "test connection"
  2230. ],
  2231. "summary": "Test connection to jDownloader",
  2232. "responses": {
  2233. "200": {
  2234. "description": "Success",
  2235. "content": {
  2236. "application/json": {
  2237. "schema": {
  2238. "$ref": "#/components/schemas/success-message"
  2239. }
  2240. }
  2241. }
  2242. },
  2243. "401": {
  2244. "description": "Unauthorized",
  2245. "content": {
  2246. "application/json": {
  2247. "schema": {
  2248. "$ref": "#/components/schemas/unauthorized-message"
  2249. }
  2250. }
  2251. }
  2252. },
  2253. "422": {
  2254. "description": "Error",
  2255. "content": {
  2256. "application/json": {
  2257. "schema": {
  2258. "$ref": "#/components/schemas/error-message"
  2259. }
  2260. }
  2261. }
  2262. },
  2263. "500": {
  2264. "description": "Error",
  2265. "content": {
  2266. "application/json": {
  2267. "schema": {
  2268. "$ref": "#/components/schemas/error-message"
  2269. }
  2270. }
  2271. }
  2272. }
  2273. },
  2274. "security": [
  2275. {
  2276. "api_key": []
  2277. }
  2278. ]
  2279. }
  2280. },
  2281. "/api/v2/test/transmission": {
  2282. "post": {
  2283. "tags": [
  2284. "test connection"
  2285. ],
  2286. "summary": "Test connection to Transmission",
  2287. "responses": {
  2288. "200": {
  2289. "description": "Success",
  2290. "content": {
  2291. "application/json": {
  2292. "schema": {
  2293. "$ref": "#/components/schemas/success-message"
  2294. }
  2295. }
  2296. }
  2297. },
  2298. "401": {
  2299. "description": "Unauthorized",
  2300. "content": {
  2301. "application/json": {
  2302. "schema": {
  2303. "$ref": "#/components/schemas/unauthorized-message"
  2304. }
  2305. }
  2306. }
  2307. },
  2308. "422": {
  2309. "description": "Error",
  2310. "content": {
  2311. "application/json": {
  2312. "schema": {
  2313. "$ref": "#/components/schemas/error-message"
  2314. }
  2315. }
  2316. }
  2317. },
  2318. "500": {
  2319. "description": "Error",
  2320. "content": {
  2321. "application/json": {
  2322. "schema": {
  2323. "$ref": "#/components/schemas/error-message"
  2324. }
  2325. }
  2326. }
  2327. }
  2328. },
  2329. "security": [
  2330. {
  2331. "api_key": []
  2332. }
  2333. ]
  2334. }
  2335. },
  2336. "/api/v2/test/qbittorrent": {
  2337. "post": {
  2338. "tags": [
  2339. "test connection"
  2340. ],
  2341. "summary": "Test connection to qBittorrent",
  2342. "responses": {
  2343. "200": {
  2344. "description": "Success",
  2345. "content": {
  2346. "application/json": {
  2347. "schema": {
  2348. "$ref": "#/components/schemas/success-message"
  2349. }
  2350. }
  2351. }
  2352. },
  2353. "401": {
  2354. "description": "Unauthorized",
  2355. "content": {
  2356. "application/json": {
  2357. "schema": {
  2358. "$ref": "#/components/schemas/unauthorized-message"
  2359. }
  2360. }
  2361. }
  2362. },
  2363. "422": {
  2364. "description": "Error",
  2365. "content": {
  2366. "application/json": {
  2367. "schema": {
  2368. "$ref": "#/components/schemas/error-message"
  2369. }
  2370. }
  2371. }
  2372. },
  2373. "500": {
  2374. "description": "Error",
  2375. "content": {
  2376. "application/json": {
  2377. "schema": {
  2378. "$ref": "#/components/schemas/error-message"
  2379. }
  2380. }
  2381. }
  2382. }
  2383. },
  2384. "security": [
  2385. {
  2386. "api_key": []
  2387. }
  2388. ]
  2389. }
  2390. },
  2391. "/api/v2/test/unifi": {
  2392. "post": {
  2393. "tags": [
  2394. "test connection"
  2395. ],
  2396. "summary": "Test connection to Unifi",
  2397. "responses": {
  2398. "200": {
  2399. "description": "Success",
  2400. "content": {
  2401. "application/json": {
  2402. "schema": {
  2403. "$ref": "#/components/schemas/success-message"
  2404. }
  2405. }
  2406. }
  2407. },
  2408. "401": {
  2409. "description": "Unauthorized",
  2410. "content": {
  2411. "application/json": {
  2412. "schema": {
  2413. "$ref": "#/components/schemas/unauthorized-message"
  2414. }
  2415. }
  2416. }
  2417. },
  2418. "422": {
  2419. "description": "Error",
  2420. "content": {
  2421. "application/json": {
  2422. "schema": {
  2423. "$ref": "#/components/schemas/error-message"
  2424. }
  2425. }
  2426. }
  2427. },
  2428. "500": {
  2429. "description": "Error",
  2430. "content": {
  2431. "application/json": {
  2432. "schema": {
  2433. "$ref": "#/components/schemas/error-message"
  2434. }
  2435. }
  2436. }
  2437. }
  2438. },
  2439. "security": [
  2440. {
  2441. "api_key": []
  2442. }
  2443. ]
  2444. }
  2445. },
  2446. "/api/v2/test/unifi/site": {
  2447. "post": {
  2448. "tags": [
  2449. "test connection"
  2450. ],
  2451. "summary": "Test connection to Unifi Sites",
  2452. "responses": {
  2453. "200": {
  2454. "description": "Success",
  2455. "content": {
  2456. "application/json": {
  2457. "schema": {
  2458. "$ref": "#/components/schemas/success-message"
  2459. }
  2460. }
  2461. }
  2462. },
  2463. "401": {
  2464. "description": "Unauthorized",
  2465. "content": {
  2466. "application/json": {
  2467. "schema": {
  2468. "$ref": "#/components/schemas/unauthorized-message"
  2469. }
  2470. }
  2471. }
  2472. },
  2473. "422": {
  2474. "description": "Error",
  2475. "content": {
  2476. "application/json": {
  2477. "schema": {
  2478. "$ref": "#/components/schemas/error-message"
  2479. }
  2480. }
  2481. }
  2482. },
  2483. "500": {
  2484. "description": "Error",
  2485. "content": {
  2486. "application/json": {
  2487. "schema": {
  2488. "$ref": "#/components/schemas/error-message"
  2489. }
  2490. }
  2491. }
  2492. }
  2493. },
  2494. "security": [
  2495. {
  2496. "api_key": []
  2497. }
  2498. ]
  2499. }
  2500. },
  2501. "/api/v2/test/tautulli": {
  2502. "post": {
  2503. "tags": [
  2504. "test connection"
  2505. ],
  2506. "summary": "Test connection to Tautulli",
  2507. "responses": {
  2508. "200": {
  2509. "description": "Success",
  2510. "content": {
  2511. "application/json": {
  2512. "schema": {
  2513. "$ref": "#/components/schemas/success-message"
  2514. }
  2515. }
  2516. }
  2517. },
  2518. "401": {
  2519. "description": "Unauthorized",
  2520. "content": {
  2521. "application/json": {
  2522. "schema": {
  2523. "$ref": "#/components/schemas/unauthorized-message"
  2524. }
  2525. }
  2526. }
  2527. },
  2528. "422": {
  2529. "description": "Error",
  2530. "content": {
  2531. "application/json": {
  2532. "schema": {
  2533. "$ref": "#/components/schemas/error-message"
  2534. }
  2535. }
  2536. }
  2537. },
  2538. "500": {
  2539. "description": "Error",
  2540. "content": {
  2541. "application/json": {
  2542. "schema": {
  2543. "$ref": "#/components/schemas/error-message"
  2544. }
  2545. }
  2546. }
  2547. }
  2548. },
  2549. "security": [
  2550. {
  2551. "api_key": []
  2552. }
  2553. ]
  2554. }
  2555. },
  2556. "/api/v2/emby/register": {
  2557. "post": {
  2558. "tags": [
  2559. "emby"
  2560. ],
  2561. "summary": "Register a user using Emby API",
  2562. "responses": {
  2563. "200": {
  2564. "description": "Success",
  2565. "content": {
  2566. "application/json": {
  2567. "schema": {
  2568. "$ref": "#/components/schemas/status"
  2569. }
  2570. }
  2571. }
  2572. },
  2573. "401": {
  2574. "description": "Unauthorized"
  2575. }
  2576. }
  2577. }
  2578. },
  2579. "/api/v2/organizr/{page}": {
  2580. "get": {
  2581. "tags": [
  2582. "page"
  2583. ],
  2584. "summary": "Get HTML for Organizr Pages",
  2585. "parameters": [
  2586. {
  2587. "name": "page",
  2588. "in": "path",
  2589. "description": "Page to get",
  2590. "required": true,
  2591. "schema": {
  2592. "type": "string"
  2593. }
  2594. }
  2595. ],
  2596. "responses": {
  2597. "200": {
  2598. "description": "Success",
  2599. "content": {
  2600. "application/json": {
  2601. "schema": {
  2602. "$ref": "#/components/schemas/get-html"
  2603. }
  2604. }
  2605. }
  2606. },
  2607. "401": {
  2608. "description": "Unauthorized"
  2609. }
  2610. },
  2611. "security": [
  2612. {
  2613. "api_key": []
  2614. }
  2615. ]
  2616. }
  2617. },
  2618. "/api/v2/page/{page}": {
  2619. "get": {
  2620. "tags": [
  2621. "page"
  2622. ],
  2623. "summary": "Get HTML for Organizr Pages",
  2624. "parameters": [
  2625. {
  2626. "name": "page",
  2627. "in": "path",
  2628. "description": "Page to get",
  2629. "required": true,
  2630. "schema": {
  2631. "type": "string"
  2632. }
  2633. }
  2634. ],
  2635. "responses": {
  2636. "200": {
  2637. "description": "Success",
  2638. "content": {
  2639. "application/json": {
  2640. "schema": {
  2641. "$ref": "#/components/schemas/get-html"
  2642. }
  2643. }
  2644. }
  2645. },
  2646. "401": {
  2647. "description": "Unauthorized"
  2648. }
  2649. },
  2650. "security": [
  2651. {
  2652. "api_key": []
  2653. }
  2654. ]
  2655. }
  2656. },
  2657. "/api/v2/page": {
  2658. "get": {
  2659. "tags": [
  2660. "page"
  2661. ],
  2662. "summary": "Get list of all Organizr Pages",
  2663. "responses": {
  2664. "200": {
  2665. "description": "Success",
  2666. "content": {
  2667. "application/json": {
  2668. "schema": {
  2669. "$ref": "#/components/schemas/get-html"
  2670. }
  2671. }
  2672. }
  2673. },
  2674. "401": {
  2675. "description": "Unauthorized"
  2676. }
  2677. },
  2678. "security": [
  2679. {
  2680. "api_key": []
  2681. }
  2682. ]
  2683. }
  2684. },
  2685. "/api/v2/ping": {
  2686. "get": {
  2687. "summary": "Ping the Organizr API",
  2688. "responses": {
  2689. "200": {
  2690. "description": "Success",
  2691. "content": {
  2692. "application/json": {
  2693. "schema": {
  2694. "$ref": "#/components/schemas/ping"
  2695. }
  2696. }
  2697. }
  2698. },
  2699. "401": {
  2700. "description": "Unauthorized"
  2701. }
  2702. }
  2703. }
  2704. },
  2705. "/api/v2/plex/register": {
  2706. "post": {
  2707. "tags": [
  2708. "plex"
  2709. ],
  2710. "summary": "Register a user using Plex API",
  2711. "requestBody": {
  2712. "description": "Success",
  2713. "required": true,
  2714. "content": {
  2715. "application/json": {
  2716. "schema": {
  2717. "$ref": "#/components/schemas/plexRegister"
  2718. }
  2719. }
  2720. }
  2721. },
  2722. "responses": {
  2723. "200": {
  2724. "description": "Success",
  2725. "content": {
  2726. "application/json": {
  2727. "schema": {
  2728. "$ref": "#/components/schemas/status"
  2729. }
  2730. }
  2731. }
  2732. },
  2733. "401": {
  2734. "description": "Unauthorized"
  2735. }
  2736. }
  2737. }
  2738. },
  2739. "/api/v2/status": {
  2740. "get": {
  2741. "summary": "Query Organizr API to perform a Status Check",
  2742. "responses": {
  2743. "200": {
  2744. "description": "Success",
  2745. "content": {
  2746. "application/json": {
  2747. "schema": {
  2748. "$ref": "#/components/schemas/status"
  2749. }
  2750. }
  2751. }
  2752. },
  2753. "401": {
  2754. "description": "Unauthorized"
  2755. }
  2756. }
  2757. }
  2758. },
  2759. "/api/v2/auth": {
  2760. "get": {
  2761. "summary": "Nginx auth_request",
  2762. "parameters": [
  2763. {
  2764. "name": "group",
  2765. "in": "query",
  2766. "description": "The id of the group allowed",
  2767. "required": false,
  2768. "schema": {
  2769. "type": "integer",
  2770. "format": "int64"
  2771. }
  2772. },
  2773. {
  2774. "name": "whitelist",
  2775. "in": "query",
  2776. "description": "Whitelisted Ip's",
  2777. "required": false,
  2778. "explode": false,
  2779. "schema": {
  2780. "type": "array",
  2781. "items": {
  2782. "type": "string"
  2783. }
  2784. }
  2785. },
  2786. {
  2787. "name": "blacklist",
  2788. "in": "query",
  2789. "description": "Blacklisted Ip's",
  2790. "required": false,
  2791. "explode": false,
  2792. "schema": {
  2793. "type": "array",
  2794. "items": {
  2795. "type": "string"
  2796. }
  2797. }
  2798. }
  2799. ],
  2800. "responses": {
  2801. "200": {
  2802. "description": "Success"
  2803. },
  2804. "401": {
  2805. "description": "Unauthorized"
  2806. }
  2807. }
  2808. }
  2809. },
  2810. "/api/v2/update/download/{branch}": {
  2811. "get": {
  2812. "tags": [
  2813. "update"
  2814. ],
  2815. "summary": "Download Organizr Update Files",
  2816. "responses": {
  2817. "200": {
  2818. "description": "Success",
  2819. "content": {
  2820. "application/json": {
  2821. "schema": {
  2822. "$ref": "#/components/schemas/success-message"
  2823. }
  2824. }
  2825. }
  2826. },
  2827. "401": {
  2828. "description": "Unauthorized",
  2829. "content": {
  2830. "application/json": {
  2831. "schema": {
  2832. "$ref": "#/components/schemas/unauthorized-message"
  2833. }
  2834. }
  2835. }
  2836. },
  2837. "404": {
  2838. "description": "Error",
  2839. "content": {
  2840. "application/json": {
  2841. "schema": {
  2842. "$ref": "#/components/schemas/error-message"
  2843. }
  2844. }
  2845. }
  2846. },
  2847. "422": {
  2848. "description": "Error",
  2849. "content": {
  2850. "application/json": {
  2851. "schema": {
  2852. "$ref": "#/components/schemas/error-message"
  2853. }
  2854. }
  2855. }
  2856. },
  2857. "500": {
  2858. "description": "Error",
  2859. "content": {
  2860. "application/json": {
  2861. "schema": {
  2862. "$ref": "#/components/schemas/error-message"
  2863. }
  2864. }
  2865. }
  2866. }
  2867. },
  2868. "security": [
  2869. {
  2870. "api_key": []
  2871. }
  2872. ]
  2873. }
  2874. },
  2875. "/api/v2/update/unzip/{branch}": {
  2876. "get": {
  2877. "tags": [
  2878. "update"
  2879. ],
  2880. "summary": "Unzip Organizr Update Files",
  2881. "responses": {
  2882. "200": {
  2883. "description": "Success",
  2884. "content": {
  2885. "application/json": {
  2886. "schema": {
  2887. "$ref": "#/components/schemas/success-message"
  2888. }
  2889. }
  2890. }
  2891. },
  2892. "401": {
  2893. "description": "Unauthorized",
  2894. "content": {
  2895. "application/json": {
  2896. "schema": {
  2897. "$ref": "#/components/schemas/unauthorized-message"
  2898. }
  2899. }
  2900. }
  2901. },
  2902. "404": {
  2903. "description": "Error",
  2904. "content": {
  2905. "application/json": {
  2906. "schema": {
  2907. "$ref": "#/components/schemas/error-message"
  2908. }
  2909. }
  2910. }
  2911. },
  2912. "422": {
  2913. "description": "Error",
  2914. "content": {
  2915. "application/json": {
  2916. "schema": {
  2917. "$ref": "#/components/schemas/error-message"
  2918. }
  2919. }
  2920. }
  2921. },
  2922. "500": {
  2923. "description": "Error",
  2924. "content": {
  2925. "application/json": {
  2926. "schema": {
  2927. "$ref": "#/components/schemas/error-message"
  2928. }
  2929. }
  2930. }
  2931. }
  2932. },
  2933. "security": [
  2934. {
  2935. "api_key": []
  2936. }
  2937. ]
  2938. }
  2939. },
  2940. "/api/v2/update/move/{branch}": {
  2941. "get": {
  2942. "tags": [
  2943. "update"
  2944. ],
  2945. "summary": "Move Organizr Update Files",
  2946. "responses": {
  2947. "200": {
  2948. "description": "Success",
  2949. "content": {
  2950. "application/json": {
  2951. "schema": {
  2952. "$ref": "#/components/schemas/success-message"
  2953. }
  2954. }
  2955. }
  2956. },
  2957. "401": {
  2958. "description": "Unauthorized",
  2959. "content": {
  2960. "application/json": {
  2961. "schema": {
  2962. "$ref": "#/components/schemas/unauthorized-message"
  2963. }
  2964. }
  2965. }
  2966. },
  2967. "404": {
  2968. "description": "Error",
  2969. "content": {
  2970. "application/json": {
  2971. "schema": {
  2972. "$ref": "#/components/schemas/error-message"
  2973. }
  2974. }
  2975. }
  2976. },
  2977. "422": {
  2978. "description": "Error",
  2979. "content": {
  2980. "application/json": {
  2981. "schema": {
  2982. "$ref": "#/components/schemas/error-message"
  2983. }
  2984. }
  2985. }
  2986. },
  2987. "500": {
  2988. "description": "Error",
  2989. "content": {
  2990. "application/json": {
  2991. "schema": {
  2992. "$ref": "#/components/schemas/error-message"
  2993. }
  2994. }
  2995. }
  2996. }
  2997. },
  2998. "security": [
  2999. {
  3000. "api_key": []
  3001. }
  3002. ]
  3003. }
  3004. },
  3005. "/api/v2/update/cleanup/{branch}": {
  3006. "get": {
  3007. "tags": [
  3008. "update"
  3009. ],
  3010. "summary": "Cleanup Organizr Update Files",
  3011. "responses": {
  3012. "200": {
  3013. "description": "Success",
  3014. "content": {
  3015. "application/json": {
  3016. "schema": {
  3017. "$ref": "#/components/schemas/success-message"
  3018. }
  3019. }
  3020. }
  3021. },
  3022. "401": {
  3023. "description": "Unauthorized",
  3024. "content": {
  3025. "application/json": {
  3026. "schema": {
  3027. "$ref": "#/components/schemas/unauthorized-message"
  3028. }
  3029. }
  3030. }
  3031. },
  3032. "404": {
  3033. "description": "Error",
  3034. "content": {
  3035. "application/json": {
  3036. "schema": {
  3037. "$ref": "#/components/schemas/error-message"
  3038. }
  3039. }
  3040. }
  3041. },
  3042. "422": {
  3043. "description": "Error",
  3044. "content": {
  3045. "application/json": {
  3046. "schema": {
  3047. "$ref": "#/components/schemas/error-message"
  3048. }
  3049. }
  3050. }
  3051. },
  3052. "500": {
  3053. "description": "Error",
  3054. "content": {
  3055. "application/json": {
  3056. "schema": {
  3057. "$ref": "#/components/schemas/error-message"
  3058. }
  3059. }
  3060. }
  3061. }
  3062. },
  3063. "security": [
  3064. {
  3065. "api_key": []
  3066. }
  3067. ]
  3068. }
  3069. },
  3070. "/api/v2/update/docker": {
  3071. "get": {
  3072. "tags": [
  3073. "update"
  3074. ],
  3075. "summary": "Update Organizr install using Docker Container script",
  3076. "responses": {
  3077. "200": {
  3078. "description": "Success",
  3079. "content": {
  3080. "application/json": {
  3081. "schema": {
  3082. "$ref": "#/components/schemas/success-message"
  3083. }
  3084. }
  3085. }
  3086. },
  3087. "401": {
  3088. "description": "Unauthorized",
  3089. "content": {
  3090. "application/json": {
  3091. "schema": {
  3092. "$ref": "#/components/schemas/unauthorized-message"
  3093. }
  3094. }
  3095. }
  3096. },
  3097. "404": {
  3098. "description": "Error",
  3099. "content": {
  3100. "application/json": {
  3101. "schema": {
  3102. "$ref": "#/components/schemas/error-message"
  3103. }
  3104. }
  3105. }
  3106. },
  3107. "422": {
  3108. "description": "Error",
  3109. "content": {
  3110. "application/json": {
  3111. "schema": {
  3112. "$ref": "#/components/schemas/error-message"
  3113. }
  3114. }
  3115. }
  3116. },
  3117. "500": {
  3118. "description": "Error",
  3119. "content": {
  3120. "application/json": {
  3121. "schema": {
  3122. "$ref": "#/components/schemas/error-message"
  3123. }
  3124. }
  3125. }
  3126. }
  3127. },
  3128. "security": [
  3129. {
  3130. "api_key": []
  3131. }
  3132. ]
  3133. }
  3134. },
  3135. "/api/v2/update/windows": {
  3136. "get": {
  3137. "tags": [
  3138. "update"
  3139. ],
  3140. "summary": "Update Organizr install using Windows script",
  3141. "responses": {
  3142. "200": {
  3143. "description": "Success",
  3144. "content": {
  3145. "application/json": {
  3146. "schema": {
  3147. "$ref": "#/components/schemas/success-message"
  3148. }
  3149. }
  3150. }
  3151. },
  3152. "401": {
  3153. "description": "Unauthorized",
  3154. "content": {
  3155. "application/json": {
  3156. "schema": {
  3157. "$ref": "#/components/schemas/unauthorized-message"
  3158. }
  3159. }
  3160. }
  3161. },
  3162. "404": {
  3163. "description": "Error",
  3164. "content": {
  3165. "application/json": {
  3166. "schema": {
  3167. "$ref": "#/components/schemas/error-message"
  3168. }
  3169. }
  3170. }
  3171. },
  3172. "422": {
  3173. "description": "Error",
  3174. "content": {
  3175. "application/json": {
  3176. "schema": {
  3177. "$ref": "#/components/schemas/error-message"
  3178. }
  3179. }
  3180. }
  3181. },
  3182. "500": {
  3183. "description": "Error",
  3184. "content": {
  3185. "application/json": {
  3186. "schema": {
  3187. "$ref": "#/components/schemas/error-message"
  3188. }
  3189. }
  3190. }
  3191. }
  3192. },
  3193. "security": [
  3194. {
  3195. "api_key": []
  3196. }
  3197. ]
  3198. }
  3199. },
  3200. "/api/v2/update/migrate/{version}": {
  3201. "get": {
  3202. "tags": [
  3203. "update"
  3204. ],
  3205. "summary": "Run Organizr Version Mirgation for specific version",
  3206. "responses": {
  3207. "200": {
  3208. "description": "Success",
  3209. "content": {
  3210. "application/json": {
  3211. "schema": {
  3212. "$ref": "#/components/schemas/success-message"
  3213. }
  3214. }
  3215. }
  3216. },
  3217. "401": {
  3218. "description": "Unauthorized",
  3219. "content": {
  3220. "application/json": {
  3221. "schema": {
  3222. "$ref": "#/components/schemas/unauthorized-message"
  3223. }
  3224. }
  3225. }
  3226. },
  3227. "404": {
  3228. "description": "Error",
  3229. "content": {
  3230. "application/json": {
  3231. "schema": {
  3232. "$ref": "#/components/schemas/error-message"
  3233. }
  3234. }
  3235. }
  3236. },
  3237. "422": {
  3238. "description": "Error",
  3239. "content": {
  3240. "application/json": {
  3241. "schema": {
  3242. "$ref": "#/components/schemas/error-message"
  3243. }
  3244. }
  3245. }
  3246. },
  3247. "500": {
  3248. "description": "Error",
  3249. "content": {
  3250. "application/json": {
  3251. "schema": {
  3252. "$ref": "#/components/schemas/error-message"
  3253. }
  3254. }
  3255. }
  3256. }
  3257. },
  3258. "security": [
  3259. {
  3260. "api_key": []
  3261. }
  3262. ]
  3263. }
  3264. }
  3265. },
  3266. "components": {
  3267. "schemas": {
  3268. "getChatMessages": {
  3269. "properties": {
  3270. "response": {
  3271. "properties": {
  3272. "result": {
  3273. "description": "success or error",
  3274. "type": "string",
  3275. "example": "success"
  3276. },
  3277. "message": {
  3278. "description": "success or error message",
  3279. "type": "string",
  3280. "example": null
  3281. },
  3282. "data": {
  3283. "description": "data from api",
  3284. "type": "array",
  3285. "items": {
  3286. "properties": {
  3287. "username": {
  3288. "type": "string",
  3289. "example": "causefx"
  3290. },
  3291. "date": {
  3292. "type": "string",
  3293. "example": "2018-09-01 02:02:24"
  3294. },
  3295. "gravatar": {
  3296. "type": "string",
  3297. "example": "https://www.gravatar.com/avatar/a47c4a4b915ddf9601cd228f890bc366?s=100&d=mm"
  3298. },
  3299. "message": {
  3300. "type": "string",
  3301. "example": "ok first message!"
  3302. },
  3303. "uid": {
  3304. "type": "string",
  3305. "example": "f5287"
  3306. }
  3307. },
  3308. "type": "object"
  3309. }
  3310. }
  3311. },
  3312. "type": "object"
  3313. }
  3314. },
  3315. "type": "object"
  3316. },
  3317. "submitMessageData": {
  3318. "properties": {
  3319. "message": {
  3320. "type": "string",
  3321. "example": "This is my message"
  3322. }
  3323. },
  3324. "type": "object"
  3325. },
  3326. "submitMessage": {
  3327. "properties": {
  3328. "response": {
  3329. "properties": {
  3330. "result": {
  3331. "description": "success or error",
  3332. "type": "string",
  3333. "example": "success"
  3334. },
  3335. "message": {
  3336. "description": "success or error message",
  3337. "type": "string",
  3338. "example": "message has been accepted"
  3339. },
  3340. "data": {
  3341. "description": "data from api",
  3342. "type": "string",
  3343. "example": null
  3344. }
  3345. },
  3346. "type": "object"
  3347. }
  3348. },
  3349. "type": "object"
  3350. },
  3351. "healthChecksRun": {
  3352. "properties": {
  3353. "response": {
  3354. "properties": {
  3355. "result": {
  3356. "description": "success or error",
  3357. "type": "string",
  3358. "example": "success"
  3359. },
  3360. "message": {
  3361. "description": "success or error message",
  3362. "type": "string",
  3363. "example": null
  3364. },
  3365. "data": {
  3366. "description": "data from api",
  3367. "type": "array",
  3368. "items": {
  3369. "properties": {
  3370. "Service Name": {
  3371. "type": "string",
  3372. "example": "Radarr"
  3373. },
  3374. "UUID": {
  3375. "type": "string",
  3376. "example": "883f0097-8f4c-4ca5-a9cf-053cfab8e334"
  3377. },
  3378. "External URL": {
  3379. "type": "string",
  3380. "example": "https://radarr.com"
  3381. },
  3382. "Internal URL": {
  3383. "type": "string",
  3384. "example": "http://radarr:7878"
  3385. },
  3386. "Enabled": {
  3387. "type": "string",
  3388. "example": "true"
  3389. },
  3390. "results": {
  3391. "type": "array",
  3392. "items": {
  3393. "properties": {
  3394. "internal": {
  3395. "type": "string",
  3396. "example": "Success"
  3397. },
  3398. "external": {
  3399. "type": "string",
  3400. "example": "Success"
  3401. }
  3402. },
  3403. "type": "object"
  3404. }
  3405. }
  3406. },
  3407. "type": "object"
  3408. }
  3409. }
  3410. },
  3411. "type": "object"
  3412. }
  3413. },
  3414. "type": "object"
  3415. },
  3416. "getInvites": {
  3417. "properties": {
  3418. "response": {
  3419. "properties": {
  3420. "result": {
  3421. "description": "success or error",
  3422. "type": "string",
  3423. "example": "success"
  3424. },
  3425. "message": {
  3426. "description": "success or error message",
  3427. "type": "string",
  3428. "example": null
  3429. },
  3430. "data": {
  3431. "description": "data from api",
  3432. "type": "array",
  3433. "items": {
  3434. "properties": {
  3435. "id": {
  3436. "type": "number",
  3437. "example": 1
  3438. },
  3439. "code": {
  3440. "type": "string",
  3441. "example": "NN9JH9"
  3442. },
  3443. "date": {
  3444. "type": "string",
  3445. "example": "2018-09-01 02:02:24"
  3446. },
  3447. "email": {
  3448. "type": "string",
  3449. "example": "causefX@organizr.app"
  3450. },
  3451. "username": {
  3452. "type": "string",
  3453. "example": "causefx"
  3454. },
  3455. "dateused": {
  3456. "type": "string",
  3457. "example": "2018-09-01 02:02:24"
  3458. },
  3459. "usedby": {
  3460. "type": "string",
  3461. "example": "causefx"
  3462. },
  3463. "ip": {
  3464. "type": "string",
  3465. "example": "10.0.0.0"
  3466. },
  3467. "valid": {
  3468. "type": "string",
  3469. "example": "No"
  3470. },
  3471. "type": {
  3472. "type": "string",
  3473. "example": "Plex"
  3474. }
  3475. },
  3476. "type": "object"
  3477. }
  3478. }
  3479. },
  3480. "type": "object"
  3481. }
  3482. },
  3483. "type": "object"
  3484. },
  3485. "createInviteCode": {
  3486. "properties": {
  3487. "response": {
  3488. "properties": {
  3489. "result": {
  3490. "description": "success or error",
  3491. "type": "string",
  3492. "example": "success"
  3493. },
  3494. "message": {
  3495. "description": "success or error message",
  3496. "type": "string",
  3497. "example": "Invite Code: XYXYXY has been created"
  3498. },
  3499. "data": {
  3500. "description": "data from api",
  3501. "type": "string",
  3502. "example": null
  3503. }
  3504. },
  3505. "type": "object"
  3506. }
  3507. },
  3508. "type": "object"
  3509. },
  3510. "verifyInviteCode": {
  3511. "properties": {
  3512. "response": {
  3513. "properties": {
  3514. "result": {
  3515. "description": "success or error",
  3516. "type": "string",
  3517. "example": "success"
  3518. },
  3519. "message": {
  3520. "description": "success or error message",
  3521. "type": "string",
  3522. "example": "Code has been verified"
  3523. },
  3524. "data": {
  3525. "description": "data from api",
  3526. "type": "string",
  3527. "example": null
  3528. }
  3529. },
  3530. "type": "object"
  3531. }
  3532. },
  3533. "type": "object"
  3534. },
  3535. "useInviteCode": {
  3536. "properties": {
  3537. "response": {
  3538. "properties": {
  3539. "result": {
  3540. "description": "success or error",
  3541. "type": "string",
  3542. "example": "success"
  3543. },
  3544. "message": {
  3545. "description": "success or error message",
  3546. "type": "string",
  3547. "example": "Plex/Emby User now has access to system"
  3548. },
  3549. "data": {
  3550. "description": "data from api",
  3551. "type": "string",
  3552. "example": null
  3553. }
  3554. },
  3555. "type": "object"
  3556. }
  3557. },
  3558. "type": "object"
  3559. },
  3560. "deleteInviteCode": {
  3561. "properties": {
  3562. "response": {
  3563. "properties": {
  3564. "result": {
  3565. "description": "success or error",
  3566. "type": "string",
  3567. "example": "success"
  3568. },
  3569. "message": {
  3570. "description": "success or error message",
  3571. "type": "string",
  3572. "example": "Code has been deleted"
  3573. },
  3574. "data": {
  3575. "description": "data from api",
  3576. "type": "string",
  3577. "example": null
  3578. }
  3579. },
  3580. "type": "object"
  3581. }
  3582. },
  3583. "type": "object"
  3584. },
  3585. "sendEmailData": {
  3586. "properties": {
  3587. "bcc": {
  3588. "description": "email of recipients (csv)",
  3589. "type": "string",
  3590. "example": "causefx@organizr.app,elmer@organizr.app"
  3591. },
  3592. "subject": {
  3593. "type": "string",
  3594. "example": "Hey There Buddy?!"
  3595. },
  3596. "body": {
  3597. "type": "string",
  3598. "example": "Hi! Boy, has it been a long time! Have you seen rox in socks?"
  3599. }
  3600. },
  3601. "type": "object"
  3602. },
  3603. "submit-2fa-verify": {
  3604. "properties": {
  3605. "secret": {
  3606. "type": "string",
  3607. "example": "OX1R4GA3425GSDF"
  3608. },
  3609. "code": {
  3610. "type": "string",
  3611. "example": "145047"
  3612. },
  3613. "type": {
  3614. "type": "string",
  3615. "example": "google"
  3616. }
  3617. },
  3618. "type": "object"
  3619. },
  3620. "submit-2fa-save": {
  3621. "properties": {
  3622. "secret": {
  3623. "type": "string",
  3624. "example": "OX1R4GA3425GSDF"
  3625. },
  3626. "type": {
  3627. "type": "string",
  3628. "example": "google"
  3629. }
  3630. },
  3631. "type": "object"
  3632. },
  3633. "submit-2fa-create": {
  3634. "properties": {
  3635. "type": {
  3636. "type": "string",
  3637. "example": "google"
  3638. }
  3639. },
  3640. "type": "object"
  3641. },
  3642. "get-html": {
  3643. "properties": {
  3644. "response": {
  3645. "properties": {
  3646. "result": {
  3647. "description": "success or error",
  3648. "type": "string",
  3649. "example": "success"
  3650. },
  3651. "message": {
  3652. "description": "success message or error message",
  3653. "type": "string",
  3654. "example": null
  3655. },
  3656. "data": {
  3657. "description": "data from api",
  3658. "type": "string",
  3659. "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"
  3660. }
  3661. },
  3662. "type": "object"
  3663. }
  3664. },
  3665. "type": "object"
  3666. },
  3667. "plexRegister": {
  3668. "properties": {
  3669. "username": {
  3670. "type": "string",
  3671. "example": "causefx"
  3672. },
  3673. "email": {
  3674. "type": "string",
  3675. "example": "causefx@organizr.app"
  3676. },
  3677. "password": {
  3678. "type": "string",
  3679. "example": "iCanHazPa$$w0Rd"
  3680. }
  3681. },
  3682. "type": "object"
  3683. },
  3684. "ping": {
  3685. "properties": {
  3686. "response": {
  3687. "properties": {
  3688. "result": {
  3689. "description": "success or error",
  3690. "type": "string",
  3691. "example": "success"
  3692. },
  3693. "message": {
  3694. "description": "success or error message",
  3695. "type": "string",
  3696. "example": null
  3697. },
  3698. "data": {
  3699. "description": "data from api",
  3700. "type": "string",
  3701. "example": "pong"
  3702. }
  3703. },
  3704. "type": "object"
  3705. }
  3706. },
  3707. "type": "object"
  3708. },
  3709. "status": {
  3710. "properties": {
  3711. "response": {
  3712. "properties": {
  3713. "result": {
  3714. "description": "success or error",
  3715. "type": "string",
  3716. "example": "success"
  3717. },
  3718. "message": {
  3719. "description": "success or error message",
  3720. "type": "string",
  3721. "example": null
  3722. },
  3723. "data": {
  3724. "description": "data from api",
  3725. "properties": {
  3726. "status": {
  3727. "description": "success or error",
  3728. "type": "string",
  3729. "example": "ok"
  3730. },
  3731. "api_version": {
  3732. "type": "string",
  3733. "example": "2.0"
  3734. },
  3735. "organizr_version": {
  3736. "type": "string",
  3737. "example": "2.0.650"
  3738. }
  3739. },
  3740. "type": "object"
  3741. }
  3742. },
  3743. "type": "object"
  3744. }
  3745. },
  3746. "type": "object"
  3747. },
  3748. "pluginSettingsPage": {
  3749. "properties": {
  3750. "response": {
  3751. "properties": {
  3752. "result": {
  3753. "description": "success or error",
  3754. "type": "string",
  3755. "example": "success"
  3756. },
  3757. "message": {
  3758. "description": "success or error message",
  3759. "type": "string",
  3760. "example": null
  3761. },
  3762. "data": {
  3763. "description": "data from api",
  3764. "properties": {
  3765. "settingsPageObjectItem1": {
  3766. "type": "object"
  3767. },
  3768. "settingsPageObjectItem2": {
  3769. "type": "object"
  3770. },
  3771. "settingsPageObjectItem3": {
  3772. "type": "object"
  3773. }
  3774. },
  3775. "type": "object"
  3776. }
  3777. },
  3778. "type": "object"
  3779. }
  3780. },
  3781. "type": "object"
  3782. },
  3783. "successNullData": {
  3784. "properties": {
  3785. "response": {
  3786. "properties": {
  3787. "result": {
  3788. "description": "success or error",
  3789. "type": "string",
  3790. "example": "success"
  3791. },
  3792. "message": {
  3793. "description": "success message or error message",
  3794. "type": "string",
  3795. "example": null
  3796. },
  3797. "data": {
  3798. "description": "data from api",
  3799. "type": "string",
  3800. "example": null
  3801. }
  3802. },
  3803. "type": "object"
  3804. }
  3805. },
  3806. "type": "object"
  3807. },
  3808. "success-message": {
  3809. "properties": {
  3810. "response": {
  3811. "properties": {
  3812. "result": {
  3813. "description": "success or error",
  3814. "type": "string",
  3815. "example": "success"
  3816. },
  3817. "message": {
  3818. "description": "success message or error message",
  3819. "type": "string",
  3820. "example": "Successful message here"
  3821. },
  3822. "data": {
  3823. "description": "data from api",
  3824. "type": "string",
  3825. "example": null
  3826. }
  3827. },
  3828. "type": "object"
  3829. }
  3830. },
  3831. "type": "object"
  3832. },
  3833. "error-message": {
  3834. "properties": {
  3835. "response": {
  3836. "properties": {
  3837. "result": {
  3838. "description": "success or error",
  3839. "type": "string",
  3840. "example": "error"
  3841. },
  3842. "message": {
  3843. "description": "success message or error message",
  3844. "type": "string",
  3845. "example": "Error message here"
  3846. },
  3847. "data": {
  3848. "description": "data from api",
  3849. "type": "string",
  3850. "example": null
  3851. }
  3852. },
  3853. "type": "object"
  3854. }
  3855. },
  3856. "type": "object"
  3857. },
  3858. "unauthorized-message": {
  3859. "properties": {
  3860. "response": {
  3861. "properties": {
  3862. "result": {
  3863. "description": "success or error",
  3864. "type": "string",
  3865. "example": "error"
  3866. },
  3867. "message": {
  3868. "description": "success message or error message",
  3869. "type": "string",
  3870. "example": "User is not authorized"
  3871. },
  3872. "data": {
  3873. "description": "data from api",
  3874. "type": "string",
  3875. "example": null
  3876. }
  3877. },
  3878. "type": "object"
  3879. }
  3880. },
  3881. "type": "object"
  3882. },
  3883. "php-mailer-email-list": {
  3884. "properties": {
  3885. "response": {
  3886. "properties": {
  3887. "result": {
  3888. "description": "success or error",
  3889. "type": "string",
  3890. "example": "success"
  3891. },
  3892. "message": {
  3893. "description": "success or error message",
  3894. "type": "string",
  3895. "example": null
  3896. },
  3897. "data": {
  3898. "description": "data from api",
  3899. "type": "array",
  3900. "items": {
  3901. "properties": {
  3902. "causefx": {
  3903. "type": "string",
  3904. "example": "causefx@organizr.app"
  3905. }
  3906. },
  3907. "type": "object"
  3908. }
  3909. }
  3910. },
  3911. "type": "object"
  3912. }
  3913. },
  3914. "type": "object"
  3915. },
  3916. "config-items-example": {
  3917. "description": "list of config items to update",
  3918. "properties": {
  3919. "branch": {
  3920. "description": "config item name",
  3921. "type": "string",
  3922. "example": "v2-master"
  3923. },
  3924. "hideRegistration": {
  3925. "type": "boolean",
  3926. "example": false
  3927. },
  3928. "homepageUnifiAuth": {
  3929. "type": "string",
  3930. "example": "1"
  3931. }
  3932. },
  3933. "type": "object"
  3934. }
  3935. },
  3936. "securitySchemes": {
  3937. "api_key": {
  3938. "type": "apiKey",
  3939. "name": "Token",
  3940. "in": "header"
  3941. }
  3942. }
  3943. },
  3944. "tags": [
  3945. {
  3946. "name": "plugins-chat",
  3947. "description": "Pusher Chat Plugin"
  3948. },
  3949. {
  3950. "name": "plugins-healthchecks",
  3951. "description": "Healthchecks.io Ping Plugin"
  3952. },
  3953. {
  3954. "name": "plugins-invites",
  3955. "description": "Media Invite Plugin"
  3956. },
  3957. {
  3958. "name": "plugins-php-mailer",
  3959. "description": "PHP Mailer Plugin"
  3960. },
  3961. {
  3962. "name": "plugins-speedtest",
  3963. "description": "SpeedTest Plugin"
  3964. },
  3965. {
  3966. "name": "2fa",
  3967. "description": "Two Form Authentication"
  3968. },
  3969. {
  3970. "name": "categories",
  3971. "description": "Category Information"
  3972. },
  3973. {
  3974. "name": "config",
  3975. "description": "Organizr Configuration Items"
  3976. },
  3977. {
  3978. "name": "test connection",
  3979. "description": "Test Connections"
  3980. },
  3981. {
  3982. "name": "emby"
  3983. },
  3984. {
  3985. "name": "page",
  3986. "description": "HTML for Organizr Pages"
  3987. },
  3988. {
  3989. "name": "plex"
  3990. },
  3991. {
  3992. "name": "plugins"
  3993. },
  3994. {
  3995. "name": "update",
  3996. "description": "Organizr Update"
  3997. }
  3998. ]
  3999. }