schemas.ts 90 KB

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