schemas.ts 106 KB

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