schemas.ts 96 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311
  1. // Code generated by tools/openapigen. DO NOT EDIT.
  2. export const SCHEMAS: Record<string, unknown> = {
  3. "AllSetting": {
  4. "properties": {
  5. "datepicker": {
  6. "type": "string"
  7. },
  8. "discordAdminIds": {
  9. "type": "string"
  10. },
  11. "discordBotBackup": {
  12. "type": "boolean"
  13. },
  14. "discordBotEnable": {
  15. "type": "boolean"
  16. },
  17. "discordBotToken": {
  18. "type": "string"
  19. },
  20. "discordChannelId": {
  21. "type": "string"
  22. },
  23. "discordCpu": {
  24. "maximum": 100,
  25. "minimum": 0,
  26. "type": "integer"
  27. },
  28. "discordEnabledEvents": {
  29. "type": "string"
  30. },
  31. "discordLang": {
  32. "type": "string"
  33. },
  34. "discordMemory": {
  35. "maximum": 100,
  36. "minimum": 0,
  37. "type": "integer"
  38. },
  39. "discordRunTime": {
  40. "type": "string"
  41. },
  42. "expireDiff": {
  43. "minimum": 0,
  44. "type": "integer"
  45. },
  46. "externalTrafficInformEnable": {
  47. "type": "boolean"
  48. },
  49. "externalTrafficInformURI": {
  50. "type": "string"
  51. },
  52. "happLinkEnable": {
  53. "type": "boolean"
  54. },
  55. "ipLimitAllowlist": {
  56. "type": "string"
  57. },
  58. "ldapAutoCreate": {
  59. "type": "boolean"
  60. },
  61. "ldapAutoDelete": {
  62. "type": "boolean"
  63. },
  64. "ldapBaseDN": {
  65. "type": "string"
  66. },
  67. "ldapBindDN": {
  68. "type": "string"
  69. },
  70. "ldapDefaultExpiryDays": {
  71. "minimum": 0,
  72. "type": "integer"
  73. },
  74. "ldapDefaultLimitIP": {
  75. "minimum": 0,
  76. "type": "integer"
  77. },
  78. "ldapDefaultTotalGB": {
  79. "minimum": 0,
  80. "type": "integer"
  81. },
  82. "ldapEnable": {
  83. "type": "boolean"
  84. },
  85. "ldapFlagField": {
  86. "type": "string"
  87. },
  88. "ldapHost": {
  89. "type": "string"
  90. },
  91. "ldapInboundTags": {
  92. "type": "string"
  93. },
  94. "ldapInsecureSkipVerify": {
  95. "type": "boolean"
  96. },
  97. "ldapInvertFlag": {
  98. "type": "boolean"
  99. },
  100. "ldapPassword": {
  101. "type": "string"
  102. },
  103. "ldapPort": {
  104. "maximum": 65535,
  105. "minimum": 0,
  106. "type": "integer"
  107. },
  108. "ldapSyncCron": {
  109. "type": "string"
  110. },
  111. "ldapTruthyValues": {
  112. "type": "string"
  113. },
  114. "ldapUseTLS": {
  115. "type": "boolean"
  116. },
  117. "ldapUserAttr": {
  118. "type": "string"
  119. },
  120. "ldapUserFilter": {
  121. "type": "string"
  122. },
  123. "ldapVlessField": {
  124. "type": "string"
  125. },
  126. "outboundDownThreshold": {
  127. "maximum": 100,
  128. "minimum": 1,
  129. "type": "integer"
  130. },
  131. "pageSize": {
  132. "maximum": 1000,
  133. "minimum": 0,
  134. "type": "integer"
  135. },
  136. "panelOutbound": {
  137. "type": "string"
  138. },
  139. "realityScanCandidates": {
  140. "type": "string"
  141. },
  142. "remarkTemplate": {
  143. "type": "string"
  144. },
  145. "restartXrayOnClientDisable": {
  146. "type": "boolean"
  147. },
  148. "sessionMaxAge": {
  149. "maximum": 525600,
  150. "minimum": 1,
  151. "type": "integer"
  152. },
  153. "smtpCpu": {
  154. "maximum": 100,
  155. "minimum": 0,
  156. "type": "integer"
  157. },
  158. "smtpEnable": {
  159. "type": "boolean"
  160. },
  161. "smtpEnabledEvents": {
  162. "type": "string"
  163. },
  164. "smtpEncryptionType": {
  165. "type": "string"
  166. },
  167. "smtpFrom": {
  168. "type": "string"
  169. },
  170. "smtpFromName": {
  171. "type": "string"
  172. },
  173. "smtpHost": {
  174. "type": "string"
  175. },
  176. "smtpMemory": {
  177. "maximum": 100,
  178. "minimum": 0,
  179. "type": "integer"
  180. },
  181. "smtpPassword": {
  182. "type": "string"
  183. },
  184. "smtpPort": {
  185. "maximum": 65535,
  186. "minimum": 1,
  187. "type": "integer"
  188. },
  189. "smtpTo": {
  190. "type": "string"
  191. },
  192. "smtpUsername": {
  193. "type": "string"
  194. },
  195. "subAnnounce": {
  196. "type": "string"
  197. },
  198. "subCalendarExpireInclusive": {
  199. "type": "boolean"
  200. },
  201. "subCertFile": {
  202. "type": "string"
  203. },
  204. "subClashAutoDetect": {
  205. "type": "boolean"
  206. },
  207. "subClashEnable": {
  208. "type": "boolean"
  209. },
  210. "subClashEnableRouting": {
  211. "type": "boolean"
  212. },
  213. "subClashPath": {
  214. "type": "string"
  215. },
  216. "subClashRules": {
  217. "type": "string"
  218. },
  219. "subClashURI": {
  220. "type": "string"
  221. },
  222. "subClashUserAgentRegex": {
  223. "type": "string"
  224. },
  225. "subDomain": {
  226. "type": "string"
  227. },
  228. "subEnable": {
  229. "type": "boolean"
  230. },
  231. "subEnableRouting": {
  232. "type": "boolean"
  233. },
  234. "subEncrypt": {
  235. "type": "boolean"
  236. },
  237. "subExpiredTemplate": {
  238. "type": "string"
  239. },
  240. "subHappAlwaysHwid": {
  241. "type": "boolean"
  242. },
  243. "subHappAutoConnect": {
  244. "type": "boolean"
  245. },
  246. "subHappAutoConnectType": {
  247. "type": "string"
  248. },
  249. "subHappAutoDetect": {
  250. "description": "Happ client customization settings (app-management / routing / UX).",
  251. "type": "boolean"
  252. },
  253. "subHappColorProfile": {
  254. "type": "string"
  255. },
  256. "subHappExcludeApns": {
  257. "type": "boolean"
  258. },
  259. "subHappExcludeRoutes": {
  260. "type": "string"
  261. },
  262. "subHappFallbackUrl": {
  263. "type": "string"
  264. },
  265. "subHappNewUrl": {
  266. "type": "string"
  267. },
  268. "subHappNoLimit": {
  269. "type": "boolean"
  270. },
  271. "subHappNotificationExpire": {
  272. "type": "boolean"
  273. },
  274. "subHappPerAppList": {
  275. "type": "string"
  276. },
  277. "subHappPerAppMode": {
  278. "type": "string"
  279. },
  280. "subHappPingType": {
  281. "type": "string"
  282. },
  283. "subHappProviderId": {
  284. "type": "string"
  285. },
  286. "subHappSubExpire": {
  287. "type": "boolean"
  288. },
  289. "subHappSubExpireButtonLink": {
  290. "type": "string"
  291. },
  292. "subHappSubInfoButtonLink": {
  293. "type": "string"
  294. },
  295. "subHappSubInfoButtonText": {
  296. "type": "string"
  297. },
  298. "subHappSubInfoColor": {
  299. "type": "string"
  300. },
  301. "subHappSubInfoText": {
  302. "type": "string"
  303. },
  304. "subHappTunMode": {
  305. "type": "string"
  306. },
  307. "subHappTunType": {
  308. "type": "string"
  309. },
  310. "subHideSettings": {
  311. "type": "boolean"
  312. },
  313. "subIncyEnableRouting": {
  314. "type": "boolean"
  315. },
  316. "subIncyRoutingRules": {
  317. "type": "string"
  318. },
  319. "subInfoNodeEnable": {
  320. "type": "boolean"
  321. },
  322. "subJsonAlwaysArray": {
  323. "type": "boolean"
  324. },
  325. "subJsonAutoDetect": {
  326. "type": "boolean"
  327. },
  328. "subJsonDns": {
  329. "type": "string"
  330. },
  331. "subJsonEnable": {
  332. "type": "boolean"
  333. },
  334. "subJsonFinalMask": {
  335. "type": "string"
  336. },
  337. "subJsonMux": {
  338. "type": "string"
  339. },
  340. "subJsonObservatory": {
  341. "type": "string"
  342. },
  343. "subJsonPath": {
  344. "type": "string"
  345. },
  346. "subJsonRoutingRules": {
  347. "type": "string"
  348. },
  349. "subJsonRules": {
  350. "type": "string"
  351. },
  352. "subJsonURI": {
  353. "type": "string"
  354. },
  355. "subJsonUserAgentRegex": {
  356. "type": "string"
  357. },
  358. "subKeyFile": {
  359. "type": "string"
  360. },
  361. "subListen": {
  362. "type": "string"
  363. },
  364. "subPath": {
  365. "type": "string"
  366. },
  367. "subPort": {
  368. "maximum": 65535,
  369. "minimum": 1,
  370. "type": "integer"
  371. },
  372. "subProfileMode": {
  373. "type": "string"
  374. },
  375. "subProfileUrl": {
  376. "type": "string"
  377. },
  378. "subRoutingRules": {
  379. "type": "string"
  380. },
  381. "subShowIdentityOnAllLinks": {
  382. "type": "boolean"
  383. },
  384. "subSupportUrl": {
  385. "type": "string"
  386. },
  387. "subThemeDir": {
  388. "type": "string"
  389. },
  390. "subTitle": {
  391. "type": "string"
  392. },
  393. "subTrafficDepletedTemplate": {
  394. "type": "string"
  395. },
  396. "subURI": {
  397. "type": "string"
  398. },
  399. "subUpdates": {
  400. "maximum": 525600,
  401. "minimum": 0,
  402. "type": "integer"
  403. },
  404. "tgBotAPIServer": {
  405. "type": "string"
  406. },
  407. "tgBotBackup": {
  408. "type": "boolean"
  409. },
  410. "tgBotChatId": {
  411. "type": "string"
  412. },
  413. "tgBotEnable": {
  414. "type": "boolean"
  415. },
  416. "tgBotProxy": {
  417. "type": "string"
  418. },
  419. "tgBotToken": {
  420. "type": "string"
  421. },
  422. "tgCpu": {
  423. "maximum": 100,
  424. "minimum": 0,
  425. "type": "integer"
  426. },
  427. "tgEnabledEvents": {
  428. "type": "string"
  429. },
  430. "tgLang": {
  431. "type": "string"
  432. },
  433. "tgMemory": {
  434. "maximum": 100,
  435. "minimum": 0,
  436. "type": "integer"
  437. },
  438. "tgRunTime": {
  439. "type": "string"
  440. },
  441. "timeLocation": {
  442. "type": "string"
  443. },
  444. "trafficDiff": {
  445. "maximum": 100,
  446. "minimum": 0,
  447. "type": "integer"
  448. },
  449. "trustedProxyCIDRs": {
  450. "type": "string"
  451. },
  452. "twoFactorEnable": {
  453. "type": "boolean"
  454. },
  455. "twoFactorToken": {
  456. "type": "string"
  457. },
  458. "warpUpdateInterval": {
  459. "minimum": 0,
  460. "type": "integer"
  461. },
  462. "webBasePath": {
  463. "type": "string"
  464. },
  465. "webCertFile": {
  466. "type": "string"
  467. },
  468. "webDomain": {
  469. "type": "string"
  470. },
  471. "webKeyFile": {
  472. "type": "string"
  473. },
  474. "webListen": {
  475. "type": "string"
  476. },
  477. "webPort": {
  478. "maximum": 65535,
  479. "minimum": 1,
  480. "type": "integer"
  481. }
  482. },
  483. "required": [
  484. "datepicker",
  485. "discordAdminIds",
  486. "discordBotBackup",
  487. "discordBotEnable",
  488. "discordBotToken",
  489. "discordChannelId",
  490. "discordCpu",
  491. "discordEnabledEvents",
  492. "discordLang",
  493. "discordMemory",
  494. "discordRunTime",
  495. "expireDiff",
  496. "externalTrafficInformEnable",
  497. "externalTrafficInformURI",
  498. "happLinkEnable",
  499. "ipLimitAllowlist",
  500. "ldapAutoCreate",
  501. "ldapAutoDelete",
  502. "ldapBaseDN",
  503. "ldapBindDN",
  504. "ldapDefaultExpiryDays",
  505. "ldapDefaultLimitIP",
  506. "ldapDefaultTotalGB",
  507. "ldapEnable",
  508. "ldapFlagField",
  509. "ldapHost",
  510. "ldapInboundTags",
  511. "ldapInsecureSkipVerify",
  512. "ldapInvertFlag",
  513. "ldapPassword",
  514. "ldapPort",
  515. "ldapSyncCron",
  516. "ldapTruthyValues",
  517. "ldapUseTLS",
  518. "ldapUserAttr",
  519. "ldapUserFilter",
  520. "ldapVlessField",
  521. "outboundDownThreshold",
  522. "pageSize",
  523. "panelOutbound",
  524. "realityScanCandidates",
  525. "remarkTemplate",
  526. "restartXrayOnClientDisable",
  527. "sessionMaxAge",
  528. "smtpCpu",
  529. "smtpEnable",
  530. "smtpEnabledEvents",
  531. "smtpEncryptionType",
  532. "smtpFrom",
  533. "smtpFromName",
  534. "smtpHost",
  535. "smtpMemory",
  536. "smtpPassword",
  537. "smtpPort",
  538. "smtpTo",
  539. "smtpUsername",
  540. "subAnnounce",
  541. "subCalendarExpireInclusive",
  542. "subCertFile",
  543. "subClashAutoDetect",
  544. "subClashEnable",
  545. "subClashEnableRouting",
  546. "subClashPath",
  547. "subClashRules",
  548. "subClashURI",
  549. "subClashUserAgentRegex",
  550. "subDomain",
  551. "subEnable",
  552. "subEnableRouting",
  553. "subEncrypt",
  554. "subExpiredTemplate",
  555. "subHappAlwaysHwid",
  556. "subHappAutoConnect",
  557. "subHappAutoConnectType",
  558. "subHappAutoDetect",
  559. "subHappColorProfile",
  560. "subHappExcludeApns",
  561. "subHappExcludeRoutes",
  562. "subHappFallbackUrl",
  563. "subHappNewUrl",
  564. "subHappNoLimit",
  565. "subHappNotificationExpire",
  566. "subHappPerAppList",
  567. "subHappPerAppMode",
  568. "subHappPingType",
  569. "subHappProviderId",
  570. "subHappSubExpire",
  571. "subHappSubExpireButtonLink",
  572. "subHappSubInfoButtonLink",
  573. "subHappSubInfoButtonText",
  574. "subHappSubInfoColor",
  575. "subHappSubInfoText",
  576. "subHappTunMode",
  577. "subHappTunType",
  578. "subHideSettings",
  579. "subIncyEnableRouting",
  580. "subIncyRoutingRules",
  581. "subInfoNodeEnable",
  582. "subJsonAlwaysArray",
  583. "subJsonAutoDetect",
  584. "subJsonDns",
  585. "subJsonEnable",
  586. "subJsonFinalMask",
  587. "subJsonMux",
  588. "subJsonObservatory",
  589. "subJsonPath",
  590. "subJsonRoutingRules",
  591. "subJsonRules",
  592. "subJsonURI",
  593. "subJsonUserAgentRegex",
  594. "subKeyFile",
  595. "subListen",
  596. "subPath",
  597. "subPort",
  598. "subProfileMode",
  599. "subProfileUrl",
  600. "subRoutingRules",
  601. "subShowIdentityOnAllLinks",
  602. "subSupportUrl",
  603. "subThemeDir",
  604. "subTitle",
  605. "subTrafficDepletedTemplate",
  606. "subURI",
  607. "subUpdates",
  608. "tgBotAPIServer",
  609. "tgBotBackup",
  610. "tgBotChatId",
  611. "tgBotEnable",
  612. "tgBotProxy",
  613. "tgBotToken",
  614. "tgCpu",
  615. "tgEnabledEvents",
  616. "tgLang",
  617. "tgMemory",
  618. "tgRunTime",
  619. "timeLocation",
  620. "trafficDiff",
  621. "trustedProxyCIDRs",
  622. "twoFactorEnable",
  623. "twoFactorToken",
  624. "warpUpdateInterval",
  625. "webBasePath",
  626. "webCertFile",
  627. "webDomain",
  628. "webKeyFile",
  629. "webListen",
  630. "webPort"
  631. ],
  632. "type": "object"
  633. },
  634. "AllSettingView": {
  635. "properties": {
  636. "datepicker": {
  637. "type": "string"
  638. },
  639. "discordAdminIds": {
  640. "type": "string"
  641. },
  642. "discordBotBackup": {
  643. "type": "boolean"
  644. },
  645. "discordBotEnable": {
  646. "type": "boolean"
  647. },
  648. "discordBotToken": {
  649. "type": "string"
  650. },
  651. "discordChannelId": {
  652. "type": "string"
  653. },
  654. "discordCpu": {
  655. "maximum": 100,
  656. "minimum": 0,
  657. "type": "integer"
  658. },
  659. "discordEnabledEvents": {
  660. "type": "string"
  661. },
  662. "discordLang": {
  663. "type": "string"
  664. },
  665. "discordMemory": {
  666. "maximum": 100,
  667. "minimum": 0,
  668. "type": "integer"
  669. },
  670. "discordRunTime": {
  671. "type": "string"
  672. },
  673. "expireDiff": {
  674. "minimum": 0,
  675. "type": "integer"
  676. },
  677. "externalTrafficInformEnable": {
  678. "type": "boolean"
  679. },
  680. "externalTrafficInformURI": {
  681. "type": "string"
  682. },
  683. "happLinkEnable": {
  684. "type": "boolean"
  685. },
  686. "hasApiToken": {
  687. "type": "boolean"
  688. },
  689. "hasDiscordBotToken": {
  690. "type": "boolean"
  691. },
  692. "hasLdapPassword": {
  693. "type": "boolean"
  694. },
  695. "hasNordSecret": {
  696. "type": "boolean"
  697. },
  698. "hasSmtpPassword": {
  699. "type": "boolean"
  700. },
  701. "hasTgBotToken": {
  702. "type": "boolean"
  703. },
  704. "hasTwoFactorToken": {
  705. "type": "boolean"
  706. },
  707. "hasWarpSecret": {
  708. "type": "boolean"
  709. },
  710. "ipLimitAllowlist": {
  711. "type": "string"
  712. },
  713. "ldapAutoCreate": {
  714. "type": "boolean"
  715. },
  716. "ldapAutoDelete": {
  717. "type": "boolean"
  718. },
  719. "ldapBaseDN": {
  720. "type": "string"
  721. },
  722. "ldapBindDN": {
  723. "type": "string"
  724. },
  725. "ldapDefaultExpiryDays": {
  726. "minimum": 0,
  727. "type": "integer"
  728. },
  729. "ldapDefaultLimitIP": {
  730. "minimum": 0,
  731. "type": "integer"
  732. },
  733. "ldapDefaultTotalGB": {
  734. "minimum": 0,
  735. "type": "integer"
  736. },
  737. "ldapEnable": {
  738. "type": "boolean"
  739. },
  740. "ldapFlagField": {
  741. "type": "string"
  742. },
  743. "ldapHost": {
  744. "type": "string"
  745. },
  746. "ldapInboundTags": {
  747. "type": "string"
  748. },
  749. "ldapInsecureSkipVerify": {
  750. "type": "boolean"
  751. },
  752. "ldapInvertFlag": {
  753. "type": "boolean"
  754. },
  755. "ldapPassword": {
  756. "type": "string"
  757. },
  758. "ldapPort": {
  759. "maximum": 65535,
  760. "minimum": 0,
  761. "type": "integer"
  762. },
  763. "ldapSyncCron": {
  764. "type": "string"
  765. },
  766. "ldapTruthyValues": {
  767. "type": "string"
  768. },
  769. "ldapUseTLS": {
  770. "type": "boolean"
  771. },
  772. "ldapUserAttr": {
  773. "type": "string"
  774. },
  775. "ldapUserFilter": {
  776. "type": "string"
  777. },
  778. "ldapVlessField": {
  779. "type": "string"
  780. },
  781. "outboundDownThreshold": {
  782. "maximum": 100,
  783. "minimum": 1,
  784. "type": "integer"
  785. },
  786. "pageSize": {
  787. "maximum": 1000,
  788. "minimum": 0,
  789. "type": "integer"
  790. },
  791. "panelOutbound": {
  792. "type": "string"
  793. },
  794. "realityScanCandidates": {
  795. "type": "string"
  796. },
  797. "remarkTemplate": {
  798. "type": "string"
  799. },
  800. "restartXrayOnClientDisable": {
  801. "type": "boolean"
  802. },
  803. "sessionMaxAge": {
  804. "maximum": 525600,
  805. "minimum": 1,
  806. "type": "integer"
  807. },
  808. "smtpCpu": {
  809. "maximum": 100,
  810. "minimum": 0,
  811. "type": "integer"
  812. },
  813. "smtpEnable": {
  814. "type": "boolean"
  815. },
  816. "smtpEnabledEvents": {
  817. "type": "string"
  818. },
  819. "smtpEncryptionType": {
  820. "type": "string"
  821. },
  822. "smtpFrom": {
  823. "type": "string"
  824. },
  825. "smtpFromName": {
  826. "type": "string"
  827. },
  828. "smtpHost": {
  829. "type": "string"
  830. },
  831. "smtpMemory": {
  832. "maximum": 100,
  833. "minimum": 0,
  834. "type": "integer"
  835. },
  836. "smtpPassword": {
  837. "type": "string"
  838. },
  839. "smtpPort": {
  840. "maximum": 65535,
  841. "minimum": 1,
  842. "type": "integer"
  843. },
  844. "smtpTo": {
  845. "type": "string"
  846. },
  847. "smtpUsername": {
  848. "type": "string"
  849. },
  850. "subAnnounce": {
  851. "type": "string"
  852. },
  853. "subCalendarExpireInclusive": {
  854. "type": "boolean"
  855. },
  856. "subCertFile": {
  857. "type": "string"
  858. },
  859. "subClashAutoDetect": {
  860. "type": "boolean"
  861. },
  862. "subClashEnable": {
  863. "type": "boolean"
  864. },
  865. "subClashEnableRouting": {
  866. "type": "boolean"
  867. },
  868. "subClashPath": {
  869. "type": "string"
  870. },
  871. "subClashRules": {
  872. "type": "string"
  873. },
  874. "subClashURI": {
  875. "type": "string"
  876. },
  877. "subClashUserAgentRegex": {
  878. "type": "string"
  879. },
  880. "subDomain": {
  881. "type": "string"
  882. },
  883. "subEnable": {
  884. "type": "boolean"
  885. },
  886. "subEnableRouting": {
  887. "type": "boolean"
  888. },
  889. "subEncrypt": {
  890. "type": "boolean"
  891. },
  892. "subExpiredTemplate": {
  893. "type": "string"
  894. },
  895. "subHappAlwaysHwid": {
  896. "type": "boolean"
  897. },
  898. "subHappAutoConnect": {
  899. "type": "boolean"
  900. },
  901. "subHappAutoConnectType": {
  902. "type": "string"
  903. },
  904. "subHappAutoDetect": {
  905. "description": "Happ client customization settings (app-management / routing / UX).",
  906. "type": "boolean"
  907. },
  908. "subHappColorProfile": {
  909. "type": "string"
  910. },
  911. "subHappExcludeApns": {
  912. "type": "boolean"
  913. },
  914. "subHappExcludeRoutes": {
  915. "type": "string"
  916. },
  917. "subHappFallbackUrl": {
  918. "type": "string"
  919. },
  920. "subHappNewUrl": {
  921. "type": "string"
  922. },
  923. "subHappNoLimit": {
  924. "type": "boolean"
  925. },
  926. "subHappNotificationExpire": {
  927. "type": "boolean"
  928. },
  929. "subHappPerAppList": {
  930. "type": "string"
  931. },
  932. "subHappPerAppMode": {
  933. "type": "string"
  934. },
  935. "subHappPingType": {
  936. "type": "string"
  937. },
  938. "subHappProviderId": {
  939. "type": "string"
  940. },
  941. "subHappSubExpire": {
  942. "type": "boolean"
  943. },
  944. "subHappSubExpireButtonLink": {
  945. "type": "string"
  946. },
  947. "subHappSubInfoButtonLink": {
  948. "type": "string"
  949. },
  950. "subHappSubInfoButtonText": {
  951. "type": "string"
  952. },
  953. "subHappSubInfoColor": {
  954. "type": "string"
  955. },
  956. "subHappSubInfoText": {
  957. "type": "string"
  958. },
  959. "subHappTunMode": {
  960. "type": "string"
  961. },
  962. "subHappTunType": {
  963. "type": "string"
  964. },
  965. "subHideSettings": {
  966. "type": "boolean"
  967. },
  968. "subIncyEnableRouting": {
  969. "type": "boolean"
  970. },
  971. "subIncyRoutingRules": {
  972. "type": "string"
  973. },
  974. "subInfoNodeEnable": {
  975. "type": "boolean"
  976. },
  977. "subJsonAlwaysArray": {
  978. "type": "boolean"
  979. },
  980. "subJsonAutoDetect": {
  981. "type": "boolean"
  982. },
  983. "subJsonDns": {
  984. "type": "string"
  985. },
  986. "subJsonEnable": {
  987. "type": "boolean"
  988. },
  989. "subJsonFinalMask": {
  990. "type": "string"
  991. },
  992. "subJsonMux": {
  993. "type": "string"
  994. },
  995. "subJsonObservatory": {
  996. "type": "string"
  997. },
  998. "subJsonPath": {
  999. "type": "string"
  1000. },
  1001. "subJsonRoutingRules": {
  1002. "type": "string"
  1003. },
  1004. "subJsonRules": {
  1005. "type": "string"
  1006. },
  1007. "subJsonURI": {
  1008. "type": "string"
  1009. },
  1010. "subJsonUserAgentRegex": {
  1011. "type": "string"
  1012. },
  1013. "subKeyFile": {
  1014. "type": "string"
  1015. },
  1016. "subListen": {
  1017. "type": "string"
  1018. },
  1019. "subPath": {
  1020. "type": "string"
  1021. },
  1022. "subPort": {
  1023. "maximum": 65535,
  1024. "minimum": 1,
  1025. "type": "integer"
  1026. },
  1027. "subProfileMode": {
  1028. "type": "string"
  1029. },
  1030. "subProfileUrl": {
  1031. "type": "string"
  1032. },
  1033. "subRoutingRules": {
  1034. "type": "string"
  1035. },
  1036. "subShowIdentityOnAllLinks": {
  1037. "type": "boolean"
  1038. },
  1039. "subSupportUrl": {
  1040. "type": "string"
  1041. },
  1042. "subThemeDir": {
  1043. "type": "string"
  1044. },
  1045. "subTitle": {
  1046. "type": "string"
  1047. },
  1048. "subTrafficDepletedTemplate": {
  1049. "type": "string"
  1050. },
  1051. "subURI": {
  1052. "type": "string"
  1053. },
  1054. "subUpdates": {
  1055. "maximum": 525600,
  1056. "minimum": 0,
  1057. "type": "integer"
  1058. },
  1059. "tgBotAPIServer": {
  1060. "type": "string"
  1061. },
  1062. "tgBotBackup": {
  1063. "type": "boolean"
  1064. },
  1065. "tgBotChatId": {
  1066. "type": "string"
  1067. },
  1068. "tgBotEnable": {
  1069. "type": "boolean"
  1070. },
  1071. "tgBotProxy": {
  1072. "type": "string"
  1073. },
  1074. "tgBotToken": {
  1075. "type": "string"
  1076. },
  1077. "tgCpu": {
  1078. "maximum": 100,
  1079. "minimum": 0,
  1080. "type": "integer"
  1081. },
  1082. "tgEnabledEvents": {
  1083. "type": "string"
  1084. },
  1085. "tgLang": {
  1086. "type": "string"
  1087. },
  1088. "tgMemory": {
  1089. "maximum": 100,
  1090. "minimum": 0,
  1091. "type": "integer"
  1092. },
  1093. "tgRunTime": {
  1094. "type": "string"
  1095. },
  1096. "timeLocation": {
  1097. "type": "string"
  1098. },
  1099. "trafficDiff": {
  1100. "maximum": 100,
  1101. "minimum": 0,
  1102. "type": "integer"
  1103. },
  1104. "trustedProxyCIDRs": {
  1105. "type": "string"
  1106. },
  1107. "twoFactorEnable": {
  1108. "type": "boolean"
  1109. },
  1110. "twoFactorToken": {
  1111. "type": "string"
  1112. },
  1113. "warpUpdateInterval": {
  1114. "minimum": 0,
  1115. "type": "integer"
  1116. },
  1117. "webBasePath": {
  1118. "type": "string"
  1119. },
  1120. "webCertFile": {
  1121. "type": "string"
  1122. },
  1123. "webDomain": {
  1124. "type": "string"
  1125. },
  1126. "webKeyFile": {
  1127. "type": "string"
  1128. },
  1129. "webListen": {
  1130. "type": "string"
  1131. },
  1132. "webPort": {
  1133. "maximum": 65535,
  1134. "minimum": 1,
  1135. "type": "integer"
  1136. }
  1137. },
  1138. "required": [
  1139. "datepicker",
  1140. "discordAdminIds",
  1141. "discordBotBackup",
  1142. "discordBotEnable",
  1143. "discordBotToken",
  1144. "discordChannelId",
  1145. "discordCpu",
  1146. "discordEnabledEvents",
  1147. "discordLang",
  1148. "discordMemory",
  1149. "discordRunTime",
  1150. "expireDiff",
  1151. "externalTrafficInformEnable",
  1152. "externalTrafficInformURI",
  1153. "happLinkEnable",
  1154. "hasApiToken",
  1155. "hasDiscordBotToken",
  1156. "hasLdapPassword",
  1157. "hasNordSecret",
  1158. "hasSmtpPassword",
  1159. "hasTgBotToken",
  1160. "hasTwoFactorToken",
  1161. "hasWarpSecret",
  1162. "ipLimitAllowlist",
  1163. "ldapAutoCreate",
  1164. "ldapAutoDelete",
  1165. "ldapBaseDN",
  1166. "ldapBindDN",
  1167. "ldapDefaultExpiryDays",
  1168. "ldapDefaultLimitIP",
  1169. "ldapDefaultTotalGB",
  1170. "ldapEnable",
  1171. "ldapFlagField",
  1172. "ldapHost",
  1173. "ldapInboundTags",
  1174. "ldapInsecureSkipVerify",
  1175. "ldapInvertFlag",
  1176. "ldapPassword",
  1177. "ldapPort",
  1178. "ldapSyncCron",
  1179. "ldapTruthyValues",
  1180. "ldapUseTLS",
  1181. "ldapUserAttr",
  1182. "ldapUserFilter",
  1183. "ldapVlessField",
  1184. "outboundDownThreshold",
  1185. "pageSize",
  1186. "panelOutbound",
  1187. "realityScanCandidates",
  1188. "remarkTemplate",
  1189. "restartXrayOnClientDisable",
  1190. "sessionMaxAge",
  1191. "smtpCpu",
  1192. "smtpEnable",
  1193. "smtpEnabledEvents",
  1194. "smtpEncryptionType",
  1195. "smtpFrom",
  1196. "smtpFromName",
  1197. "smtpHost",
  1198. "smtpMemory",
  1199. "smtpPassword",
  1200. "smtpPort",
  1201. "smtpTo",
  1202. "smtpUsername",
  1203. "subAnnounce",
  1204. "subCalendarExpireInclusive",
  1205. "subCertFile",
  1206. "subClashAutoDetect",
  1207. "subClashEnable",
  1208. "subClashEnableRouting",
  1209. "subClashPath",
  1210. "subClashRules",
  1211. "subClashURI",
  1212. "subClashUserAgentRegex",
  1213. "subDomain",
  1214. "subEnable",
  1215. "subEnableRouting",
  1216. "subEncrypt",
  1217. "subExpiredTemplate",
  1218. "subHappAlwaysHwid",
  1219. "subHappAutoConnect",
  1220. "subHappAutoConnectType",
  1221. "subHappAutoDetect",
  1222. "subHappColorProfile",
  1223. "subHappExcludeApns",
  1224. "subHappExcludeRoutes",
  1225. "subHappFallbackUrl",
  1226. "subHappNewUrl",
  1227. "subHappNoLimit",
  1228. "subHappNotificationExpire",
  1229. "subHappPerAppList",
  1230. "subHappPerAppMode",
  1231. "subHappPingType",
  1232. "subHappProviderId",
  1233. "subHappSubExpire",
  1234. "subHappSubExpireButtonLink",
  1235. "subHappSubInfoButtonLink",
  1236. "subHappSubInfoButtonText",
  1237. "subHappSubInfoColor",
  1238. "subHappSubInfoText",
  1239. "subHappTunMode",
  1240. "subHappTunType",
  1241. "subHideSettings",
  1242. "subIncyEnableRouting",
  1243. "subIncyRoutingRules",
  1244. "subInfoNodeEnable",
  1245. "subJsonAlwaysArray",
  1246. "subJsonAutoDetect",
  1247. "subJsonDns",
  1248. "subJsonEnable",
  1249. "subJsonFinalMask",
  1250. "subJsonMux",
  1251. "subJsonObservatory",
  1252. "subJsonPath",
  1253. "subJsonRoutingRules",
  1254. "subJsonRules",
  1255. "subJsonURI",
  1256. "subJsonUserAgentRegex",
  1257. "subKeyFile",
  1258. "subListen",
  1259. "subPath",
  1260. "subPort",
  1261. "subProfileMode",
  1262. "subProfileUrl",
  1263. "subRoutingRules",
  1264. "subShowIdentityOnAllLinks",
  1265. "subSupportUrl",
  1266. "subThemeDir",
  1267. "subTitle",
  1268. "subTrafficDepletedTemplate",
  1269. "subURI",
  1270. "subUpdates",
  1271. "tgBotAPIServer",
  1272. "tgBotBackup",
  1273. "tgBotChatId",
  1274. "tgBotEnable",
  1275. "tgBotProxy",
  1276. "tgBotToken",
  1277. "tgCpu",
  1278. "tgEnabledEvents",
  1279. "tgLang",
  1280. "tgMemory",
  1281. "tgRunTime",
  1282. "timeLocation",
  1283. "trafficDiff",
  1284. "trustedProxyCIDRs",
  1285. "twoFactorEnable",
  1286. "twoFactorToken",
  1287. "warpUpdateInterval",
  1288. "webBasePath",
  1289. "webCertFile",
  1290. "webDomain",
  1291. "webKeyFile",
  1292. "webListen",
  1293. "webPort"
  1294. ],
  1295. "type": "object"
  1296. },
  1297. "AmneziaWGLogs": {
  1298. "description": "AmneziaWGLogs is what the overview's AmneziaWG log view renders: the live\nper-peer activity of every running embedded interface, plus the panel's\nown recent AmneziaWG lifecycle log lines that explain a peer being absent\nfrom Peers at all.",
  1299. "properties": {
  1300. "events": {
  1301. "example": [
  1302. "2025/01/01 12:00:00 amneziawg: started interface awg1 for inbound 1"
  1303. ],
  1304. "items": {
  1305. "type": "string"
  1306. },
  1307. "type": "array"
  1308. },
  1309. "peers": {
  1310. "items": {
  1311. "$ref": "#/components/schemas/PeerActivity"
  1312. },
  1313. "type": "array"
  1314. },
  1315. "running": {
  1316. "example": true,
  1317. "type": "boolean"
  1318. }
  1319. },
  1320. "required": [
  1321. "events",
  1322. "peers",
  1323. "running"
  1324. ],
  1325. "type": "object"
  1326. },
  1327. "ApiToken": {
  1328. "properties": {
  1329. "createdAt": {
  1330. "format": "int64",
  1331. "type": "integer"
  1332. },
  1333. "enabled": {
  1334. "type": "boolean"
  1335. },
  1336. "expiresAt": {
  1337. "format": "int64",
  1338. "type": "integer"
  1339. },
  1340. "id": {
  1341. "type": "integer"
  1342. },
  1343. "name": {
  1344. "type": "string"
  1345. },
  1346. "scope": {
  1347. "type": "string"
  1348. },
  1349. "token": {
  1350. "description": "SHA-256 hash; the plaintext is shown only once at creation",
  1351. "type": "string"
  1352. }
  1353. },
  1354. "required": [
  1355. "createdAt",
  1356. "enabled",
  1357. "expiresAt",
  1358. "id",
  1359. "name",
  1360. "scope",
  1361. "token"
  1362. ],
  1363. "type": "object"
  1364. },
  1365. "ApiTokenView": {
  1366. "properties": {
  1367. "createdAt": {
  1368. "example": 1736000000,
  1369. "format": "int64",
  1370. "type": "integer"
  1371. },
  1372. "enabled": {
  1373. "example": true,
  1374. "type": "boolean"
  1375. },
  1376. "expiresAt": {
  1377. "example": 0,
  1378. "format": "int64",
  1379. "type": "integer"
  1380. },
  1381. "id": {
  1382. "example": 2,
  1383. "type": "integer"
  1384. },
  1385. "name": {
  1386. "example": "central-panel-a",
  1387. "type": "string"
  1388. },
  1389. "scope": {
  1390. "example": "admin",
  1391. "type": "string"
  1392. },
  1393. "token": {
  1394. "example": "new-token-string",
  1395. "type": "string"
  1396. }
  1397. },
  1398. "required": [
  1399. "createdAt",
  1400. "enabled",
  1401. "expiresAt",
  1402. "id",
  1403. "name",
  1404. "scope"
  1405. ],
  1406. "type": "object"
  1407. },
  1408. "Client": {
  1409. "description": "Client represents a client configuration for Xray inbounds with traffic limits and settings.",
  1410. "properties": {
  1411. "adTag": {
  1412. "example": "0123456789abcdef0123456789abcdef",
  1413. "type": "string"
  1414. },
  1415. "allowedIPs": {
  1416. "items": {
  1417. "type": "string"
  1418. },
  1419. "type": "array"
  1420. },
  1421. "allowedIPsByInbound": {
  1422. "additionalProperties": {
  1423. "items": {
  1424. "type": "string"
  1425. },
  1426. "type": "array"
  1427. },
  1428. "description": "AllowedIPsByInbound optionally overrides AllowedIPs on a per-inbound\nbasis, keyed by inbound id. Lets one identity attached to both\nWireGuard and AmneziaWG carry two genuinely different addresses in a\nsingle Create/Update call instead of the shared AllowedIPs field\nbeing broadcast to every attached tunnel inbound. Absent/unset for a\ngiven inbound id falls back to the shared AllowedIPs exactly as\nbefore -- fully backward compatible for callers that never set this.",
  1429. "type": "object"
  1430. },
  1431. "auth": {
  1432. "description": "Auth password (Hysteria)",
  1433. "type": "string"
  1434. },
  1435. "comment": {
  1436. "description": "Client comment",
  1437. "type": "string"
  1438. },
  1439. "created_at": {
  1440. "description": "Creation timestamp",
  1441. "format": "int64",
  1442. "type": "integer"
  1443. },
  1444. "email": {
  1445. "description": "Client email identifier",
  1446. "type": "string"
  1447. },
  1448. "enable": {
  1449. "description": "Whether the client is enabled",
  1450. "type": "boolean"
  1451. },
  1452. "expiryTime": {
  1453. "description": "Expiration timestamp",
  1454. "format": "int64",
  1455. "type": "integer"
  1456. },
  1457. "flow": {
  1458. "description": "Flow control (XTLS)",
  1459. "type": "string"
  1460. },
  1461. "forwardedPorts": {
  1462. "description": "AmneziaWG per-client port-forwarding spec, e.g. \"80,443,8000-8100\"",
  1463. "type": "string"
  1464. },
  1465. "group": {
  1466. "description": "Logical grouping label",
  1467. "type": "string"
  1468. },
  1469. "id": {
  1470. "description": "Unique client identifier",
  1471. "type": "string"
  1472. },
  1473. "keepAlive": {
  1474. "description": "Seconds between PersistentKeepalive packets; 0 sends none, omit to keep the stored value",
  1475. "nullable": true,
  1476. "type": "integer"
  1477. },
  1478. "limitIp": {
  1479. "description": "IP limit for this client",
  1480. "type": "integer"
  1481. },
  1482. "password": {
  1483. "description": "Client password",
  1484. "type": "string"
  1485. },
  1486. "preSharedKey": {
  1487. "type": "string"
  1488. },
  1489. "privateKey": {
  1490. "type": "string"
  1491. },
  1492. "publicKey": {
  1493. "type": "string"
  1494. },
  1495. "reset": {
  1496. "description": "Reset period in days",
  1497. "type": "integer"
  1498. },
  1499. "resetDay": {
  1500. "description": "Calendar renewal day 1-31, 0 = interval mode",
  1501. "type": "integer"
  1502. },
  1503. "resetMax": {
  1504. "description": "Max auto-renew count, 0 = unlimited",
  1505. "type": "integer"
  1506. },
  1507. "reverse": {
  1508. "allOf": [
  1509. {
  1510. "$ref": "#/components/schemas/ClientReverse"
  1511. }
  1512. ],
  1513. "description": "VLESS simple reverse proxy settings",
  1514. "nullable": true
  1515. },
  1516. "secret": {
  1517. "example": "ee1234567890abcdef1234567890abcd7777772e636c6f7564666c6172652e636f6d",
  1518. "type": "string"
  1519. },
  1520. "security": {
  1521. "description": "Security method (e.g., \"auto\", \"aes-128-gcm\")",
  1522. "type": "string"
  1523. },
  1524. "subId": {
  1525. "description": "Subscription identifier",
  1526. "type": "string"
  1527. },
  1528. "tgId": {
  1529. "description": "Telegram user ID for notifications",
  1530. "format": "int64",
  1531. "type": "integer"
  1532. },
  1533. "totalGB": {
  1534. "description": "Total traffic limit in GB",
  1535. "format": "int64",
  1536. "type": "integer"
  1537. },
  1538. "trafficReset": {
  1539. "description": "Per-client traffic reset cycle, independent of the inbound's own (#5497).",
  1540. "enum": [
  1541. "never",
  1542. "hourly",
  1543. "daily",
  1544. "weekly",
  1545. "monthly"
  1546. ],
  1547. "type": "string"
  1548. },
  1549. "trafficResetDay": {
  1550. "maximum": 31,
  1551. "minimum": 1,
  1552. "type": "integer"
  1553. },
  1554. "updated_at": {
  1555. "description": "Last update timestamp",
  1556. "format": "int64",
  1557. "type": "integer"
  1558. }
  1559. },
  1560. "required": [
  1561. "comment",
  1562. "email",
  1563. "enable",
  1564. "expiryTime",
  1565. "limitIp",
  1566. "reset",
  1567. "resetDay",
  1568. "resetMax",
  1569. "security",
  1570. "subId",
  1571. "tgId",
  1572. "totalGB"
  1573. ],
  1574. "type": "object"
  1575. },
  1576. "ClientInbound": {
  1577. "properties": {
  1578. "clientId": {
  1579. "type": "integer"
  1580. },
  1581. "createdAt": {
  1582. "format": "int64",
  1583. "type": "integer"
  1584. },
  1585. "flowOverride": {
  1586. "type": "string"
  1587. },
  1588. "inboundId": {
  1589. "type": "integer"
  1590. }
  1591. },
  1592. "required": [
  1593. "clientId",
  1594. "createdAt",
  1595. "flowOverride",
  1596. "inboundId"
  1597. ],
  1598. "type": "object"
  1599. },
  1600. "ClientPageResponse": {
  1601. "description": "ClientPageResponse is the shape returned by ListPaged. `Total` is the\nrow count in the DB; `Filtered` is the count after Search/Filter/Protocol\nwere applied, before pagination. The page contains at most PageSize items.\nSummary is computed across the full DB row set so dashboard counters\non the clients page stay stable as the user paginates/filters.",
  1602. "properties": {
  1603. "filtered": {
  1604. "example": 47,
  1605. "type": "integer"
  1606. },
  1607. "groups": {
  1608. "example": [
  1609. "staff",
  1610. "trial"
  1611. ],
  1612. "items": {
  1613. "type": "string"
  1614. },
  1615. "type": "array"
  1616. },
  1617. "items": {
  1618. "items": {
  1619. "$ref": "#/components/schemas/ClientSlim"
  1620. },
  1621. "type": "array"
  1622. },
  1623. "page": {
  1624. "example": 1,
  1625. "type": "integer"
  1626. },
  1627. "pageSize": {
  1628. "example": 25,
  1629. "type": "integer"
  1630. },
  1631. "summary": {
  1632. "$ref": "#/components/schemas/ClientsSummary"
  1633. },
  1634. "total": {
  1635. "example": 2000,
  1636. "type": "integer"
  1637. }
  1638. },
  1639. "required": [
  1640. "filtered",
  1641. "groups",
  1642. "items",
  1643. "page",
  1644. "pageSize",
  1645. "summary",
  1646. "total"
  1647. ],
  1648. "type": "object"
  1649. },
  1650. "ClientRecord": {
  1651. "properties": {
  1652. "adTag": {
  1653. "type": "string"
  1654. },
  1655. "allowedIPs": {
  1656. "type": "string"
  1657. },
  1658. "auth": {
  1659. "type": "string"
  1660. },
  1661. "comment": {
  1662. "type": "string"
  1663. },
  1664. "createdAt": {
  1665. "format": "int64",
  1666. "type": "integer"
  1667. },
  1668. "email": {
  1669. "type": "string"
  1670. },
  1671. "enable": {
  1672. "type": "boolean"
  1673. },
  1674. "expiryTime": {
  1675. "format": "int64",
  1676. "type": "integer"
  1677. },
  1678. "flow": {
  1679. "type": "string"
  1680. },
  1681. "forwardedPorts": {
  1682. "type": "string"
  1683. },
  1684. "group": {
  1685. "type": "string"
  1686. },
  1687. "id": {
  1688. "type": "integer"
  1689. },
  1690. "keepAlive": {
  1691. "type": "integer"
  1692. },
  1693. "limitHwid": {
  1694. "type": "integer"
  1695. },
  1696. "limitIp": {
  1697. "type": "integer"
  1698. },
  1699. "password": {
  1700. "type": "string"
  1701. },
  1702. "preSharedKey": {
  1703. "type": "string"
  1704. },
  1705. "privateKey": {
  1706. "type": "string"
  1707. },
  1708. "publicKey": {
  1709. "type": "string"
  1710. },
  1711. "reset": {
  1712. "type": "integer"
  1713. },
  1714. "resetDay": {
  1715. "type": "integer"
  1716. },
  1717. "resetMax": {
  1718. "type": "integer"
  1719. },
  1720. "reverse": {},
  1721. "secret": {
  1722. "type": "string"
  1723. },
  1724. "security": {
  1725. "type": "string"
  1726. },
  1727. "subId": {
  1728. "type": "string"
  1729. },
  1730. "tgId": {
  1731. "format": "int64",
  1732. "type": "integer"
  1733. },
  1734. "totalGB": {
  1735. "format": "int64",
  1736. "type": "integer"
  1737. },
  1738. "trafficReset": {
  1739. "type": "string"
  1740. },
  1741. "trafficResetDay": {
  1742. "type": "integer"
  1743. },
  1744. "updatedAt": {
  1745. "format": "int64",
  1746. "type": "integer"
  1747. },
  1748. "uuid": {
  1749. "type": "string"
  1750. }
  1751. },
  1752. "required": [
  1753. "adTag",
  1754. "allowedIPs",
  1755. "auth",
  1756. "comment",
  1757. "createdAt",
  1758. "email",
  1759. "enable",
  1760. "expiryTime",
  1761. "flow",
  1762. "forwardedPorts",
  1763. "group",
  1764. "id",
  1765. "keepAlive",
  1766. "limitHwid",
  1767. "limitIp",
  1768. "password",
  1769. "preSharedKey",
  1770. "privateKey",
  1771. "publicKey",
  1772. "reset",
  1773. "resetDay",
  1774. "resetMax",
  1775. "reverse",
  1776. "secret",
  1777. "security",
  1778. "subId",
  1779. "tgId",
  1780. "totalGB",
  1781. "trafficReset",
  1782. "trafficResetDay",
  1783. "updatedAt",
  1784. "uuid"
  1785. ],
  1786. "type": "object"
  1787. },
  1788. "ClientReverse": {
  1789. "properties": {
  1790. "tag": {
  1791. "type": "string"
  1792. }
  1793. },
  1794. "required": [
  1795. "tag"
  1796. ],
  1797. "type": "object"
  1798. },
  1799. "ClientSlim": {
  1800. "description": "ClientSlim is the row-shape used by the clients page. It drops fields the\ntable never reads (UUID, password, auth, flow, security, reverse, tgId)\nso the list payload stays compact even when the panel manages thousands\nof clients. Modals that need the full record still call /get/:email.",
  1801. "properties": {
  1802. "comment": {
  1803. "example": "Primary device",
  1804. "type": "string"
  1805. },
  1806. "createdAt": {
  1807. "example": 1735000000000,
  1808. "format": "int64",
  1809. "type": "integer"
  1810. },
  1811. "email": {
  1812. "example": "[email protected]",
  1813. "type": "string"
  1814. },
  1815. "enable": {
  1816. "example": true,
  1817. "type": "boolean"
  1818. },
  1819. "expiryTime": {
  1820. "example": 1735689600000,
  1821. "format": "int64",
  1822. "type": "integer"
  1823. },
  1824. "group": {
  1825. "example": "staff",
  1826. "type": "string"
  1827. },
  1828. "inboundIds": {
  1829. "example": [
  1830. 3,
  1831. 5
  1832. ],
  1833. "items": {
  1834. "type": "integer"
  1835. },
  1836. "type": "array"
  1837. },
  1838. "limitHwid": {
  1839. "example": 0,
  1840. "type": "integer"
  1841. },
  1842. "limitIp": {
  1843. "example": 0,
  1844. "type": "integer"
  1845. },
  1846. "reset": {
  1847. "example": 0,
  1848. "type": "integer"
  1849. },
  1850. "resetDay": {
  1851. "example": 0,
  1852. "type": "integer"
  1853. },
  1854. "resetMax": {
  1855. "example": 0,
  1856. "type": "integer"
  1857. },
  1858. "subId": {
  1859. "example": "abcd1234",
  1860. "type": "string"
  1861. },
  1862. "totalGB": {
  1863. "example": 53687091200,
  1864. "format": "int64",
  1865. "type": "integer"
  1866. },
  1867. "traffic": {
  1868. "allOf": [
  1869. {
  1870. "$ref": "#/components/schemas/ClientTraffic"
  1871. }
  1872. ],
  1873. "nullable": true
  1874. },
  1875. "updatedAt": {
  1876. "example": 1735100000000,
  1877. "format": "int64",
  1878. "type": "integer"
  1879. }
  1880. },
  1881. "required": [
  1882. "createdAt",
  1883. "email",
  1884. "enable",
  1885. "expiryTime",
  1886. "inboundIds",
  1887. "limitHwid",
  1888. "limitIp",
  1889. "reset",
  1890. "resetDay",
  1891. "resetMax",
  1892. "subId",
  1893. "totalGB",
  1894. "updatedAt"
  1895. ],
  1896. "type": "object"
  1897. },
  1898. "ClientTraffic": {
  1899. "description": "ClientTraffic represents traffic statistics and limits for a specific client.\nIt tracks upload/download usage, expiry times, and online status for inbound clients.",
  1900. "properties": {
  1901. "down": {
  1902. "example": 2097152,
  1903. "format": "int64",
  1904. "type": "integer"
  1905. },
  1906. "email": {
  1907. "example": "user1",
  1908. "type": "string"
  1909. },
  1910. "enable": {
  1911. "example": true,
  1912. "type": "boolean"
  1913. },
  1914. "expiryTime": {
  1915. "example": 1735689600000,
  1916. "format": "int64",
  1917. "type": "integer"
  1918. },
  1919. "id": {
  1920. "example": 14825,
  1921. "type": "integer"
  1922. },
  1923. "inboundId": {
  1924. "example": 1,
  1925. "type": "integer"
  1926. },
  1927. "lastOnline": {
  1928. "example": 1735680000000,
  1929. "format": "int64",
  1930. "type": "integer"
  1931. },
  1932. "lastSubFetch": {
  1933. "example": 1735680000000,
  1934. "format": "int64",
  1935. "type": "integer"
  1936. },
  1937. "reset": {
  1938. "example": 0,
  1939. "type": "integer"
  1940. },
  1941. "resetCount": {
  1942. "description": "ResetCount is how many have fired, so a prepaid plan stops on its own.",
  1943. "example": 0,
  1944. "type": "integer"
  1945. },
  1946. "resetDay": {
  1947. "description": "ResetDay renews on that day of each calendar month instead of every\nReset days; 0 keeps the interval behaviour.",
  1948. "example": 0,
  1949. "type": "integer"
  1950. },
  1951. "resetMax": {
  1952. "description": "ResetMax caps how many times auto-renew may fire; 0 means no cap.",
  1953. "example": 0,
  1954. "type": "integer"
  1955. },
  1956. "subId": {
  1957. "example": "i7tvdpeffi0hvvf1",
  1958. "type": "string"
  1959. },
  1960. "total": {
  1961. "example": 10737418240,
  1962. "format": "int64",
  1963. "type": "integer"
  1964. },
  1965. "up": {
  1966. "example": 1048576,
  1967. "format": "int64",
  1968. "type": "integer"
  1969. },
  1970. "uuid": {
  1971. "example": "e18c9a96-71bf-48d4-933f-8b9a46d4290c",
  1972. "type": "string"
  1973. }
  1974. },
  1975. "required": [
  1976. "down",
  1977. "email",
  1978. "enable",
  1979. "expiryTime",
  1980. "id",
  1981. "inboundId",
  1982. "lastOnline",
  1983. "lastSubFetch",
  1984. "reset",
  1985. "resetCount",
  1986. "resetDay",
  1987. "resetMax",
  1988. "subId",
  1989. "total",
  1990. "up",
  1991. "uuid"
  1992. ],
  1993. "type": "object"
  1994. },
  1995. "ClientsSummary": {
  1996. "description": "ClientsSummary collects per-bucket counts plus the matching email lists so\nthe clients page can render the dashboard stat cards and their hover\npopovers without shipping the full client array. The counters are exact;\nthe lists stop at clientSummaryEmailCap entries and only back the popovers.",
  1997. "properties": {
  1998. "active": {
  1999. "example": 1850,
  2000. "type": "integer"
  2001. },
  2002. "deactive": {
  2003. "example": [
  2004. "[email protected]"
  2005. ],
  2006. "items": {
  2007. "type": "string"
  2008. },
  2009. "type": "array"
  2010. },
  2011. "deactiveCount": {
  2012. "example": 150,
  2013. "type": "integer"
  2014. },
  2015. "depleted": {
  2016. "example": [],
  2017. "items": {
  2018. "type": "string"
  2019. },
  2020. "type": "array"
  2021. },
  2022. "depletedCount": {
  2023. "example": 0,
  2024. "type": "integer"
  2025. },
  2026. "expiring": {
  2027. "example": [],
  2028. "items": {
  2029. "type": "string"
  2030. },
  2031. "type": "array"
  2032. },
  2033. "expiringCount": {
  2034. "example": 0,
  2035. "type": "integer"
  2036. },
  2037. "online": {
  2038. "example": [
  2039. "[email protected]"
  2040. ],
  2041. "items": {
  2042. "type": "string"
  2043. },
  2044. "type": "array"
  2045. },
  2046. "onlineCount": {
  2047. "example": 1,
  2048. "type": "integer"
  2049. },
  2050. "total": {
  2051. "example": 2000,
  2052. "type": "integer"
  2053. }
  2054. },
  2055. "required": [
  2056. "active",
  2057. "deactive",
  2058. "deactiveCount",
  2059. "depleted",
  2060. "depletedCount",
  2061. "expiring",
  2062. "expiringCount",
  2063. "online",
  2064. "onlineCount",
  2065. "total"
  2066. ],
  2067. "type": "object"
  2068. },
  2069. "FallbackParentInfo": {
  2070. "description": "FallbackParentInfo carries everything the frontend needs to rewrite a\nchild inbound's client link: where to connect (the master's address\nand port) and which path matched on the master's fallbacks array.\nThe frontend already has the master inbound in its dbInbounds list,\nso we only ship identifiers + the match path here.",
  2071. "properties": {
  2072. "masterId": {
  2073. "type": "integer"
  2074. },
  2075. "path": {
  2076. "type": "string"
  2077. }
  2078. },
  2079. "required": [
  2080. "masterId"
  2081. ],
  2082. "type": "object"
  2083. },
  2084. "GeoCategory": {
  2085. "description": "GeoCategory is one code inside a database, such as geosite's \"google\".",
  2086. "properties": {
  2087. "attributes": {
  2088. "example": [
  2089. "ads",
  2090. "cn"
  2091. ],
  2092. "items": {
  2093. "type": "string"
  2094. },
  2095. "type": "array"
  2096. },
  2097. "code": {
  2098. "example": "google",
  2099. "type": "string"
  2100. },
  2101. "entries": {
  2102. "example": 1284,
  2103. "type": "integer"
  2104. }
  2105. },
  2106. "required": [
  2107. "attributes",
  2108. "code",
  2109. "entries"
  2110. ],
  2111. "type": "object"
  2112. },
  2113. "GeoCategoryPage": {
  2114. "description": "GeoCategoryPage is one page of categories plus the unpaged total.",
  2115. "properties": {
  2116. "items": {
  2117. "items": {
  2118. "$ref": "#/components/schemas/GeoCategory"
  2119. },
  2120. "type": "array"
  2121. },
  2122. "total": {
  2123. "example": 1043,
  2124. "type": "integer"
  2125. }
  2126. },
  2127. "required": [
  2128. "items",
  2129. "total"
  2130. ],
  2131. "type": "object"
  2132. },
  2133. "GeoEntry": {
  2134. "description": "GeoEntry is a single rule inside a category: a domain rule for geosite\ndatabases, a CIDR for geoip ones.",
  2135. "properties": {
  2136. "kind": {
  2137. "example": "domain",
  2138. "type": "string"
  2139. },
  2140. "value": {
  2141. "example": "google.com",
  2142. "type": "string"
  2143. }
  2144. },
  2145. "required": [
  2146. "kind",
  2147. "value"
  2148. ],
  2149. "type": "object"
  2150. },
  2151. "GeoEntryPage": {
  2152. "description": "GeoEntryPage is one page of category entries plus the unpaged total.",
  2153. "properties": {
  2154. "items": {
  2155. "items": {
  2156. "$ref": "#/components/schemas/GeoEntry"
  2157. },
  2158. "type": "array"
  2159. },
  2160. "total": {
  2161. "example": 1284,
  2162. "type": "integer"
  2163. }
  2164. },
  2165. "required": [
  2166. "items",
  2167. "total"
  2168. ],
  2169. "type": "object"
  2170. },
  2171. "GeoFile": {
  2172. "description": "GeoFile describes one .dat database found in the asset directory.",
  2173. "properties": {
  2174. "categories": {
  2175. "example": 1043,
  2176. "type": "integer"
  2177. },
  2178. "error": {
  2179. "type": "string"
  2180. },
  2181. "kind": {
  2182. "example": "site",
  2183. "type": "string"
  2184. },
  2185. "modifiedAt": {
  2186. "example": 1769558400000,
  2187. "format": "int64",
  2188. "type": "integer"
  2189. },
  2190. "name": {
  2191. "example": "geosite.dat",
  2192. "type": "string"
  2193. },
  2194. "size": {
  2195. "example": 1467392,
  2196. "format": "int64",
  2197. "type": "integer"
  2198. }
  2199. },
  2200. "required": [
  2201. "categories",
  2202. "kind",
  2203. "modifiedAt",
  2204. "name",
  2205. "size"
  2206. ],
  2207. "type": "object"
  2208. },
  2209. "GeodataTokenIssue": {
  2210. "description": "GeodataTokenIssue reports a routing token the running core would reject,\nor would silently match nothing against.",
  2211. "properties": {
  2212. "code": {
  2213. "example": "blabla",
  2214. "type": "string"
  2215. },
  2216. "file": {
  2217. "example": "geosite.dat",
  2218. "type": "string"
  2219. },
  2220. "reason": {
  2221. "example": "categoryMissing",
  2222. "type": "string"
  2223. },
  2224. "token": {
  2225. "example": "geosite:blabla",
  2226. "type": "string"
  2227. }
  2228. },
  2229. "required": [
  2230. "reason",
  2231. "token"
  2232. ],
  2233. "type": "object"
  2234. },
  2235. "HappLinkResult": {
  2236. "properties": {
  2237. "encryptedLink": {
  2238. "example": "happ://crypt5/example",
  2239. "type": "string"
  2240. }
  2241. },
  2242. "required": [
  2243. "encryptedLink"
  2244. ],
  2245. "type": "object"
  2246. },
  2247. "HistoryOfSeeders": {
  2248. "description": "HistoryOfSeeders tracks which database seeders have been executed to prevent re-running.",
  2249. "properties": {
  2250. "id": {
  2251. "type": "integer"
  2252. },
  2253. "seederName": {
  2254. "type": "string"
  2255. }
  2256. },
  2257. "required": [
  2258. "id",
  2259. "seederName"
  2260. ],
  2261. "type": "object"
  2262. },
  2263. "Host": {
  2264. "properties": {
  2265. "address": {
  2266. "example": "cdn.example.com",
  2267. "type": "string"
  2268. },
  2269. "allowInsecure": {
  2270. "type": "boolean"
  2271. },
  2272. "alpn": {
  2273. "items": {
  2274. "type": "string"
  2275. },
  2276. "type": "array"
  2277. },
  2278. "cipherSuites": {
  2279. "type": "string"
  2280. },
  2281. "createdAt": {
  2282. "format": "int64",
  2283. "type": "integer"
  2284. },
  2285. "echConfigList": {
  2286. "type": "string"
  2287. },
  2288. "excludeFromSubTypes": {
  2289. "items": {
  2290. "type": "string"
  2291. },
  2292. "type": "array"
  2293. },
  2294. "finalMask": {
  2295. "description": "FinalMask is a JSON object of xray finalmask masks (tcp/udp/quicParams),\nmerged into this host's JSON-subscription stream. Empty = no override.",
  2296. "type": "string"
  2297. },
  2298. "fingerprint": {
  2299. "type": "string"
  2300. },
  2301. "groupId": {
  2302. "type": "string"
  2303. },
  2304. "hostHeader": {
  2305. "type": "string"
  2306. },
  2307. "id": {
  2308. "example": 1,
  2309. "type": "integer"
  2310. },
  2311. "inboundId": {
  2312. "example": 1,
  2313. "type": "integer"
  2314. },
  2315. "isDisabled": {
  2316. "type": "boolean"
  2317. },
  2318. "isHidden": {
  2319. "type": "boolean"
  2320. },
  2321. "keepSniBlank": {
  2322. "type": "boolean"
  2323. },
  2324. "mihomoIpVersion": {
  2325. "enum": [
  2326. "dual",
  2327. "ipv4",
  2328. "ipv6",
  2329. "ipv4-prefer",
  2330. "ipv6-prefer"
  2331. ],
  2332. "type": "string"
  2333. },
  2334. "mihomoX25519": {
  2335. "type": "boolean"
  2336. },
  2337. "muxParams": {},
  2338. "nodeGuids": {
  2339. "items": {
  2340. "type": "string"
  2341. },
  2342. "type": "array"
  2343. },
  2344. "overrideSniFromAddress": {
  2345. "type": "boolean"
  2346. },
  2347. "path": {
  2348. "type": "string"
  2349. },
  2350. "pinnedPeerCertSha256": {
  2351. "items": {
  2352. "type": "string"
  2353. },
  2354. "type": "array"
  2355. },
  2356. "port": {
  2357. "example": 8443,
  2358. "maximum": 65535,
  2359. "minimum": 0,
  2360. "type": "integer"
  2361. },
  2362. "remark": {
  2363. "example": "cdn-front",
  2364. "maxLength": 256,
  2365. "type": "string"
  2366. },
  2367. "security": {
  2368. "enum": [
  2369. "same",
  2370. "tls",
  2371. "none",
  2372. "reality"
  2373. ],
  2374. "example": "same",
  2375. "type": "string"
  2376. },
  2377. "serverDescription": {
  2378. "maxLength": 64,
  2379. "type": "string"
  2380. },
  2381. "shuffleHost": {
  2382. "type": "boolean"
  2383. },
  2384. "sni": {
  2385. "type": "string"
  2386. },
  2387. "sockoptParams": {},
  2388. "sortOrder": {
  2389. "type": "integer"
  2390. },
  2391. "tags": {
  2392. "items": {
  2393. "type": "string"
  2394. },
  2395. "type": "array"
  2396. },
  2397. "updatedAt": {
  2398. "format": "int64",
  2399. "type": "integer"
  2400. },
  2401. "verifyPeerCertByName": {
  2402. "type": "string"
  2403. },
  2404. "vlessRoute": {
  2405. "description": "Single VLESS route value (0-65535) baked into the subscription UUID's 3rd\ngroup (bytes 6-7), which xray reads via net.PortFromBytes(id[6:8]). Empty = none.",
  2406. "example": "443",
  2407. "type": "string"
  2408. }
  2409. },
  2410. "required": [
  2411. "address",
  2412. "allowInsecure",
  2413. "alpn",
  2414. "cipherSuites",
  2415. "createdAt",
  2416. "echConfigList",
  2417. "excludeFromSubTypes",
  2418. "finalMask",
  2419. "fingerprint",
  2420. "groupId",
  2421. "hostHeader",
  2422. "id",
  2423. "inboundId",
  2424. "isDisabled",
  2425. "isHidden",
  2426. "keepSniBlank",
  2427. "mihomoIpVersion",
  2428. "mihomoX25519",
  2429. "muxParams",
  2430. "overrideSniFromAddress",
  2431. "path",
  2432. "pinnedPeerCertSha256",
  2433. "port",
  2434. "remark",
  2435. "security",
  2436. "serverDescription",
  2437. "shuffleHost",
  2438. "sni",
  2439. "sockoptParams",
  2440. "sortOrder",
  2441. "tags",
  2442. "updatedAt",
  2443. "verifyPeerCertByName",
  2444. "vlessRoute"
  2445. ],
  2446. "type": "object"
  2447. },
  2448. "HostGroup": {
  2449. "properties": {
  2450. "allowInsecure": {
  2451. "type": "boolean"
  2452. },
  2453. "alpn": {
  2454. "items": {
  2455. "type": "string"
  2456. },
  2457. "type": "array"
  2458. },
  2459. "cipherSuites": {
  2460. "type": "string"
  2461. },
  2462. "echConfigList": {
  2463. "type": "string"
  2464. },
  2465. "excludeFromSubTypes": {
  2466. "items": {
  2467. "type": "string"
  2468. },
  2469. "type": "array"
  2470. },
  2471. "finalMask": {
  2472. "type": "string"
  2473. },
  2474. "fingerprint": {
  2475. "type": "string"
  2476. },
  2477. "groupId": {
  2478. "type": "string"
  2479. },
  2480. "hostHeader": {
  2481. "type": "string"
  2482. },
  2483. "hosts": {
  2484. "items": {
  2485. "type": "string"
  2486. },
  2487. "type": "array"
  2488. },
  2489. "inboundIds": {
  2490. "items": {
  2491. "type": "integer"
  2492. },
  2493. "type": "array"
  2494. },
  2495. "isDisabled": {
  2496. "type": "boolean"
  2497. },
  2498. "isHidden": {
  2499. "type": "boolean"
  2500. },
  2501. "keepSniBlank": {
  2502. "type": "boolean"
  2503. },
  2504. "mihomoIpVersion": {
  2505. "enum": [
  2506. "dual",
  2507. "ipv4",
  2508. "ipv6",
  2509. "ipv4-prefer",
  2510. "ipv6-prefer"
  2511. ],
  2512. "type": "string"
  2513. },
  2514. "mihomoX25519": {
  2515. "type": "boolean"
  2516. },
  2517. "muxParams": {
  2518. "type": "string"
  2519. },
  2520. "nodeGuids": {
  2521. "items": {
  2522. "type": "string"
  2523. },
  2524. "type": "array"
  2525. },
  2526. "overrideSniFromAddress": {
  2527. "type": "boolean"
  2528. },
  2529. "path": {
  2530. "type": "string"
  2531. },
  2532. "pinnedPeerCertSha256": {
  2533. "items": {
  2534. "type": "string"
  2535. },
  2536. "type": "array"
  2537. },
  2538. "port": {
  2539. "maximum": 65535,
  2540. "minimum": 0,
  2541. "type": "integer"
  2542. },
  2543. "remark": {
  2544. "maxLength": 256,
  2545. "type": "string"
  2546. },
  2547. "security": {
  2548. "enum": [
  2549. "same",
  2550. "tls",
  2551. "none",
  2552. "reality"
  2553. ],
  2554. "type": "string"
  2555. },
  2556. "serverDescription": {
  2557. "maxLength": 64,
  2558. "type": "string"
  2559. },
  2560. "shuffleHost": {
  2561. "type": "boolean"
  2562. },
  2563. "sni": {
  2564. "type": "string"
  2565. },
  2566. "sockoptParams": {
  2567. "type": "string"
  2568. },
  2569. "sortOrder": {
  2570. "type": "integer"
  2571. },
  2572. "tags": {
  2573. "items": {
  2574. "type": "string"
  2575. },
  2576. "type": "array"
  2577. },
  2578. "verifyPeerCertByName": {
  2579. "type": "string"
  2580. },
  2581. "vlessRoute": {
  2582. "type": "string"
  2583. }
  2584. },
  2585. "required": [
  2586. "allowInsecure",
  2587. "alpn",
  2588. "cipherSuites",
  2589. "echConfigList",
  2590. "excludeFromSubTypes",
  2591. "finalMask",
  2592. "fingerprint",
  2593. "groupId",
  2594. "hostHeader",
  2595. "hosts",
  2596. "inboundIds",
  2597. "isDisabled",
  2598. "isHidden",
  2599. "keepSniBlank",
  2600. "mihomoIpVersion",
  2601. "mihomoX25519",
  2602. "muxParams",
  2603. "nodeGuids",
  2604. "overrideSniFromAddress",
  2605. "path",
  2606. "pinnedPeerCertSha256",
  2607. "port",
  2608. "remark",
  2609. "security",
  2610. "serverDescription",
  2611. "shuffleHost",
  2612. "sni",
  2613. "sockoptParams",
  2614. "sortOrder",
  2615. "tags",
  2616. "verifyPeerCertByName",
  2617. "vlessRoute"
  2618. ],
  2619. "type": "object"
  2620. },
  2621. "HwidSlotStatus": {
  2622. "description": "HwidSlotStatus is the aggregate device-slot view exposed to subscribers:\ncounters only, no hwid value or hash, no email, no device metadata.",
  2623. "properties": {
  2624. "active": {
  2625. "example": true,
  2626. "type": "boolean"
  2627. },
  2628. "full": {
  2629. "example": false,
  2630. "type": "boolean"
  2631. },
  2632. "limit": {
  2633. "example": 2,
  2634. "type": "integer"
  2635. },
  2636. "registered": {
  2637. "example": 1,
  2638. "type": "integer"
  2639. },
  2640. "remaining": {
  2641. "example": 1,
  2642. "type": "integer"
  2643. }
  2644. },
  2645. "required": [
  2646. "active",
  2647. "full",
  2648. "limit",
  2649. "registered",
  2650. "remaining"
  2651. ],
  2652. "type": "object"
  2653. },
  2654. "Inbound": {
  2655. "description": "Inbound represents an Xray inbound configuration with traffic statistics and settings.",
  2656. "properties": {
  2657. "clientStats": {
  2658. "description": "Client traffic statistics",
  2659. "items": {
  2660. "$ref": "#/components/schemas/ClientTraffic"
  2661. },
  2662. "type": "array"
  2663. },
  2664. "disableFlow": {
  2665. "example": false,
  2666. "type": "boolean"
  2667. },
  2668. "down": {
  2669. "description": "Download traffic in bytes",
  2670. "format": "int64",
  2671. "type": "integer"
  2672. },
  2673. "enable": {
  2674. "description": "Whether the inbound is enabled",
  2675. "example": true,
  2676. "type": "boolean"
  2677. },
  2678. "expiryTime": {
  2679. "description": "Expiration timestamp",
  2680. "format": "int64",
  2681. "type": "integer"
  2682. },
  2683. "fallbackParent": {
  2684. "allOf": [
  2685. {
  2686. "$ref": "#/components/schemas/FallbackParentInfo"
  2687. }
  2688. ],
  2689. "description": "FallbackParent is populated by the API layer when this inbound is\nattached as a fallback child of a VLESS/Trojan TCP-TLS master.\nThe frontend uses it to rewrite client-share links so they advertise\nthe master's externally reachable endpoint instead of the child's\nloopback listen. Not persisted.",
  2690. "nullable": true
  2691. },
  2692. "id": {
  2693. "description": "Unique identifier",
  2694. "example": 1,
  2695. "type": "integer"
  2696. },
  2697. "lastTrafficResetTime": {
  2698. "description": "Last traffic reset timestamp",
  2699. "format": "int64",
  2700. "type": "integer"
  2701. },
  2702. "listen": {
  2703. "description": "Xray configuration fields",
  2704. "type": "string"
  2705. },
  2706. "nodeId": {
  2707. "nullable": true,
  2708. "type": "integer"
  2709. },
  2710. "originNodeGuid": {
  2711. "description": "OriginNodeGuid is the panelGuid of the node that physically hosts this\ninbound, propagated up across hops (#4983). Empty for an inbound that\nlives on this panel's own xray; set to the originating node's GUID when\nthe inbound was synced from a node (kept as-is across further hops). Lets\nthe master attribute a deeply nested inbound to the real node instead of\nthe intermediate one it was fetched through.",
  2712. "type": "string"
  2713. },
  2714. "port": {
  2715. "example": 443,
  2716. "maximum": 65535,
  2717. "minimum": 0,
  2718. "type": "integer"
  2719. },
  2720. "protocol": {
  2721. "enum": [
  2722. "vmess",
  2723. "vless",
  2724. "trojan",
  2725. "shadowsocks",
  2726. "wireguard",
  2727. "hysteria",
  2728. "http",
  2729. "mixed",
  2730. "tunnel",
  2731. "tun",
  2732. "mtproto",
  2733. "amneziawg",
  2734. "tuic"
  2735. ],
  2736. "example": "vless",
  2737. "type": "string"
  2738. },
  2739. "remark": {
  2740. "description": "Human-readable remark",
  2741. "example": "VLESS-443",
  2742. "type": "string"
  2743. },
  2744. "settings": {},
  2745. "shareAddr": {
  2746. "type": "string"
  2747. },
  2748. "shareAddrStrategy": {
  2749. "enum": [
  2750. "node",
  2751. "listen",
  2752. "custom"
  2753. ],
  2754. "type": "string"
  2755. },
  2756. "sniffing": {},
  2757. "streamSettings": {},
  2758. "subSortIndex": {
  2759. "description": "Sort order of this inbound's links in subscription output only (lower first; negatives allowed; 0/omitted → 1; ties by id)",
  2760. "example": 1,
  2761. "type": "integer"
  2762. },
  2763. "tag": {
  2764. "example": "in-443-tcp",
  2765. "type": "string"
  2766. },
  2767. "total": {
  2768. "description": "Total traffic limit in bytes",
  2769. "format": "int64",
  2770. "type": "integer"
  2771. },
  2772. "trafficReset": {
  2773. "description": "Traffic reset schedule",
  2774. "enum": [
  2775. "never",
  2776. "hourly",
  2777. "daily",
  2778. "weekly",
  2779. "monthly"
  2780. ],
  2781. "type": "string"
  2782. },
  2783. "trafficResetDay": {
  2784. "description": "Day of month for monthly traffic resets",
  2785. "example": 1,
  2786. "maximum": 31,
  2787. "minimum": 1,
  2788. "type": "integer"
  2789. },
  2790. "up": {
  2791. "description": "Upload traffic in bytes",
  2792. "format": "int64",
  2793. "type": "integer"
  2794. }
  2795. },
  2796. "required": [
  2797. "clientStats",
  2798. "disableFlow",
  2799. "down",
  2800. "enable",
  2801. "expiryTime",
  2802. "id",
  2803. "lastTrafficResetTime",
  2804. "listen",
  2805. "port",
  2806. "protocol",
  2807. "remark",
  2808. "settings",
  2809. "shareAddr",
  2810. "shareAddrStrategy",
  2811. "sniffing",
  2812. "streamSettings",
  2813. "subSortIndex",
  2814. "tag",
  2815. "total",
  2816. "trafficReset",
  2817. "trafficResetDay",
  2818. "up"
  2819. ],
  2820. "type": "object"
  2821. },
  2822. "InboundClientIps": {
  2823. "description": "InboundClientIps stores IP addresses associated with inbound clients for access control.",
  2824. "properties": {
  2825. "clientEmail": {
  2826. "type": "string"
  2827. },
  2828. "id": {
  2829. "type": "integer"
  2830. },
  2831. "ips": {}
  2832. },
  2833. "required": [
  2834. "clientEmail",
  2835. "id",
  2836. "ips"
  2837. ],
  2838. "type": "object"
  2839. },
  2840. "InboundFallback": {
  2841. "properties": {
  2842. "alpn": {
  2843. "type": "string"
  2844. },
  2845. "childId": {
  2846. "type": "integer"
  2847. },
  2848. "dest": {
  2849. "type": "string"
  2850. },
  2851. "id": {
  2852. "type": "integer"
  2853. },
  2854. "masterId": {
  2855. "type": "integer"
  2856. },
  2857. "name": {
  2858. "type": "string"
  2859. },
  2860. "path": {
  2861. "type": "string"
  2862. },
  2863. "sortOrder": {
  2864. "type": "integer"
  2865. },
  2866. "xver": {
  2867. "type": "integer"
  2868. }
  2869. },
  2870. "required": [
  2871. "alpn",
  2872. "childId",
  2873. "dest",
  2874. "id",
  2875. "masterId",
  2876. "name",
  2877. "path",
  2878. "sortOrder",
  2879. "xver"
  2880. ],
  2881. "type": "object"
  2882. },
  2883. "InboundOption": {
  2884. "properties": {
  2885. "awgServer": {
  2886. "allOf": [
  2887. {
  2888. "$ref": "#/components/schemas/ServerSettings"
  2889. }
  2890. ],
  2891. "description": "AwgServer carries the full AmneziaWG server block (keys, subnet,\nobfuscation params) so the clients page can render a downloadable\nper-client .conf without a second round trip.",
  2892. "nullable": true
  2893. },
  2894. "enable": {
  2895. "example": true,
  2896. "type": "boolean"
  2897. },
  2898. "id": {
  2899. "example": 1,
  2900. "type": "integer"
  2901. },
  2902. "listen": {
  2903. "type": "string"
  2904. },
  2905. "mtprotoDomain": {
  2906. "type": "string"
  2907. },
  2908. "network": {
  2909. "type": "string"
  2910. },
  2911. "nodeAddress": {
  2912. "description": "Share-host resolution inputs, mirroring the subscription's\nresolveInboundAddress so the clients page renders a node-managed WireGuard\nEndpoint that points at the node, not the master panel. NodeAddress is the\nhosting node's externally reachable address (empty for this panel's own\ninbounds); Listen and ShareAddrStrategy/ShareAddr feed the same\nnode→listen→custom fallback the share/QR links already use.",
  2913. "type": "string"
  2914. },
  2915. "nodeId": {
  2916. "description": "Hosting node; nil for this panel's own inbounds. Lets the clients\npage map a node filter onto inbound IDs (#4997).",
  2917. "nullable": true,
  2918. "type": "integer"
  2919. },
  2920. "port": {
  2921. "example": 443,
  2922. "type": "integer"
  2923. },
  2924. "protocol": {
  2925. "example": "vless",
  2926. "type": "string"
  2927. },
  2928. "remark": {
  2929. "example": "VLESS-443",
  2930. "type": "string"
  2931. },
  2932. "security": {
  2933. "type": "string"
  2934. },
  2935. "shareAddr": {
  2936. "type": "string"
  2937. },
  2938. "shareAddrStrategy": {
  2939. "type": "string"
  2940. },
  2941. "ssMethod": {
  2942. "type": "string"
  2943. },
  2944. "tag": {
  2945. "example": "in-443-tcp",
  2946. "type": "string"
  2947. },
  2948. "tlsFlowCapable": {
  2949. "example": true,
  2950. "type": "boolean"
  2951. },
  2952. "tuicServer": {
  2953. "allOf": [
  2954. {
  2955. "$ref": "#/components/schemas/TuicServerSettings"
  2956. }
  2957. ],
  2958. "nullable": true
  2959. },
  2960. "wgDns": {
  2961. "type": "string"
  2962. },
  2963. "wgMtu": {
  2964. "type": "integer"
  2965. },
  2966. "wgPublicKey": {
  2967. "type": "string"
  2968. }
  2969. },
  2970. "required": [
  2971. "enable",
  2972. "id",
  2973. "port",
  2974. "protocol",
  2975. "remark",
  2976. "ssMethod",
  2977. "tag",
  2978. "tlsFlowCapable"
  2979. ],
  2980. "type": "object"
  2981. },
  2982. "InboundTrafficSummary": {
  2983. "properties": {
  2984. "down": {
  2985. "example": 2097152,
  2986. "format": "int64",
  2987. "type": "integer"
  2988. },
  2989. "enable": {
  2990. "example": true,
  2991. "type": "boolean"
  2992. },
  2993. "id": {
  2994. "example": 1,
  2995. "type": "integer"
  2996. },
  2997. "total": {
  2998. "example": 10737418240,
  2999. "format": "int64",
  3000. "type": "integer"
  3001. },
  3002. "up": {
  3003. "example": 1048576,
  3004. "format": "int64",
  3005. "type": "integer"
  3006. }
  3007. },
  3008. "required": [
  3009. "down",
  3010. "enable",
  3011. "id",
  3012. "total",
  3013. "up"
  3014. ],
  3015. "type": "object"
  3016. },
  3017. "LogEntry": {
  3018. "properties": {
  3019. "DateTime": {
  3020. "example": "2025-01-01T12:00:00Z",
  3021. "format": "date-time",
  3022. "type": "string"
  3023. },
  3024. "Email": {
  3025. "example": "[email protected]",
  3026. "type": "string"
  3027. },
  3028. "Event": {
  3029. "example": 0,
  3030. "type": "integer"
  3031. },
  3032. "FromAddress": {
  3033. "example": "192.0.2.10:54321",
  3034. "type": "string"
  3035. },
  3036. "Inbound": {
  3037. "example": "inbound-443",
  3038. "type": "string"
  3039. },
  3040. "Outbound": {
  3041. "example": "direct",
  3042. "type": "string"
  3043. },
  3044. "ToAddress": {
  3045. "example": "example.com:443",
  3046. "type": "string"
  3047. }
  3048. },
  3049. "required": [
  3050. "DateTime",
  3051. "Email",
  3052. "Event",
  3053. "FromAddress",
  3054. "Inbound",
  3055. "Outbound",
  3056. "ToAddress"
  3057. ],
  3058. "type": "object"
  3059. },
  3060. "MLDSA65Response": {
  3061. "properties": {
  3062. "seed": {
  3063. "example": "mldsa65-seed",
  3064. "type": "string"
  3065. },
  3066. "verify": {
  3067. "example": "mldsa65-verify",
  3068. "type": "string"
  3069. }
  3070. },
  3071. "required": [
  3072. "seed",
  3073. "verify"
  3074. ],
  3075. "type": "object"
  3076. },
  3077. "MLKEM768Response": {
  3078. "properties": {
  3079. "client": {
  3080. "example": "mlkem768-client",
  3081. "type": "string"
  3082. },
  3083. "seed": {
  3084. "example": "mlkem768-seed",
  3085. "type": "string"
  3086. }
  3087. },
  3088. "required": [
  3089. "client",
  3090. "seed"
  3091. ],
  3092. "type": "object"
  3093. },
  3094. "Msg": {
  3095. "properties": {
  3096. "msg": {
  3097. "type": "string"
  3098. },
  3099. "obj": {},
  3100. "success": {
  3101. "type": "boolean"
  3102. }
  3103. },
  3104. "required": [
  3105. "msg",
  3106. "obj",
  3107. "success"
  3108. ],
  3109. "type": "object"
  3110. },
  3111. "NewUUIDResponse": {
  3112. "properties": {
  3113. "uuid": {
  3114. "example": "550e8400-e29b-41d4-a716-446655440000",
  3115. "type": "string"
  3116. }
  3117. },
  3118. "required": [
  3119. "uuid"
  3120. ],
  3121. "type": "object"
  3122. },
  3123. "Node": {
  3124. "description": "Node represents a remote 3x-ui panel registered with the central panel.\nThe central panel polls each node's existing /panel/api/server/status\nendpoint over HTTP using the per-node ApiToken to populate the runtime\nstatus fields below.",
  3125. "properties": {
  3126. "activeCount": {
  3127. "example": 23,
  3128. "type": "integer"
  3129. },
  3130. "address": {
  3131. "example": "node1.example.com",
  3132. "type": "string"
  3133. },
  3134. "allowPrivateAddress": {
  3135. "type": "boolean"
  3136. },
  3137. "basePath": {
  3138. "example": "/",
  3139. "type": "string"
  3140. },
  3141. "clientCount": {
  3142. "example": 27,
  3143. "type": "integer"
  3144. },
  3145. "configDirty": {
  3146. "type": "boolean"
  3147. },
  3148. "configDirtyAt": {
  3149. "format": "int64",
  3150. "type": "integer"
  3151. },
  3152. "cpuPct": {
  3153. "example": 23.5,
  3154. "type": "number"
  3155. },
  3156. "createdAt": {
  3157. "example": 1700000000,
  3158. "format": "int64",
  3159. "type": "integer"
  3160. },
  3161. "depletedCount": {
  3162. "example": 1,
  3163. "type": "integer"
  3164. },
  3165. "disabledCount": {
  3166. "example": 3,
  3167. "type": "integer"
  3168. },
  3169. "enable": {
  3170. "example": true,
  3171. "type": "boolean"
  3172. },
  3173. "guid": {
  3174. "description": "Guid is the remote panel's stable self-identifier (its panelGuid),\nlearned from each heartbeat. It is the globally stable node identity used\nto attribute online clients/inbounds to the physical node across a chain\nof nodes (#4983); panel-local autoincrement ids don't survive a hop.\nObserved-state only — never user-edited.",
  3175. "type": "string"
  3176. },
  3177. "id": {
  3178. "example": 1,
  3179. "type": "integer"
  3180. },
  3181. "inboundCount": {
  3182. "example": 5,
  3183. "type": "integer"
  3184. },
  3185. "inboundSyncMode": {
  3186. "enum": [
  3187. "all",
  3188. "selected"
  3189. ],
  3190. "type": "string"
  3191. },
  3192. "inboundTags": {
  3193. "items": {
  3194. "type": "string"
  3195. },
  3196. "type": "array"
  3197. },
  3198. "lastError": {
  3199. "type": "string"
  3200. },
  3201. "lastHeartbeat": {
  3202. "description": "unix seconds, 0 = never",
  3203. "example": 1700000000,
  3204. "format": "int64",
  3205. "type": "integer"
  3206. },
  3207. "latencyMs": {
  3208. "example": 42,
  3209. "type": "integer"
  3210. },
  3211. "memPct": {
  3212. "example": 45.1,
  3213. "type": "number"
  3214. },
  3215. "name": {
  3216. "example": "de-fra-1",
  3217. "type": "string"
  3218. },
  3219. "netDown": {
  3220. "example": 2097152,
  3221. "format": "int64",
  3222. "type": "integer"
  3223. },
  3224. "netUp": {
  3225. "example": 1048576,
  3226. "format": "int64",
  3227. "type": "integer"
  3228. },
  3229. "onlineCount": {
  3230. "example": 3,
  3231. "type": "integer"
  3232. },
  3233. "outboundTag": {
  3234. "type": "string"
  3235. },
  3236. "panelVersion": {
  3237. "example": "v3.x.x",
  3238. "type": "string"
  3239. },
  3240. "parentGuid": {
  3241. "description": "ParentGuid + Transitive are set only when a node is surfaced as part of a\nnode tree (#4983): direct nodes carry the master panel's own GUID, a\ntransitive sub-node carries its parent node's GUID. Transitive nodes are\nread-only projections (Id == 0, not persisted) — never edited or deployed.",
  3242. "type": "string"
  3243. },
  3244. "pinnedCertSha256": {
  3245. "type": "string"
  3246. },
  3247. "port": {
  3248. "example": 2053,
  3249. "maximum": 65535,
  3250. "minimum": 1,
  3251. "type": "integer"
  3252. },
  3253. "remark": {
  3254. "type": "string"
  3255. },
  3256. "scheme": {
  3257. "enum": [
  3258. "http",
  3259. "https"
  3260. ],
  3261. "example": "https",
  3262. "type": "string"
  3263. },
  3264. "status": {
  3265. "description": "Heartbeat-updated fields. UpdatedAt advances on every probe even when\nthe row is otherwise unchanged so the UI's \"last seen\" tooltip is\ntruthful without us having to read LastHeartbeat separately.\nonline|offline|unknown",
  3266. "example": "online",
  3267. "type": "string"
  3268. },
  3269. "tlsVerifyMode": {
  3270. "enum": [
  3271. "verify",
  3272. "skip",
  3273. "pin",
  3274. "mtls"
  3275. ],
  3276. "type": "string"
  3277. },
  3278. "transitive": {
  3279. "type": "boolean"
  3280. },
  3281. "updatedAt": {
  3282. "example": 1700000000,
  3283. "format": "int64",
  3284. "type": "integer"
  3285. },
  3286. "uptimeSecs": {
  3287. "example": 86400,
  3288. "format": "int64",
  3289. "type": "integer"
  3290. },
  3291. "xrayError": {
  3292. "type": "string"
  3293. },
  3294. "xrayState": {
  3295. "description": "XrayState and XrayError are captured from the remote node's /panel/api/server/status\nduring heartbeats. They let the central panel distinguish \"panel API reachable\"\n(status=online) from \"Xray core itself has failed on the node\" for monitoring.",
  3296. "type": "string"
  3297. },
  3298. "xrayVersion": {
  3299. "example": "25.10.31",
  3300. "type": "string"
  3301. }
  3302. },
  3303. "required": [
  3304. "activeCount",
  3305. "address",
  3306. "allowPrivateAddress",
  3307. "basePath",
  3308. "clientCount",
  3309. "configDirty",
  3310. "configDirtyAt",
  3311. "cpuPct",
  3312. "createdAt",
  3313. "depletedCount",
  3314. "disabledCount",
  3315. "enable",
  3316. "guid",
  3317. "id",
  3318. "inboundCount",
  3319. "inboundSyncMode",
  3320. "inboundTags",
  3321. "lastError",
  3322. "lastHeartbeat",
  3323. "latencyMs",
  3324. "memPct",
  3325. "name",
  3326. "netDown",
  3327. "netUp",
  3328. "onlineCount",
  3329. "outboundTag",
  3330. "panelVersion",
  3331. "pinnedCertSha256",
  3332. "port",
  3333. "remark",
  3334. "scheme",
  3335. "status",
  3336. "tlsVerifyMode",
  3337. "updatedAt",
  3338. "uptimeSecs",
  3339. "xrayError",
  3340. "xrayState",
  3341. "xrayVersion"
  3342. ],
  3343. "type": "object"
  3344. },
  3345. "NodeMutationRequest": {
  3346. "description": "NodeMutationRequest is the node write/probe contract. ApiToken is accepted\nonly as input. On update, nil means keep the stored token; replacement and\nclearing are explicit and mutually exclusive.",
  3347. "properties": {
  3348. "address": {
  3349. "type": "string"
  3350. },
  3351. "allowPrivateAddress": {
  3352. "type": "boolean"
  3353. },
  3354. "apiToken": {
  3355. "nullable": true,
  3356. "type": "string"
  3357. },
  3358. "basePath": {
  3359. "type": "string"
  3360. },
  3361. "clearApiToken": {
  3362. "type": "boolean"
  3363. },
  3364. "enable": {
  3365. "type": "boolean"
  3366. },
  3367. "id": {
  3368. "type": "integer"
  3369. },
  3370. "inboundSyncMode": {
  3371. "enum": [
  3372. "all",
  3373. "selected"
  3374. ],
  3375. "type": "string"
  3376. },
  3377. "inboundTags": {
  3378. "items": {
  3379. "type": "string"
  3380. },
  3381. "type": "array"
  3382. },
  3383. "name": {
  3384. "type": "string"
  3385. },
  3386. "outboundTag": {
  3387. "type": "string"
  3388. },
  3389. "pinnedCertSha256": {
  3390. "type": "string"
  3391. },
  3392. "port": {
  3393. "maximum": 65535,
  3394. "minimum": 1,
  3395. "type": "integer"
  3396. },
  3397. "remark": {
  3398. "type": "string"
  3399. },
  3400. "scheme": {
  3401. "enum": [
  3402. "http",
  3403. "https"
  3404. ],
  3405. "type": "string"
  3406. },
  3407. "tlsVerifyMode": {
  3408. "enum": [
  3409. "verify",
  3410. "skip",
  3411. "pin",
  3412. "mtls"
  3413. ],
  3414. "type": "string"
  3415. }
  3416. },
  3417. "required": [
  3418. "address",
  3419. "allowPrivateAddress",
  3420. "basePath",
  3421. "enable",
  3422. "id",
  3423. "inboundSyncMode",
  3424. "inboundTags",
  3425. "name",
  3426. "outboundTag",
  3427. "pinnedCertSha256",
  3428. "port",
  3429. "remark",
  3430. "scheme",
  3431. "tlsVerifyMode"
  3432. ],
  3433. "type": "object"
  3434. },
  3435. "NodeView": {
  3436. "description": "NodeView is the browser/API read contract for nodes. Credentials are\nwrite-only: responses expose only whether a node has a token configured.",
  3437. "properties": {
  3438. "activeCount": {
  3439. "example": 20,
  3440. "type": "integer"
  3441. },
  3442. "address": {
  3443. "example": "node.example.com",
  3444. "type": "string"
  3445. },
  3446. "allowPrivateAddress": {
  3447. "example": false,
  3448. "type": "boolean"
  3449. },
  3450. "basePath": {
  3451. "example": "/",
  3452. "type": "string"
  3453. },
  3454. "clientCount": {
  3455. "example": 25,
  3456. "type": "integer"
  3457. },
  3458. "configDirty": {
  3459. "example": false,
  3460. "type": "boolean"
  3461. },
  3462. "configDirtyAt": {
  3463. "example": 0,
  3464. "format": "int64",
  3465. "type": "integer"
  3466. },
  3467. "cpuPct": {
  3468. "example": 12.5,
  3469. "type": "number"
  3470. },
  3471. "createdAt": {
  3472. "example": 1700000000,
  3473. "format": "int64",
  3474. "type": "integer"
  3475. },
  3476. "depletedCount": {
  3477. "example": 1,
  3478. "type": "integer"
  3479. },
  3480. "disabledCount": {
  3481. "example": 2,
  3482. "type": "integer"
  3483. },
  3484. "enable": {
  3485. "example": true,
  3486. "type": "boolean"
  3487. },
  3488. "guid": {
  3489. "example": "node-guid",
  3490. "type": "string"
  3491. },
  3492. "hasApiToken": {
  3493. "example": true,
  3494. "type": "boolean"
  3495. },
  3496. "id": {
  3497. "example": 1,
  3498. "type": "integer"
  3499. },
  3500. "inboundCount": {
  3501. "example": 3,
  3502. "type": "integer"
  3503. },
  3504. "inboundSyncMode": {
  3505. "example": "all",
  3506. "type": "string"
  3507. },
  3508. "inboundTags": {
  3509. "example": [
  3510. "in-443-tcp"
  3511. ],
  3512. "items": {
  3513. "type": "string"
  3514. },
  3515. "type": "array"
  3516. },
  3517. "lastError": {
  3518. "type": "string"
  3519. },
  3520. "lastHeartbeat": {
  3521. "example": 1700000000,
  3522. "format": "int64",
  3523. "type": "integer"
  3524. },
  3525. "latencyMs": {
  3526. "example": 42,
  3527. "type": "integer"
  3528. },
  3529. "memPct": {
  3530. "example": 45.2,
  3531. "type": "number"
  3532. },
  3533. "name": {
  3534. "example": "edge-1",
  3535. "type": "string"
  3536. },
  3537. "netDown": {
  3538. "example": 1048576,
  3539. "format": "int64",
  3540. "type": "integer"
  3541. },
  3542. "netUp": {
  3543. "example": 2097152,
  3544. "format": "int64",
  3545. "type": "integer"
  3546. },
  3547. "onlineCount": {
  3548. "example": 5,
  3549. "type": "integer"
  3550. },
  3551. "outboundTag": {
  3552. "example": "direct",
  3553. "type": "string"
  3554. },
  3555. "panelVersion": {
  3556. "example": "v3.x.x",
  3557. "type": "string"
  3558. },
  3559. "parentGuid": {
  3560. "type": "string"
  3561. },
  3562. "pinnedCertSha256": {
  3563. "type": "string"
  3564. },
  3565. "port": {
  3566. "example": 2053,
  3567. "type": "integer"
  3568. },
  3569. "remark": {
  3570. "example": "Primary edge",
  3571. "type": "string"
  3572. },
  3573. "scheme": {
  3574. "example": "https",
  3575. "type": "string"
  3576. },
  3577. "status": {
  3578. "example": "online",
  3579. "type": "string"
  3580. },
  3581. "tlsVerifyMode": {
  3582. "example": "verify",
  3583. "type": "string"
  3584. },
  3585. "transitive": {
  3586. "example": false,
  3587. "type": "boolean"
  3588. },
  3589. "updatedAt": {
  3590. "example": 1700003600,
  3591. "format": "int64",
  3592. "type": "integer"
  3593. },
  3594. "uptimeSecs": {
  3595. "example": 86400,
  3596. "format": "int64",
  3597. "type": "integer"
  3598. },
  3599. "xrayError": {
  3600. "type": "string"
  3601. },
  3602. "xrayState": {
  3603. "example": "running",
  3604. "type": "string"
  3605. },
  3606. "xrayVersion": {
  3607. "example": "25.10.31",
  3608. "type": "string"
  3609. }
  3610. },
  3611. "required": [
  3612. "activeCount",
  3613. "address",
  3614. "allowPrivateAddress",
  3615. "basePath",
  3616. "clientCount",
  3617. "configDirty",
  3618. "configDirtyAt",
  3619. "cpuPct",
  3620. "createdAt",
  3621. "depletedCount",
  3622. "disabledCount",
  3623. "enable",
  3624. "guid",
  3625. "hasApiToken",
  3626. "id",
  3627. "inboundCount",
  3628. "inboundSyncMode",
  3629. "inboundTags",
  3630. "lastError",
  3631. "lastHeartbeat",
  3632. "latencyMs",
  3633. "memPct",
  3634. "name",
  3635. "netDown",
  3636. "netUp",
  3637. "onlineCount",
  3638. "outboundTag",
  3639. "panelVersion",
  3640. "pinnedCertSha256",
  3641. "port",
  3642. "remark",
  3643. "scheme",
  3644. "status",
  3645. "tlsVerifyMode",
  3646. "updatedAt",
  3647. "uptimeSecs",
  3648. "xrayError",
  3649. "xrayState",
  3650. "xrayVersion"
  3651. ],
  3652. "type": "object"
  3653. },
  3654. "OutboundTraffics": {
  3655. "description": "OutboundTraffics tracks traffic statistics for Xray outbound connections.",
  3656. "properties": {
  3657. "down": {
  3658. "format": "int64",
  3659. "type": "integer"
  3660. },
  3661. "id": {
  3662. "type": "integer"
  3663. },
  3664. "tag": {
  3665. "type": "string"
  3666. },
  3667. "total": {
  3668. "format": "int64",
  3669. "type": "integer"
  3670. },
  3671. "up": {
  3672. "format": "int64",
  3673. "type": "integer"
  3674. }
  3675. },
  3676. "required": [
  3677. "down",
  3678. "id",
  3679. "tag",
  3680. "total",
  3681. "up"
  3682. ],
  3683. "type": "object"
  3684. },
  3685. "PanelUpdateStatus": {
  3686. "description": "PanelUpdateStatus reports the outcome of the most recently launched panel\nself-update. RunID lets the caller confirm this status belongs to the\nupdate it started rather than a stale result left over from an earlier\nrun; State is one of \"pending\", \"success\", or \"failed\". RunID is a decimal\nstring, not a JSON number: it's a formatted UnixNano timestamp, and\nJavaScript's number type can't represent that precisely (it exceeds\nNumber.MAX_SAFE_INTEGER), which would let two different runs round to the\nsame value on the wire and defeat the whole point of this field.",
  3687. "properties": {
  3688. "exitCode": {
  3689. "example": 0,
  3690. "type": "integer"
  3691. },
  3692. "finishedAt": {
  3693. "example": 1735689612,
  3694. "format": "int64",
  3695. "type": "integer"
  3696. },
  3697. "runId": {
  3698. "example": "1735689600123456789",
  3699. "type": "string"
  3700. },
  3701. "state": {
  3702. "example": "success",
  3703. "type": "string"
  3704. }
  3705. },
  3706. "required": [
  3707. "exitCode",
  3708. "finishedAt",
  3709. "runId",
  3710. "state"
  3711. ],
  3712. "type": "object"
  3713. },
  3714. "PeerActivity": {
  3715. "description": "PeerActivity is one peer's live embedded-Device-reported state, the\ncounterpart of an Xray access-log entry: a tunnel logs no requests, only\nhandshakes and bytes.",
  3716. "properties": {
  3717. "allowedIPs": {
  3718. "example": "10.8.1.2/32",
  3719. "type": "string"
  3720. },
  3721. "down": {
  3722. "example": 4194304,
  3723. "format": "int64",
  3724. "type": "integer"
  3725. },
  3726. "email": {
  3727. "example": "[email protected]",
  3728. "type": "string"
  3729. },
  3730. "endpoint": {
  3731. "example": "203.0.113.9:51820",
  3732. "type": "string"
  3733. },
  3734. "handshake": {
  3735. "description": "Handshake is unix milliseconds, 0 when the peer has never connected.",
  3736. "example": 1735732800000,
  3737. "format": "int64",
  3738. "type": "integer"
  3739. },
  3740. "inboundId": {
  3741. "example": 1,
  3742. "type": "integer"
  3743. },
  3744. "interface": {
  3745. "example": "awg1",
  3746. "type": "string"
  3747. },
  3748. "online": {
  3749. "example": true,
  3750. "type": "boolean"
  3751. },
  3752. "tag": {
  3753. "example": "inbound-51820",
  3754. "type": "string"
  3755. },
  3756. "up": {
  3757. "example": 1048576,
  3758. "format": "int64",
  3759. "type": "integer"
  3760. }
  3761. },
  3762. "required": [
  3763. "allowedIPs",
  3764. "down",
  3765. "email",
  3766. "endpoint",
  3767. "handshake",
  3768. "inboundId",
  3769. "interface",
  3770. "online",
  3771. "tag",
  3772. "up"
  3773. ],
  3774. "type": "object"
  3775. },
  3776. "ProbeResultUI": {
  3777. "properties": {
  3778. "cpuPct": {
  3779. "example": 12.5,
  3780. "type": "number"
  3781. },
  3782. "error": {
  3783. "type": "string"
  3784. },
  3785. "latencyMs": {
  3786. "example": 42,
  3787. "type": "integer"
  3788. },
  3789. "memPct": {
  3790. "example": 45.2,
  3791. "type": "number"
  3792. },
  3793. "panelVersion": {
  3794. "example": "v3.x.x",
  3795. "type": "string"
  3796. },
  3797. "status": {
  3798. "example": "online",
  3799. "type": "string"
  3800. },
  3801. "uptimeSecs": {
  3802. "example": 86400,
  3803. "format": "int64",
  3804. "type": "integer"
  3805. },
  3806. "xrayError": {
  3807. "type": "string"
  3808. },
  3809. "xrayState": {
  3810. "description": "XrayState/XrayError are populated on successful probes even when the node's\nXray core is not healthy. The UI uses them for a distinct \"panel ok, xray failed\" indicator.",
  3811. "type": "string"
  3812. },
  3813. "xrayVersion": {
  3814. "example": "25.10.31",
  3815. "type": "string"
  3816. }
  3817. },
  3818. "required": [
  3819. "cpuPct",
  3820. "error",
  3821. "latencyMs",
  3822. "memPct",
  3823. "panelVersion",
  3824. "status",
  3825. "uptimeSecs",
  3826. "xrayError",
  3827. "xrayState",
  3828. "xrayVersion"
  3829. ],
  3830. "type": "object"
  3831. },
  3832. "RealityScanResult": {
  3833. "properties": {
  3834. "alpn": {
  3835. "example": "h2",
  3836. "type": "string"
  3837. },
  3838. "certChainBytes": {
  3839. "description": "CertChainBytes is the sum of DER lengths of the presented peer chain.\nxray-core ML-DSA-65 REALITY needs \u003e= 3500 bytes (constant lives in xray-core).",
  3840. "example": 3427,
  3841. "type": "integer"
  3842. },
  3843. "certChainValid": {
  3844. "description": "CertChainValid ignores the name: a trusted chain presented for other names\nstill has serverNames the panel can offer instead of the failing SNI.",
  3845. "example": true,
  3846. "type": "boolean"
  3847. },
  3848. "certIssuer": {
  3849. "example": "Google Trust Services",
  3850. "type": "string"
  3851. },
  3852. "certSubject": {
  3853. "example": "cloudflare.com",
  3854. "type": "string"
  3855. },
  3856. "certValid": {
  3857. "example": true,
  3858. "type": "boolean"
  3859. },
  3860. "curveID": {
  3861. "example": "X25519",
  3862. "type": "string"
  3863. },
  3864. "feasible": {
  3865. "example": true,
  3866. "type": "boolean"
  3867. },
  3868. "h2": {
  3869. "example": true,
  3870. "type": "boolean"
  3871. },
  3872. "host": {
  3873. "example": "www.cloudflare.com",
  3874. "type": "string"
  3875. },
  3876. "ip": {
  3877. "example": "104.16.124.96",
  3878. "type": "string"
  3879. },
  3880. "latencyMs": {
  3881. "example": 180,
  3882. "type": "integer"
  3883. },
  3884. "notAfter": {
  3885. "example": "2026-08-01T00:00:00Z",
  3886. "type": "string"
  3887. },
  3888. "port": {
  3889. "example": 443,
  3890. "type": "integer"
  3891. },
  3892. "privateTarget": {
  3893. "description": "PrivateTarget marks a target that resolves to a loopback/private/link-local\naddress: blocked before the probe unless the caller opted in, then flagged.",
  3894. "example": false,
  3895. "type": "boolean"
  3896. },
  3897. "reason": {
  3898. "type": "string"
  3899. },
  3900. "serverNames": {
  3901. "items": {
  3902. "type": "string"
  3903. },
  3904. "type": "array"
  3905. },
  3906. "target": {
  3907. "example": "www.cloudflare.com:443",
  3908. "type": "string"
  3909. },
  3910. "tls13": {
  3911. "example": true,
  3912. "type": "boolean"
  3913. },
  3914. "tlsVersion": {
  3915. "example": "1.3",
  3916. "type": "string"
  3917. },
  3918. "x25519": {
  3919. "example": true,
  3920. "type": "boolean"
  3921. }
  3922. },
  3923. "required": [
  3924. "alpn",
  3925. "certChainBytes",
  3926. "certChainValid",
  3927. "certIssuer",
  3928. "certSubject",
  3929. "certValid",
  3930. "curveID",
  3931. "feasible",
  3932. "h2",
  3933. "host",
  3934. "ip",
  3935. "latencyMs",
  3936. "notAfter",
  3937. "port",
  3938. "privateTarget",
  3939. "reason",
  3940. "serverNames",
  3941. "target",
  3942. "tls13",
  3943. "tlsVersion",
  3944. "x25519"
  3945. ],
  3946. "type": "object"
  3947. },
  3948. "ServerSettings": {
  3949. "description": "ServerSettings is the \"server\" block of an AmneziaWG inbound's Settings\nJSON: the interface-level configuration shared by every client/peer. The\nlisten port is deliberately not duplicated here — it lives on the inbound\nrow itself (Inbound.Port), like every other protocol.",
  3950. "properties": {
  3951. "contentPaddingAddition": {
  3952. "type": "string"
  3953. },
  3954. "disableCookies": {
  3955. "type": "boolean"
  3956. },
  3957. "externalInterface": {
  3958. "description": "ExternalInterface, IPv6Enabled, and IPv6ExternalInterface are live\nagain as of Phase 3.5 -- see the matching fields on Instance for what\nthey gate (internal/amneziawgnet's IPv6-address-alias mechanism).\nIPv6Subnet was never actually vestigial either: InstanceFromInbound\nalready consumes it (via serverAddressV6) to build the server's own\ntunnel address, same as always. Only RouteThroughXray, below, remains\ngenuinely vestigial as of the hard cutover to the embedded path\n(internal/amneziawgnet) -- read from existing stored settings for\nbackward compatibility, but not acted on by anything.",
  3959. "type": "string"
  3960. },
  3961. "h1": {
  3962. "type": "string"
  3963. },
  3964. "h2": {
  3965. "type": "string"
  3966. },
  3967. "h3": {
  3968. "type": "string"
  3969. },
  3970. "h4": {
  3971. "type": "string"
  3972. },
  3973. "headerProtectionKey": {
  3974. "description": "HeaderProtectionKey and ContentPaddingAddition are AmneziaWG 3.0\nfields, flat and top-level for the same tools/openapigen reason as\nthe block above; Obfuscation() below folds them back into\nObfuscation31's own identically named fields.\nHeaderProtectionKey is a base64 32-byte key; empty (the default)\ndisables AWG 3.0 header protection. A non-empty value requires\nevery one of S1-S4 above to be \u003e= 12 -- ValidateObfuscation\nenforces this at save time, not just at IpcSet time.\nContentPaddingAddition is a \"low-high\" range or bare integer, the\nsame grammar and uint32 cap as H1-H4.",
  3975. "type": "string"
  3976. },
  3977. "i1": {
  3978. "type": "string"
  3979. },
  3980. "i2": {
  3981. "type": "string"
  3982. },
  3983. "i3": {
  3984. "type": "string"
  3985. },
  3986. "i4": {
  3987. "type": "string"
  3988. },
  3989. "i5": {
  3990. "type": "string"
  3991. },
  3992. "ipv6Enabled": {
  3993. "type": "boolean"
  3994. },
  3995. "ipv6ExternalInterface": {
  3996. "type": "string"
  3997. },
  3998. "ipv6Subnet": {
  3999. "type": "string"
  4000. },
  4001. "jc": {
  4002. "description": "Obfuscation31's fields, repeated flat (not embedded) rather than\nnested under their own key: encoding/json would happily inline an\nembedded Obfuscation31 the same way, but the frontend's Go-\u003eZod/TS\ngenerator (tools/openapigen) does not — it emits a genuinely nested\n`obfuscation31` object, which would silently diverge from the real\nwire JSON. See Obfuscation() below for the manager-facing conversion.",
  4003. "type": "integer"
  4004. },
  4005. "jmax": {
  4006. "type": "integer"
  4007. },
  4008. "jmin": {
  4009. "type": "integer"
  4010. },
  4011. "keepaliveTimeout": {
  4012. "type": "string"
  4013. },
  4014. "maxHandshakeAttempts": {
  4015. "type": "string"
  4016. },
  4017. "mtu": {
  4018. "type": "integer"
  4019. },
  4020. "primaryDns": {
  4021. "description": "PrimaryDNS/SecondaryDNS seed client configs' DNS line. Blank is\nmeaningful, so no omitempty: a dropped key resurrects frontend defaults.",
  4022. "type": "string"
  4023. },
  4024. "privateKey": {
  4025. "type": "string"
  4026. },
  4027. "publicKey": {
  4028. "type": "string"
  4029. },
  4030. "randomTrailers": {
  4031. "description": "RandomTrailers/DisableCookies mirror Instance's identically named\nAmneziaWG 3.1 fields -- see that type's own doc comment for the real\nprotocol/interop details. Both real bool fields (not omitempty):\nbuildUAPIConfig always emits both lines explicitly so the\nreconfigure-in-place diff correctly notices a true-\u003efalse edit, not\njust false-\u003etrue.",
  4032. "type": "boolean"
  4033. },
  4034. "rejectAfterTime": {
  4035. "type": "string"
  4036. },
  4037. "rekeyAfterTime": {
  4038. "description": "RekeyAfterTime/RekeyTimeout/RejectAfterTime/KeepaliveTimeout/\nMaxHandshakeAttempts mirror Instance's identically named fields --\nsee that type's own doc comment for the grammar/width/real-default\ndetails. Flat and top-level for the same tools/openapigen reason as\nthe rest of this struct.",
  4039. "type": "string"
  4040. },
  4041. "rekeyTimeout": {
  4042. "type": "string"
  4043. },
  4044. "routeThroughXray": {
  4045. "type": "boolean"
  4046. },
  4047. "s1": {
  4048. "type": "integer"
  4049. },
  4050. "s2": {
  4051. "type": "integer"
  4052. },
  4053. "s3": {
  4054. "type": "integer"
  4055. },
  4056. "s4": {
  4057. "type": "integer"
  4058. },
  4059. "secondaryDns": {
  4060. "type": "string"
  4061. },
  4062. "subnetCidr": {
  4063. "type": "integer"
  4064. },
  4065. "subnetIp": {
  4066. "type": "string"
  4067. }
  4068. },
  4069. "required": [
  4070. "disableCookies",
  4071. "h1",
  4072. "h2",
  4073. "h3",
  4074. "h4",
  4075. "jc",
  4076. "jmax",
  4077. "jmin",
  4078. "primaryDns",
  4079. "privateKey",
  4080. "publicKey",
  4081. "randomTrailers",
  4082. "s1",
  4083. "s2",
  4084. "s3",
  4085. "s4",
  4086. "secondaryDns",
  4087. "subnetCidr",
  4088. "subnetIp"
  4089. ],
  4090. "type": "object"
  4091. },
  4092. "Setting": {
  4093. "description": "Setting stores key-value configuration settings for the 3x-ui panel.",
  4094. "properties": {
  4095. "id": {
  4096. "type": "integer"
  4097. },
  4098. "key": {
  4099. "type": "string"
  4100. },
  4101. "value": {
  4102. "type": "string"
  4103. }
  4104. },
  4105. "required": [
  4106. "id",
  4107. "key",
  4108. "value"
  4109. ],
  4110. "type": "object"
  4111. },
  4112. "SubBalancer": {
  4113. "description": "SubBalancer is one extra JSON-subscription config document whose members are\nthe selected inbounds' proxy outbounds. SortOrder shares SubSortIndex semantics.",
  4114. "properties": {
  4115. "createdAt": {
  4116. "example": 1710000000000,
  4117. "format": "int64",
  4118. "type": "integer"
  4119. },
  4120. "enabled": {
  4121. "description": "No gorm default:true — a bool default makes an explicit false at insert\ncollapse back to the column default (zero value is skipped).",
  4122. "example": true,
  4123. "type": "boolean"
  4124. },
  4125. "id": {
  4126. "example": 1,
  4127. "type": "integer"
  4128. },
  4129. "inboundIds": {
  4130. "example": [
  4131. 1,
  4132. 3
  4133. ],
  4134. "items": {
  4135. "type": "integer"
  4136. },
  4137. "type": "array"
  4138. },
  4139. "memberWeights": {
  4140. "additionalProperties": {
  4141. "type": "number"
  4142. },
  4143. "description": "inboundId -\u003e leastLoad weight; absent entries mean 1.0. Only meaningful\nwith Strategy \"leastLoad\" — xray ignores costs on every other strategy.",
  4144. "type": "object"
  4145. },
  4146. "remark": {
  4147. "example": "auto-fastest",
  4148. "maxLength": 256,
  4149. "type": "string"
  4150. },
  4151. "sortOrder": {
  4152. "example": 1,
  4153. "minimum": 1,
  4154. "type": "integer"
  4155. },
  4156. "strategy": {
  4157. "enum": [
  4158. "leastLoad",
  4159. "leastPing",
  4160. "random",
  4161. "roundRobin"
  4162. ],
  4163. "example": "random",
  4164. "type": "string"
  4165. },
  4166. "updatedAt": {
  4167. "example": 1710000000000,
  4168. "format": "int64",
  4169. "type": "integer"
  4170. }
  4171. },
  4172. "required": [
  4173. "createdAt",
  4174. "enabled",
  4175. "id",
  4176. "inboundIds",
  4177. "remark",
  4178. "sortOrder",
  4179. "strategy",
  4180. "updatedAt"
  4181. ],
  4182. "type": "object"
  4183. },
  4184. "Traffic": {
  4185. "description": "Traffic represents network traffic statistics for Xray connections.\nIt tracks upload and download bytes for inbound or outbound traffic.",
  4186. "properties": {
  4187. "Down": {
  4188. "example": 2097152,
  4189. "format": "int64",
  4190. "type": "integer"
  4191. },
  4192. "IsInbound": {
  4193. "example": true,
  4194. "type": "boolean"
  4195. },
  4196. "IsOutbound": {
  4197. "example": false,
  4198. "type": "boolean"
  4199. },
  4200. "Tag": {
  4201. "example": "inbound-443",
  4202. "type": "string"
  4203. },
  4204. "Up": {
  4205. "example": 1048576,
  4206. "format": "int64",
  4207. "type": "integer"
  4208. }
  4209. },
  4210. "required": [
  4211. "Down",
  4212. "IsInbound",
  4213. "IsOutbound",
  4214. "Tag",
  4215. "Up"
  4216. ],
  4217. "type": "object"
  4218. },
  4219. "TuicClientSettings": {
  4220. "properties": {
  4221. "email": {
  4222. "type": "string"
  4223. },
  4224. "password": {
  4225. "type": "string"
  4226. },
  4227. "uuid": {
  4228. "type": "string"
  4229. }
  4230. },
  4231. "required": [
  4232. "email",
  4233. "password",
  4234. "uuid"
  4235. ],
  4236. "type": "object"
  4237. },
  4238. "TuicServerSettings": {
  4239. "properties": {
  4240. "alpn": {
  4241. "items": {
  4242. "type": "string"
  4243. },
  4244. "type": "array"
  4245. },
  4246. "authentication_timeout": {
  4247. "type": "integer"
  4248. },
  4249. "certificate": {
  4250. "type": "string"
  4251. },
  4252. "congestion_control": {
  4253. "type": "string"
  4254. },
  4255. "log_level": {
  4256. "type": "string"
  4257. },
  4258. "max_idle_time": {
  4259. "type": "integer"
  4260. },
  4261. "max_udp_relay_packet_size": {
  4262. "type": "integer"
  4263. },
  4264. "private_key": {
  4265. "type": "string"
  4266. },
  4267. "sni": {
  4268. "type": "string"
  4269. },
  4270. "udp_relay_mode": {
  4271. "type": "string"
  4272. },
  4273. "zero_rtt_handshake": {
  4274. "type": "boolean"
  4275. }
  4276. },
  4277. "required": [
  4278. "alpn",
  4279. "authentication_timeout",
  4280. "certificate",
  4281. "congestion_control",
  4282. "log_level",
  4283. "max_idle_time",
  4284. "max_udp_relay_packet_size",
  4285. "private_key",
  4286. "udp_relay_mode",
  4287. "zero_rtt_handshake"
  4288. ],
  4289. "type": "object"
  4290. },
  4291. "User": {
  4292. "description": "User represents a user account in the 3x-ui panel.",
  4293. "properties": {
  4294. "id": {
  4295. "type": "integer"
  4296. },
  4297. "password": {
  4298. "type": "string"
  4299. },
  4300. "username": {
  4301. "type": "string"
  4302. }
  4303. },
  4304. "required": [
  4305. "id",
  4306. "password",
  4307. "username"
  4308. ],
  4309. "type": "object"
  4310. }
  4311. };