schemas.ts 90 KB

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