schemas.ts 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434
  1. // Code generated by tools/openapigen. DO NOT EDIT.
  2. export const SCHEMAS: Record<string, unknown> = {
  3. "AllSetting": {
  4. "properties": {
  5. "datepicker": {
  6. "type": "string"
  7. },
  8. "expireDiff": {
  9. "minimum": 0,
  10. "type": "integer"
  11. },
  12. "externalTrafficInformEnable": {
  13. "type": "boolean"
  14. },
  15. "externalTrafficInformURI": {
  16. "type": "string"
  17. },
  18. "ldapAutoCreate": {
  19. "type": "boolean"
  20. },
  21. "ldapAutoDelete": {
  22. "type": "boolean"
  23. },
  24. "ldapBaseDN": {
  25. "type": "string"
  26. },
  27. "ldapBindDN": {
  28. "type": "string"
  29. },
  30. "ldapDefaultExpiryDays": {
  31. "minimum": 0,
  32. "type": "integer"
  33. },
  34. "ldapDefaultLimitIP": {
  35. "minimum": 0,
  36. "type": "integer"
  37. },
  38. "ldapDefaultTotalGB": {
  39. "minimum": 0,
  40. "type": "integer"
  41. },
  42. "ldapEnable": {
  43. "type": "boolean"
  44. },
  45. "ldapFlagField": {
  46. "type": "string"
  47. },
  48. "ldapHost": {
  49. "type": "string"
  50. },
  51. "ldapInboundTags": {
  52. "type": "string"
  53. },
  54. "ldapInsecureSkipVerify": {
  55. "type": "boolean"
  56. },
  57. "ldapInvertFlag": {
  58. "type": "boolean"
  59. },
  60. "ldapPassword": {
  61. "type": "string"
  62. },
  63. "ldapPort": {
  64. "maximum": 65535,
  65. "minimum": 0,
  66. "type": "integer"
  67. },
  68. "ldapSyncCron": {
  69. "type": "string"
  70. },
  71. "ldapTruthyValues": {
  72. "type": "string"
  73. },
  74. "ldapUseTLS": {
  75. "type": "boolean"
  76. },
  77. "ldapUserAttr": {
  78. "type": "string"
  79. },
  80. "ldapUserFilter": {
  81. "type": "string"
  82. },
  83. "ldapVlessField": {
  84. "type": "string"
  85. },
  86. "pageSize": {
  87. "maximum": 1000,
  88. "minimum": 0,
  89. "type": "integer"
  90. },
  91. "panelOutbound": {
  92. "type": "string"
  93. },
  94. "remarkTemplate": {
  95. "type": "string"
  96. },
  97. "restartXrayOnClientDisable": {
  98. "type": "boolean"
  99. },
  100. "sessionMaxAge": {
  101. "maximum": 525600,
  102. "minimum": 1,
  103. "type": "integer"
  104. },
  105. "smtpCpu": {
  106. "maximum": 100,
  107. "minimum": 0,
  108. "type": "integer"
  109. },
  110. "smtpEnable": {
  111. "type": "boolean"
  112. },
  113. "smtpEnabledEvents": {
  114. "type": "string"
  115. },
  116. "smtpEncryptionType": {
  117. "type": "string"
  118. },
  119. "smtpHost": {
  120. "type": "string"
  121. },
  122. "smtpMemory": {
  123. "maximum": 100,
  124. "minimum": 0,
  125. "type": "integer"
  126. },
  127. "smtpPassword": {
  128. "type": "string"
  129. },
  130. "smtpPort": {
  131. "maximum": 65535,
  132. "minimum": 1,
  133. "type": "integer"
  134. },
  135. "smtpTo": {
  136. "type": "string"
  137. },
  138. "smtpUsername": {
  139. "type": "string"
  140. },
  141. "subAnnounce": {
  142. "type": "string"
  143. },
  144. "subCertFile": {
  145. "type": "string"
  146. },
  147. "subClashEnable": {
  148. "type": "boolean"
  149. },
  150. "subClashEnableRouting": {
  151. "type": "boolean"
  152. },
  153. "subClashPath": {
  154. "type": "string"
  155. },
  156. "subClashRules": {
  157. "type": "string"
  158. },
  159. "subClashURI": {
  160. "type": "string"
  161. },
  162. "subDomain": {
  163. "type": "string"
  164. },
  165. "subEnable": {
  166. "type": "boolean"
  167. },
  168. "subEnableRouting": {
  169. "type": "boolean"
  170. },
  171. "subEncrypt": {
  172. "type": "boolean"
  173. },
  174. "subHideSettings": {
  175. "type": "boolean"
  176. },
  177. "subIncyEnableRouting": {
  178. "type": "boolean"
  179. },
  180. "subIncyRoutingRules": {
  181. "type": "string"
  182. },
  183. "subJsonEnable": {
  184. "type": "boolean"
  185. },
  186. "subJsonFinalMask": {
  187. "type": "string"
  188. },
  189. "subJsonMux": {
  190. "type": "string"
  191. },
  192. "subJsonPath": {
  193. "type": "string"
  194. },
  195. "subJsonRules": {
  196. "type": "string"
  197. },
  198. "subJsonURI": {
  199. "type": "string"
  200. },
  201. "subKeyFile": {
  202. "type": "string"
  203. },
  204. "subListen": {
  205. "type": "string"
  206. },
  207. "subPath": {
  208. "type": "string"
  209. },
  210. "subPort": {
  211. "maximum": 65535,
  212. "minimum": 1,
  213. "type": "integer"
  214. },
  215. "subProfileUrl": {
  216. "type": "string"
  217. },
  218. "subRoutingRules": {
  219. "type": "string"
  220. },
  221. "subSupportUrl": {
  222. "type": "string"
  223. },
  224. "subThemeDir": {
  225. "type": "string"
  226. },
  227. "subTitle": {
  228. "type": "string"
  229. },
  230. "subURI": {
  231. "type": "string"
  232. },
  233. "subUpdates": {
  234. "maximum": 525600,
  235. "minimum": 0,
  236. "type": "integer"
  237. },
  238. "tgBotAPIServer": {
  239. "type": "string"
  240. },
  241. "tgBotBackup": {
  242. "type": "boolean"
  243. },
  244. "tgBotChatId": {
  245. "type": "string"
  246. },
  247. "tgBotEnable": {
  248. "type": "boolean"
  249. },
  250. "tgBotProxy": {
  251. "type": "string"
  252. },
  253. "tgBotToken": {
  254. "type": "string"
  255. },
  256. "tgCpu": {
  257. "maximum": 100,
  258. "minimum": 0,
  259. "type": "integer"
  260. },
  261. "tgEnabledEvents": {
  262. "type": "string"
  263. },
  264. "tgLang": {
  265. "type": "string"
  266. },
  267. "tgMemory": {
  268. "maximum": 100,
  269. "minimum": 0,
  270. "type": "integer"
  271. },
  272. "tgRunTime": {
  273. "type": "string"
  274. },
  275. "timeLocation": {
  276. "type": "string"
  277. },
  278. "trafficDiff": {
  279. "maximum": 100,
  280. "minimum": 0,
  281. "type": "integer"
  282. },
  283. "trustedProxyCIDRs": {
  284. "type": "string"
  285. },
  286. "twoFactorEnable": {
  287. "type": "boolean"
  288. },
  289. "twoFactorToken": {
  290. "type": "string"
  291. },
  292. "warpUpdateInterval": {
  293. "minimum": 0,
  294. "type": "integer"
  295. },
  296. "webBasePath": {
  297. "type": "string"
  298. },
  299. "webCertFile": {
  300. "type": "string"
  301. },
  302. "webDomain": {
  303. "type": "string"
  304. },
  305. "webKeyFile": {
  306. "type": "string"
  307. },
  308. "webListen": {
  309. "type": "string"
  310. },
  311. "webPort": {
  312. "maximum": 65535,
  313. "minimum": 1,
  314. "type": "integer"
  315. }
  316. },
  317. "required": [
  318. "datepicker",
  319. "expireDiff",
  320. "externalTrafficInformEnable",
  321. "externalTrafficInformURI",
  322. "ldapAutoCreate",
  323. "ldapAutoDelete",
  324. "ldapBaseDN",
  325. "ldapBindDN",
  326. "ldapDefaultExpiryDays",
  327. "ldapDefaultLimitIP",
  328. "ldapDefaultTotalGB",
  329. "ldapEnable",
  330. "ldapFlagField",
  331. "ldapHost",
  332. "ldapInboundTags",
  333. "ldapInsecureSkipVerify",
  334. "ldapInvertFlag",
  335. "ldapPassword",
  336. "ldapPort",
  337. "ldapSyncCron",
  338. "ldapTruthyValues",
  339. "ldapUseTLS",
  340. "ldapUserAttr",
  341. "ldapUserFilter",
  342. "ldapVlessField",
  343. "pageSize",
  344. "panelOutbound",
  345. "remarkTemplate",
  346. "restartXrayOnClientDisable",
  347. "sessionMaxAge",
  348. "smtpCpu",
  349. "smtpEnable",
  350. "smtpEnabledEvents",
  351. "smtpEncryptionType",
  352. "smtpHost",
  353. "smtpMemory",
  354. "smtpPassword",
  355. "smtpPort",
  356. "smtpTo",
  357. "smtpUsername",
  358. "subAnnounce",
  359. "subCertFile",
  360. "subClashEnable",
  361. "subClashEnableRouting",
  362. "subClashPath",
  363. "subClashRules",
  364. "subClashURI",
  365. "subDomain",
  366. "subEnable",
  367. "subEnableRouting",
  368. "subEncrypt",
  369. "subHideSettings",
  370. "subIncyEnableRouting",
  371. "subIncyRoutingRules",
  372. "subJsonEnable",
  373. "subJsonFinalMask",
  374. "subJsonMux",
  375. "subJsonPath",
  376. "subJsonRules",
  377. "subJsonURI",
  378. "subKeyFile",
  379. "subListen",
  380. "subPath",
  381. "subPort",
  382. "subProfileUrl",
  383. "subRoutingRules",
  384. "subSupportUrl",
  385. "subThemeDir",
  386. "subTitle",
  387. "subURI",
  388. "subUpdates",
  389. "tgBotAPIServer",
  390. "tgBotBackup",
  391. "tgBotChatId",
  392. "tgBotEnable",
  393. "tgBotProxy",
  394. "tgBotToken",
  395. "tgCpu",
  396. "tgEnabledEvents",
  397. "tgLang",
  398. "tgMemory",
  399. "tgRunTime",
  400. "timeLocation",
  401. "trafficDiff",
  402. "trustedProxyCIDRs",
  403. "twoFactorEnable",
  404. "twoFactorToken",
  405. "warpUpdateInterval",
  406. "webBasePath",
  407. "webCertFile",
  408. "webDomain",
  409. "webKeyFile",
  410. "webListen",
  411. "webPort"
  412. ],
  413. "type": "object"
  414. },
  415. "AllSettingView": {
  416. "properties": {
  417. "datepicker": {
  418. "type": "string"
  419. },
  420. "expireDiff": {
  421. "minimum": 0,
  422. "type": "integer"
  423. },
  424. "externalTrafficInformEnable": {
  425. "type": "boolean"
  426. },
  427. "externalTrafficInformURI": {
  428. "type": "string"
  429. },
  430. "hasApiToken": {
  431. "type": "boolean"
  432. },
  433. "hasLdapPassword": {
  434. "type": "boolean"
  435. },
  436. "hasNordSecret": {
  437. "type": "boolean"
  438. },
  439. "hasSmtpPassword": {
  440. "type": "boolean"
  441. },
  442. "hasTgBotToken": {
  443. "type": "boolean"
  444. },
  445. "hasTwoFactorToken": {
  446. "type": "boolean"
  447. },
  448. "hasWarpSecret": {
  449. "type": "boolean"
  450. },
  451. "ldapAutoCreate": {
  452. "type": "boolean"
  453. },
  454. "ldapAutoDelete": {
  455. "type": "boolean"
  456. },
  457. "ldapBaseDN": {
  458. "type": "string"
  459. },
  460. "ldapBindDN": {
  461. "type": "string"
  462. },
  463. "ldapDefaultExpiryDays": {
  464. "minimum": 0,
  465. "type": "integer"
  466. },
  467. "ldapDefaultLimitIP": {
  468. "minimum": 0,
  469. "type": "integer"
  470. },
  471. "ldapDefaultTotalGB": {
  472. "minimum": 0,
  473. "type": "integer"
  474. },
  475. "ldapEnable": {
  476. "type": "boolean"
  477. },
  478. "ldapFlagField": {
  479. "type": "string"
  480. },
  481. "ldapHost": {
  482. "type": "string"
  483. },
  484. "ldapInboundTags": {
  485. "type": "string"
  486. },
  487. "ldapInsecureSkipVerify": {
  488. "type": "boolean"
  489. },
  490. "ldapInvertFlag": {
  491. "type": "boolean"
  492. },
  493. "ldapPassword": {
  494. "type": "string"
  495. },
  496. "ldapPort": {
  497. "maximum": 65535,
  498. "minimum": 0,
  499. "type": "integer"
  500. },
  501. "ldapSyncCron": {
  502. "type": "string"
  503. },
  504. "ldapTruthyValues": {
  505. "type": "string"
  506. },
  507. "ldapUseTLS": {
  508. "type": "boolean"
  509. },
  510. "ldapUserAttr": {
  511. "type": "string"
  512. },
  513. "ldapUserFilter": {
  514. "type": "string"
  515. },
  516. "ldapVlessField": {
  517. "type": "string"
  518. },
  519. "pageSize": {
  520. "maximum": 1000,
  521. "minimum": 0,
  522. "type": "integer"
  523. },
  524. "panelOutbound": {
  525. "type": "string"
  526. },
  527. "remarkTemplate": {
  528. "type": "string"
  529. },
  530. "restartXrayOnClientDisable": {
  531. "type": "boolean"
  532. },
  533. "sessionMaxAge": {
  534. "maximum": 525600,
  535. "minimum": 1,
  536. "type": "integer"
  537. },
  538. "smtpCpu": {
  539. "maximum": 100,
  540. "minimum": 0,
  541. "type": "integer"
  542. },
  543. "smtpEnable": {
  544. "type": "boolean"
  545. },
  546. "smtpEnabledEvents": {
  547. "type": "string"
  548. },
  549. "smtpEncryptionType": {
  550. "type": "string"
  551. },
  552. "smtpHost": {
  553. "type": "string"
  554. },
  555. "smtpMemory": {
  556. "maximum": 100,
  557. "minimum": 0,
  558. "type": "integer"
  559. },
  560. "smtpPassword": {
  561. "type": "string"
  562. },
  563. "smtpPort": {
  564. "maximum": 65535,
  565. "minimum": 1,
  566. "type": "integer"
  567. },
  568. "smtpTo": {
  569. "type": "string"
  570. },
  571. "smtpUsername": {
  572. "type": "string"
  573. },
  574. "subAnnounce": {
  575. "type": "string"
  576. },
  577. "subCertFile": {
  578. "type": "string"
  579. },
  580. "subClashEnable": {
  581. "type": "boolean"
  582. },
  583. "subClashEnableRouting": {
  584. "type": "boolean"
  585. },
  586. "subClashPath": {
  587. "type": "string"
  588. },
  589. "subClashRules": {
  590. "type": "string"
  591. },
  592. "subClashURI": {
  593. "type": "string"
  594. },
  595. "subDomain": {
  596. "type": "string"
  597. },
  598. "subEnable": {
  599. "type": "boolean"
  600. },
  601. "subEnableRouting": {
  602. "type": "boolean"
  603. },
  604. "subEncrypt": {
  605. "type": "boolean"
  606. },
  607. "subHideSettings": {
  608. "type": "boolean"
  609. },
  610. "subIncyEnableRouting": {
  611. "type": "boolean"
  612. },
  613. "subIncyRoutingRules": {
  614. "type": "string"
  615. },
  616. "subJsonEnable": {
  617. "type": "boolean"
  618. },
  619. "subJsonFinalMask": {
  620. "type": "string"
  621. },
  622. "subJsonMux": {
  623. "type": "string"
  624. },
  625. "subJsonPath": {
  626. "type": "string"
  627. },
  628. "subJsonRules": {
  629. "type": "string"
  630. },
  631. "subJsonURI": {
  632. "type": "string"
  633. },
  634. "subKeyFile": {
  635. "type": "string"
  636. },
  637. "subListen": {
  638. "type": "string"
  639. },
  640. "subPath": {
  641. "type": "string"
  642. },
  643. "subPort": {
  644. "maximum": 65535,
  645. "minimum": 1,
  646. "type": "integer"
  647. },
  648. "subProfileUrl": {
  649. "type": "string"
  650. },
  651. "subRoutingRules": {
  652. "type": "string"
  653. },
  654. "subSupportUrl": {
  655. "type": "string"
  656. },
  657. "subThemeDir": {
  658. "type": "string"
  659. },
  660. "subTitle": {
  661. "type": "string"
  662. },
  663. "subURI": {
  664. "type": "string"
  665. },
  666. "subUpdates": {
  667. "maximum": 525600,
  668. "minimum": 0,
  669. "type": "integer"
  670. },
  671. "tgBotAPIServer": {
  672. "type": "string"
  673. },
  674. "tgBotBackup": {
  675. "type": "boolean"
  676. },
  677. "tgBotChatId": {
  678. "type": "string"
  679. },
  680. "tgBotEnable": {
  681. "type": "boolean"
  682. },
  683. "tgBotProxy": {
  684. "type": "string"
  685. },
  686. "tgBotToken": {
  687. "type": "string"
  688. },
  689. "tgCpu": {
  690. "maximum": 100,
  691. "minimum": 0,
  692. "type": "integer"
  693. },
  694. "tgEnabledEvents": {
  695. "type": "string"
  696. },
  697. "tgLang": {
  698. "type": "string"
  699. },
  700. "tgMemory": {
  701. "maximum": 100,
  702. "minimum": 0,
  703. "type": "integer"
  704. },
  705. "tgRunTime": {
  706. "type": "string"
  707. },
  708. "timeLocation": {
  709. "type": "string"
  710. },
  711. "trafficDiff": {
  712. "maximum": 100,
  713. "minimum": 0,
  714. "type": "integer"
  715. },
  716. "trustedProxyCIDRs": {
  717. "type": "string"
  718. },
  719. "twoFactorEnable": {
  720. "type": "boolean"
  721. },
  722. "twoFactorToken": {
  723. "type": "string"
  724. },
  725. "warpUpdateInterval": {
  726. "minimum": 0,
  727. "type": "integer"
  728. },
  729. "webBasePath": {
  730. "type": "string"
  731. },
  732. "webCertFile": {
  733. "type": "string"
  734. },
  735. "webDomain": {
  736. "type": "string"
  737. },
  738. "webKeyFile": {
  739. "type": "string"
  740. },
  741. "webListen": {
  742. "type": "string"
  743. },
  744. "webPort": {
  745. "maximum": 65535,
  746. "minimum": 1,
  747. "type": "integer"
  748. }
  749. },
  750. "required": [
  751. "datepicker",
  752. "expireDiff",
  753. "externalTrafficInformEnable",
  754. "externalTrafficInformURI",
  755. "hasApiToken",
  756. "hasLdapPassword",
  757. "hasNordSecret",
  758. "hasSmtpPassword",
  759. "hasTgBotToken",
  760. "hasTwoFactorToken",
  761. "hasWarpSecret",
  762. "ldapAutoCreate",
  763. "ldapAutoDelete",
  764. "ldapBaseDN",
  765. "ldapBindDN",
  766. "ldapDefaultExpiryDays",
  767. "ldapDefaultLimitIP",
  768. "ldapDefaultTotalGB",
  769. "ldapEnable",
  770. "ldapFlagField",
  771. "ldapHost",
  772. "ldapInboundTags",
  773. "ldapInsecureSkipVerify",
  774. "ldapInvertFlag",
  775. "ldapPassword",
  776. "ldapPort",
  777. "ldapSyncCron",
  778. "ldapTruthyValues",
  779. "ldapUseTLS",
  780. "ldapUserAttr",
  781. "ldapUserFilter",
  782. "ldapVlessField",
  783. "pageSize",
  784. "panelOutbound",
  785. "remarkTemplate",
  786. "restartXrayOnClientDisable",
  787. "sessionMaxAge",
  788. "smtpCpu",
  789. "smtpEnable",
  790. "smtpEnabledEvents",
  791. "smtpEncryptionType",
  792. "smtpHost",
  793. "smtpMemory",
  794. "smtpPassword",
  795. "smtpPort",
  796. "smtpTo",
  797. "smtpUsername",
  798. "subAnnounce",
  799. "subCertFile",
  800. "subClashEnable",
  801. "subClashEnableRouting",
  802. "subClashPath",
  803. "subClashRules",
  804. "subClashURI",
  805. "subDomain",
  806. "subEnable",
  807. "subEnableRouting",
  808. "subEncrypt",
  809. "subHideSettings",
  810. "subIncyEnableRouting",
  811. "subIncyRoutingRules",
  812. "subJsonEnable",
  813. "subJsonFinalMask",
  814. "subJsonMux",
  815. "subJsonPath",
  816. "subJsonRules",
  817. "subJsonURI",
  818. "subKeyFile",
  819. "subListen",
  820. "subPath",
  821. "subPort",
  822. "subProfileUrl",
  823. "subRoutingRules",
  824. "subSupportUrl",
  825. "subThemeDir",
  826. "subTitle",
  827. "subURI",
  828. "subUpdates",
  829. "tgBotAPIServer",
  830. "tgBotBackup",
  831. "tgBotChatId",
  832. "tgBotEnable",
  833. "tgBotProxy",
  834. "tgBotToken",
  835. "tgCpu",
  836. "tgEnabledEvents",
  837. "tgLang",
  838. "tgMemory",
  839. "tgRunTime",
  840. "timeLocation",
  841. "trafficDiff",
  842. "trustedProxyCIDRs",
  843. "twoFactorEnable",
  844. "twoFactorToken",
  845. "warpUpdateInterval",
  846. "webBasePath",
  847. "webCertFile",
  848. "webDomain",
  849. "webKeyFile",
  850. "webListen",
  851. "webPort"
  852. ],
  853. "type": "object"
  854. },
  855. "ApiToken": {
  856. "properties": {
  857. "createdAt": {
  858. "format": "int64",
  859. "type": "integer"
  860. },
  861. "enabled": {
  862. "type": "boolean"
  863. },
  864. "id": {
  865. "type": "integer"
  866. },
  867. "name": {
  868. "type": "string"
  869. },
  870. "token": {
  871. "description": "SHA-256 hash; the plaintext is shown only once at creation",
  872. "type": "string"
  873. }
  874. },
  875. "required": [
  876. "createdAt",
  877. "enabled",
  878. "id",
  879. "name",
  880. "token"
  881. ],
  882. "type": "object"
  883. },
  884. "ApiTokenView": {
  885. "properties": {
  886. "createdAt": {
  887. "example": 1736000000,
  888. "format": "int64",
  889. "type": "integer"
  890. },
  891. "enabled": {
  892. "example": true,
  893. "type": "boolean"
  894. },
  895. "id": {
  896. "example": 2,
  897. "type": "integer"
  898. },
  899. "name": {
  900. "example": "central-panel-a",
  901. "type": "string"
  902. },
  903. "token": {
  904. "example": "new-token-string",
  905. "type": "string"
  906. }
  907. },
  908. "required": [
  909. "createdAt",
  910. "enabled",
  911. "id",
  912. "name"
  913. ],
  914. "type": "object"
  915. },
  916. "Client": {
  917. "description": "Client represents a client configuration for Xray inbounds with traffic limits and settings.",
  918. "properties": {
  919. "adTag": {
  920. "example": "0123456789abcdef0123456789abcdef",
  921. "type": "string"
  922. },
  923. "allowedIPs": {
  924. "items": {
  925. "type": "string"
  926. },
  927. "type": "array"
  928. },
  929. "auth": {
  930. "description": "Auth password (Hysteria)",
  931. "type": "string"
  932. },
  933. "comment": {
  934. "description": "Client comment",
  935. "type": "string"
  936. },
  937. "created_at": {
  938. "description": "Creation timestamp",
  939. "format": "int64",
  940. "type": "integer"
  941. },
  942. "email": {
  943. "description": "Client email identifier",
  944. "type": "string"
  945. },
  946. "enable": {
  947. "description": "Whether the client is enabled",
  948. "type": "boolean"
  949. },
  950. "expiryTime": {
  951. "description": "Expiration timestamp",
  952. "format": "int64",
  953. "type": "integer"
  954. },
  955. "flow": {
  956. "description": "Flow control (XTLS)",
  957. "type": "string"
  958. },
  959. "group": {
  960. "description": "Logical grouping label",
  961. "type": "string"
  962. },
  963. "id": {
  964. "description": "Unique client identifier",
  965. "type": "string"
  966. },
  967. "keepAlive": {
  968. "type": "integer"
  969. },
  970. "limitIp": {
  971. "description": "IP limit for this client",
  972. "type": "integer"
  973. },
  974. "password": {
  975. "description": "Client password",
  976. "type": "string"
  977. },
  978. "preSharedKey": {
  979. "type": "string"
  980. },
  981. "privateKey": {
  982. "type": "string"
  983. },
  984. "publicKey": {
  985. "type": "string"
  986. },
  987. "reset": {
  988. "description": "Reset period in days",
  989. "type": "integer"
  990. },
  991. "reverse": {
  992. "allOf": [
  993. {
  994. "$ref": "#/components/schemas/ClientReverse"
  995. }
  996. ],
  997. "description": "VLESS simple reverse proxy settings",
  998. "nullable": true
  999. },
  1000. "secret": {
  1001. "example": "ee1234567890abcdef1234567890abcd7777772e636c6f7564666c6172652e636f6d",
  1002. "type": "string"
  1003. },
  1004. "security": {
  1005. "description": "Security method (e.g., \"auto\", \"aes-128-gcm\")",
  1006. "type": "string"
  1007. },
  1008. "subId": {
  1009. "description": "Subscription identifier",
  1010. "type": "string"
  1011. },
  1012. "tgId": {
  1013. "description": "Telegram user ID for notifications",
  1014. "format": "int64",
  1015. "type": "integer"
  1016. },
  1017. "totalGB": {
  1018. "description": "Total traffic limit in GB",
  1019. "format": "int64",
  1020. "type": "integer"
  1021. },
  1022. "updated_at": {
  1023. "description": "Last update timestamp",
  1024. "format": "int64",
  1025. "type": "integer"
  1026. }
  1027. },
  1028. "required": [
  1029. "comment",
  1030. "email",
  1031. "enable",
  1032. "expiryTime",
  1033. "limitIp",
  1034. "reset",
  1035. "security",
  1036. "subId",
  1037. "tgId",
  1038. "totalGB"
  1039. ],
  1040. "type": "object"
  1041. },
  1042. "ClientInbound": {
  1043. "properties": {
  1044. "clientId": {
  1045. "type": "integer"
  1046. },
  1047. "createdAt": {
  1048. "format": "int64",
  1049. "type": "integer"
  1050. },
  1051. "flowOverride": {
  1052. "type": "string"
  1053. },
  1054. "inboundId": {
  1055. "type": "integer"
  1056. }
  1057. },
  1058. "required": [
  1059. "clientId",
  1060. "createdAt",
  1061. "flowOverride",
  1062. "inboundId"
  1063. ],
  1064. "type": "object"
  1065. },
  1066. "ClientRecord": {
  1067. "properties": {
  1068. "adTag": {
  1069. "type": "string"
  1070. },
  1071. "allowedIPs": {
  1072. "type": "string"
  1073. },
  1074. "auth": {
  1075. "type": "string"
  1076. },
  1077. "comment": {
  1078. "type": "string"
  1079. },
  1080. "createdAt": {
  1081. "format": "int64",
  1082. "type": "integer"
  1083. },
  1084. "email": {
  1085. "type": "string"
  1086. },
  1087. "enable": {
  1088. "type": "boolean"
  1089. },
  1090. "expiryTime": {
  1091. "format": "int64",
  1092. "type": "integer"
  1093. },
  1094. "flow": {
  1095. "type": "string"
  1096. },
  1097. "group": {
  1098. "type": "string"
  1099. },
  1100. "id": {
  1101. "type": "integer"
  1102. },
  1103. "keepAlive": {
  1104. "type": "integer"
  1105. },
  1106. "limitIp": {
  1107. "type": "integer"
  1108. },
  1109. "password": {
  1110. "type": "string"
  1111. },
  1112. "preSharedKey": {
  1113. "type": "string"
  1114. },
  1115. "privateKey": {
  1116. "type": "string"
  1117. },
  1118. "publicKey": {
  1119. "type": "string"
  1120. },
  1121. "reset": {
  1122. "type": "integer"
  1123. },
  1124. "reverse": {},
  1125. "secret": {
  1126. "type": "string"
  1127. },
  1128. "security": {
  1129. "type": "string"
  1130. },
  1131. "subId": {
  1132. "type": "string"
  1133. },
  1134. "tgId": {
  1135. "format": "int64",
  1136. "type": "integer"
  1137. },
  1138. "totalGB": {
  1139. "format": "int64",
  1140. "type": "integer"
  1141. },
  1142. "updatedAt": {
  1143. "format": "int64",
  1144. "type": "integer"
  1145. },
  1146. "uuid": {
  1147. "type": "string"
  1148. }
  1149. },
  1150. "required": [
  1151. "adTag",
  1152. "allowedIPs",
  1153. "auth",
  1154. "comment",
  1155. "createdAt",
  1156. "email",
  1157. "enable",
  1158. "expiryTime",
  1159. "flow",
  1160. "group",
  1161. "id",
  1162. "keepAlive",
  1163. "limitIp",
  1164. "password",
  1165. "preSharedKey",
  1166. "privateKey",
  1167. "publicKey",
  1168. "reset",
  1169. "reverse",
  1170. "secret",
  1171. "security",
  1172. "subId",
  1173. "tgId",
  1174. "totalGB",
  1175. "updatedAt",
  1176. "uuid"
  1177. ],
  1178. "type": "object"
  1179. },
  1180. "ClientReverse": {
  1181. "properties": {
  1182. "tag": {
  1183. "type": "string"
  1184. }
  1185. },
  1186. "required": [
  1187. "tag"
  1188. ],
  1189. "type": "object"
  1190. },
  1191. "ClientTraffic": {
  1192. "description": "ClientTraffic represents traffic statistics and limits for a specific client.\nIt tracks upload/download usage, expiry times, and online status for inbound clients.",
  1193. "properties": {
  1194. "down": {
  1195. "example": 2097152,
  1196. "format": "int64",
  1197. "type": "integer"
  1198. },
  1199. "email": {
  1200. "example": "user1",
  1201. "type": "string"
  1202. },
  1203. "enable": {
  1204. "example": true,
  1205. "type": "boolean"
  1206. },
  1207. "expiryTime": {
  1208. "example": 1735689600000,
  1209. "format": "int64",
  1210. "type": "integer"
  1211. },
  1212. "id": {
  1213. "example": 14825,
  1214. "type": "integer"
  1215. },
  1216. "inboundId": {
  1217. "example": 1,
  1218. "type": "integer"
  1219. },
  1220. "lastOnline": {
  1221. "example": 1735680000000,
  1222. "format": "int64",
  1223. "type": "integer"
  1224. },
  1225. "reset": {
  1226. "example": 0,
  1227. "type": "integer"
  1228. },
  1229. "subId": {
  1230. "example": "i7tvdpeffi0hvvf1",
  1231. "type": "string"
  1232. },
  1233. "total": {
  1234. "example": 10737418240,
  1235. "format": "int64",
  1236. "type": "integer"
  1237. },
  1238. "up": {
  1239. "example": 1048576,
  1240. "format": "int64",
  1241. "type": "integer"
  1242. },
  1243. "uuid": {
  1244. "example": "e18c9a96-71bf-48d4-933f-8b9a46d4290c",
  1245. "type": "string"
  1246. }
  1247. },
  1248. "required": [
  1249. "down",
  1250. "email",
  1251. "enable",
  1252. "expiryTime",
  1253. "id",
  1254. "inboundId",
  1255. "lastOnline",
  1256. "reset",
  1257. "subId",
  1258. "total",
  1259. "up",
  1260. "uuid"
  1261. ],
  1262. "type": "object"
  1263. },
  1264. "FallbackParentInfo": {
  1265. "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.",
  1266. "properties": {
  1267. "masterId": {
  1268. "type": "integer"
  1269. },
  1270. "path": {
  1271. "type": "string"
  1272. }
  1273. },
  1274. "required": [
  1275. "masterId"
  1276. ],
  1277. "type": "object"
  1278. },
  1279. "HistoryOfSeeders": {
  1280. "description": "HistoryOfSeeders tracks which database seeders have been executed to prevent re-running.",
  1281. "properties": {
  1282. "id": {
  1283. "type": "integer"
  1284. },
  1285. "seederName": {
  1286. "type": "string"
  1287. }
  1288. },
  1289. "required": [
  1290. "id",
  1291. "seederName"
  1292. ],
  1293. "type": "object"
  1294. },
  1295. "Host": {
  1296. "properties": {
  1297. "address": {
  1298. "example": "cdn.example.com",
  1299. "type": "string"
  1300. },
  1301. "allowInsecure": {
  1302. "type": "boolean"
  1303. },
  1304. "alpn": {
  1305. "items": {
  1306. "type": "string"
  1307. },
  1308. "type": "array"
  1309. },
  1310. "createdAt": {
  1311. "format": "int64",
  1312. "type": "integer"
  1313. },
  1314. "echConfigList": {
  1315. "type": "string"
  1316. },
  1317. "excludeFromSubTypes": {
  1318. "items": {
  1319. "type": "string"
  1320. },
  1321. "type": "array"
  1322. },
  1323. "finalMask": {
  1324. "description": "FinalMask is a JSON object of xray finalmask masks (tcp/udp/quicParams),\nmerged into this host's JSON-subscription stream. Empty = no override.",
  1325. "type": "string"
  1326. },
  1327. "fingerprint": {
  1328. "type": "string"
  1329. },
  1330. "groupId": {
  1331. "type": "string"
  1332. },
  1333. "hostHeader": {
  1334. "type": "string"
  1335. },
  1336. "id": {
  1337. "example": 1,
  1338. "type": "integer"
  1339. },
  1340. "inboundId": {
  1341. "example": 1,
  1342. "type": "integer"
  1343. },
  1344. "isDisabled": {
  1345. "type": "boolean"
  1346. },
  1347. "isHidden": {
  1348. "type": "boolean"
  1349. },
  1350. "keepSniBlank": {
  1351. "type": "boolean"
  1352. },
  1353. "mihomoIpVersion": {
  1354. "enum": [
  1355. "dual",
  1356. "ipv4",
  1357. "ipv6",
  1358. "ipv4-prefer",
  1359. "ipv6-prefer"
  1360. ],
  1361. "type": "string"
  1362. },
  1363. "mihomoX25519": {
  1364. "type": "boolean"
  1365. },
  1366. "muxParams": {},
  1367. "nodeGuids": {
  1368. "items": {
  1369. "type": "string"
  1370. },
  1371. "type": "array"
  1372. },
  1373. "overrideSniFromAddress": {
  1374. "type": "boolean"
  1375. },
  1376. "path": {
  1377. "type": "string"
  1378. },
  1379. "pinnedPeerCertSha256": {
  1380. "items": {
  1381. "type": "string"
  1382. },
  1383. "type": "array"
  1384. },
  1385. "port": {
  1386. "example": 8443,
  1387. "maximum": 65535,
  1388. "minimum": 0,
  1389. "type": "integer"
  1390. },
  1391. "remark": {
  1392. "example": "cdn-front",
  1393. "maxLength": 256,
  1394. "type": "string"
  1395. },
  1396. "security": {
  1397. "enum": [
  1398. "same",
  1399. "tls",
  1400. "none",
  1401. "reality"
  1402. ],
  1403. "example": "same",
  1404. "type": "string"
  1405. },
  1406. "serverDescription": {
  1407. "maxLength": 64,
  1408. "type": "string"
  1409. },
  1410. "shuffleHost": {
  1411. "type": "boolean"
  1412. },
  1413. "sni": {
  1414. "type": "string"
  1415. },
  1416. "sockoptParams": {},
  1417. "sortOrder": {
  1418. "type": "integer"
  1419. },
  1420. "tags": {
  1421. "items": {
  1422. "type": "string"
  1423. },
  1424. "type": "array"
  1425. },
  1426. "updatedAt": {
  1427. "format": "int64",
  1428. "type": "integer"
  1429. },
  1430. "verifyPeerCertByName": {
  1431. "type": "string"
  1432. },
  1433. "vlessRoute": {
  1434. "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.",
  1435. "example": "443",
  1436. "type": "string"
  1437. }
  1438. },
  1439. "required": [
  1440. "address",
  1441. "allowInsecure",
  1442. "alpn",
  1443. "createdAt",
  1444. "echConfigList",
  1445. "excludeFromSubTypes",
  1446. "finalMask",
  1447. "fingerprint",
  1448. "groupId",
  1449. "hostHeader",
  1450. "id",
  1451. "inboundId",
  1452. "isDisabled",
  1453. "isHidden",
  1454. "keepSniBlank",
  1455. "mihomoIpVersion",
  1456. "mihomoX25519",
  1457. "muxParams",
  1458. "overrideSniFromAddress",
  1459. "path",
  1460. "pinnedPeerCertSha256",
  1461. "port",
  1462. "remark",
  1463. "security",
  1464. "serverDescription",
  1465. "shuffleHost",
  1466. "sni",
  1467. "sockoptParams",
  1468. "sortOrder",
  1469. "tags",
  1470. "updatedAt",
  1471. "verifyPeerCertByName",
  1472. "vlessRoute"
  1473. ],
  1474. "type": "object"
  1475. },
  1476. "HostGroup": {
  1477. "properties": {
  1478. "allowInsecure": {
  1479. "type": "boolean"
  1480. },
  1481. "alpn": {
  1482. "items": {
  1483. "type": "string"
  1484. },
  1485. "type": "array"
  1486. },
  1487. "echConfigList": {
  1488. "type": "string"
  1489. },
  1490. "excludeFromSubTypes": {
  1491. "items": {
  1492. "type": "string"
  1493. },
  1494. "type": "array"
  1495. },
  1496. "finalMask": {
  1497. "type": "string"
  1498. },
  1499. "fingerprint": {
  1500. "type": "string"
  1501. },
  1502. "groupId": {
  1503. "type": "string"
  1504. },
  1505. "hostHeader": {
  1506. "type": "string"
  1507. },
  1508. "hosts": {
  1509. "items": {
  1510. "type": "string"
  1511. },
  1512. "type": "array"
  1513. },
  1514. "inboundIds": {
  1515. "items": {
  1516. "type": "integer"
  1517. },
  1518. "type": "array"
  1519. },
  1520. "isDisabled": {
  1521. "type": "boolean"
  1522. },
  1523. "isHidden": {
  1524. "type": "boolean"
  1525. },
  1526. "keepSniBlank": {
  1527. "type": "boolean"
  1528. },
  1529. "mihomoIpVersion": {
  1530. "enum": [
  1531. "dual",
  1532. "ipv4",
  1533. "ipv6",
  1534. "ipv4-prefer",
  1535. "ipv6-prefer"
  1536. ],
  1537. "type": "string"
  1538. },
  1539. "mihomoX25519": {
  1540. "type": "boolean"
  1541. },
  1542. "muxParams": {
  1543. "type": "string"
  1544. },
  1545. "nodeGuids": {
  1546. "items": {
  1547. "type": "string"
  1548. },
  1549. "type": "array"
  1550. },
  1551. "overrideSniFromAddress": {
  1552. "type": "boolean"
  1553. },
  1554. "path": {
  1555. "type": "string"
  1556. },
  1557. "pinnedPeerCertSha256": {
  1558. "items": {
  1559. "type": "string"
  1560. },
  1561. "type": "array"
  1562. },
  1563. "port": {
  1564. "maximum": 65535,
  1565. "minimum": 0,
  1566. "type": "integer"
  1567. },
  1568. "remark": {
  1569. "maxLength": 256,
  1570. "type": "string"
  1571. },
  1572. "security": {
  1573. "enum": [
  1574. "same",
  1575. "tls",
  1576. "none",
  1577. "reality"
  1578. ],
  1579. "type": "string"
  1580. },
  1581. "serverDescription": {
  1582. "maxLength": 64,
  1583. "type": "string"
  1584. },
  1585. "shuffleHost": {
  1586. "type": "boolean"
  1587. },
  1588. "sni": {
  1589. "type": "string"
  1590. },
  1591. "sockoptParams": {
  1592. "type": "string"
  1593. },
  1594. "sortOrder": {
  1595. "type": "integer"
  1596. },
  1597. "tags": {
  1598. "items": {
  1599. "type": "string"
  1600. },
  1601. "type": "array"
  1602. },
  1603. "verifyPeerCertByName": {
  1604. "type": "string"
  1605. },
  1606. "vlessRoute": {
  1607. "type": "string"
  1608. }
  1609. },
  1610. "required": [
  1611. "allowInsecure",
  1612. "alpn",
  1613. "echConfigList",
  1614. "excludeFromSubTypes",
  1615. "finalMask",
  1616. "fingerprint",
  1617. "groupId",
  1618. "hostHeader",
  1619. "hosts",
  1620. "inboundIds",
  1621. "isDisabled",
  1622. "isHidden",
  1623. "keepSniBlank",
  1624. "mihomoIpVersion",
  1625. "mihomoX25519",
  1626. "muxParams",
  1627. "nodeGuids",
  1628. "overrideSniFromAddress",
  1629. "path",
  1630. "pinnedPeerCertSha256",
  1631. "port",
  1632. "remark",
  1633. "security",
  1634. "serverDescription",
  1635. "shuffleHost",
  1636. "sni",
  1637. "sockoptParams",
  1638. "sortOrder",
  1639. "tags",
  1640. "verifyPeerCertByName",
  1641. "vlessRoute"
  1642. ],
  1643. "type": "object"
  1644. },
  1645. "Inbound": {
  1646. "description": "Inbound represents an Xray inbound configuration with traffic statistics and settings.",
  1647. "properties": {
  1648. "clientStats": {
  1649. "description": "Client traffic statistics",
  1650. "items": {
  1651. "$ref": "#/components/schemas/ClientTraffic"
  1652. },
  1653. "type": "array"
  1654. },
  1655. "down": {
  1656. "description": "Download traffic in bytes",
  1657. "format": "int64",
  1658. "type": "integer"
  1659. },
  1660. "enable": {
  1661. "description": "Whether the inbound is enabled",
  1662. "example": true,
  1663. "type": "boolean"
  1664. },
  1665. "expiryTime": {
  1666. "description": "Expiration timestamp",
  1667. "format": "int64",
  1668. "type": "integer"
  1669. },
  1670. "fallbackParent": {
  1671. "allOf": [
  1672. {
  1673. "$ref": "#/components/schemas/FallbackParentInfo"
  1674. }
  1675. ],
  1676. "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.",
  1677. "nullable": true
  1678. },
  1679. "id": {
  1680. "description": "Unique identifier",
  1681. "example": 1,
  1682. "type": "integer"
  1683. },
  1684. "lastTrafficResetTime": {
  1685. "description": "Last traffic reset timestamp",
  1686. "format": "int64",
  1687. "type": "integer"
  1688. },
  1689. "listen": {
  1690. "description": "Xray configuration fields",
  1691. "type": "string"
  1692. },
  1693. "nodeId": {
  1694. "nullable": true,
  1695. "type": "integer"
  1696. },
  1697. "originNodeGuid": {
  1698. "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.",
  1699. "type": "string"
  1700. },
  1701. "port": {
  1702. "example": 443,
  1703. "maximum": 65535,
  1704. "minimum": 0,
  1705. "type": "integer"
  1706. },
  1707. "protocol": {
  1708. "enum": [
  1709. "vmess",
  1710. "vless",
  1711. "trojan",
  1712. "shadowsocks",
  1713. "wireguard",
  1714. "hysteria",
  1715. "http",
  1716. "mixed",
  1717. "tunnel",
  1718. "tun",
  1719. "mtproto"
  1720. ],
  1721. "example": "vless",
  1722. "type": "string"
  1723. },
  1724. "remark": {
  1725. "description": "Human-readable remark",
  1726. "example": "VLESS-443",
  1727. "type": "string"
  1728. },
  1729. "settings": {},
  1730. "shareAddr": {
  1731. "type": "string"
  1732. },
  1733. "shareAddrStrategy": {
  1734. "enum": [
  1735. "node",
  1736. "listen",
  1737. "custom"
  1738. ],
  1739. "type": "string"
  1740. },
  1741. "sniffing": {},
  1742. "streamSettings": {},
  1743. "subSortIndex": {
  1744. "description": "1-based sort order of this inbound's links in subscription output only (lower first; ties by id)",
  1745. "example": 1,
  1746. "minimum": 1,
  1747. "type": "integer"
  1748. },
  1749. "tag": {
  1750. "example": "in-443-tcp",
  1751. "type": "string"
  1752. },
  1753. "total": {
  1754. "description": "Total traffic limit in bytes",
  1755. "format": "int64",
  1756. "type": "integer"
  1757. },
  1758. "trafficReset": {
  1759. "description": "Traffic reset schedule",
  1760. "enum": [
  1761. "never",
  1762. "hourly",
  1763. "daily",
  1764. "weekly",
  1765. "monthly"
  1766. ],
  1767. "type": "string"
  1768. },
  1769. "up": {
  1770. "description": "Upload traffic in bytes",
  1771. "format": "int64",
  1772. "type": "integer"
  1773. }
  1774. },
  1775. "required": [
  1776. "clientStats",
  1777. "down",
  1778. "enable",
  1779. "expiryTime",
  1780. "id",
  1781. "lastTrafficResetTime",
  1782. "listen",
  1783. "port",
  1784. "protocol",
  1785. "remark",
  1786. "settings",
  1787. "shareAddr",
  1788. "shareAddrStrategy",
  1789. "sniffing",
  1790. "streamSettings",
  1791. "subSortIndex",
  1792. "tag",
  1793. "total",
  1794. "trafficReset",
  1795. "up"
  1796. ],
  1797. "type": "object"
  1798. },
  1799. "InboundClientIps": {
  1800. "description": "InboundClientIps stores IP addresses associated with inbound clients for access control.",
  1801. "properties": {
  1802. "clientEmail": {
  1803. "type": "string"
  1804. },
  1805. "id": {
  1806. "type": "integer"
  1807. },
  1808. "ips": {}
  1809. },
  1810. "required": [
  1811. "clientEmail",
  1812. "id",
  1813. "ips"
  1814. ],
  1815. "type": "object"
  1816. },
  1817. "InboundFallback": {
  1818. "properties": {
  1819. "alpn": {
  1820. "type": "string"
  1821. },
  1822. "childId": {
  1823. "type": "integer"
  1824. },
  1825. "dest": {
  1826. "type": "string"
  1827. },
  1828. "id": {
  1829. "type": "integer"
  1830. },
  1831. "masterId": {
  1832. "type": "integer"
  1833. },
  1834. "name": {
  1835. "type": "string"
  1836. },
  1837. "path": {
  1838. "type": "string"
  1839. },
  1840. "sortOrder": {
  1841. "type": "integer"
  1842. },
  1843. "xver": {
  1844. "type": "integer"
  1845. }
  1846. },
  1847. "required": [
  1848. "alpn",
  1849. "childId",
  1850. "dest",
  1851. "id",
  1852. "masterId",
  1853. "name",
  1854. "path",
  1855. "sortOrder",
  1856. "xver"
  1857. ],
  1858. "type": "object"
  1859. },
  1860. "InboundOption": {
  1861. "properties": {
  1862. "enable": {
  1863. "example": true,
  1864. "type": "boolean"
  1865. },
  1866. "id": {
  1867. "example": 1,
  1868. "type": "integer"
  1869. },
  1870. "listen": {
  1871. "type": "string"
  1872. },
  1873. "mtprotoDomain": {
  1874. "type": "string"
  1875. },
  1876. "nodeAddress": {
  1877. "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.",
  1878. "type": "string"
  1879. },
  1880. "nodeId": {
  1881. "description": "Hosting node; nil for this panel's own inbounds. Lets the clients\npage map a node filter onto inbound IDs (#4997).",
  1882. "nullable": true,
  1883. "type": "integer"
  1884. },
  1885. "port": {
  1886. "example": 443,
  1887. "type": "integer"
  1888. },
  1889. "protocol": {
  1890. "example": "vless",
  1891. "type": "string"
  1892. },
  1893. "remark": {
  1894. "example": "VLESS-443",
  1895. "type": "string"
  1896. },
  1897. "shareAddr": {
  1898. "type": "string"
  1899. },
  1900. "shareAddrStrategy": {
  1901. "type": "string"
  1902. },
  1903. "ssMethod": {
  1904. "type": "string"
  1905. },
  1906. "tag": {
  1907. "example": "in-443-tcp",
  1908. "type": "string"
  1909. },
  1910. "tlsFlowCapable": {
  1911. "example": true,
  1912. "type": "boolean"
  1913. },
  1914. "wgDns": {
  1915. "type": "string"
  1916. },
  1917. "wgMtu": {
  1918. "type": "integer"
  1919. },
  1920. "wgPublicKey": {
  1921. "type": "string"
  1922. }
  1923. },
  1924. "required": [
  1925. "enable",
  1926. "id",
  1927. "port",
  1928. "protocol",
  1929. "remark",
  1930. "ssMethod",
  1931. "tag",
  1932. "tlsFlowCapable"
  1933. ],
  1934. "type": "object"
  1935. },
  1936. "Msg": {
  1937. "properties": {
  1938. "msg": {
  1939. "type": "string"
  1940. },
  1941. "obj": {},
  1942. "success": {
  1943. "type": "boolean"
  1944. }
  1945. },
  1946. "required": [
  1947. "msg",
  1948. "obj",
  1949. "success"
  1950. ],
  1951. "type": "object"
  1952. },
  1953. "Node": {
  1954. "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.",
  1955. "properties": {
  1956. "activeCount": {
  1957. "example": 23,
  1958. "type": "integer"
  1959. },
  1960. "address": {
  1961. "example": "node1.example.com",
  1962. "type": "string"
  1963. },
  1964. "allowPrivateAddress": {
  1965. "type": "boolean"
  1966. },
  1967. "apiToken": {
  1968. "example": "abcdef0123456789",
  1969. "type": "string"
  1970. },
  1971. "basePath": {
  1972. "example": "/",
  1973. "type": "string"
  1974. },
  1975. "clientCount": {
  1976. "example": 27,
  1977. "type": "integer"
  1978. },
  1979. "configDirty": {
  1980. "type": "boolean"
  1981. },
  1982. "configDirtyAt": {
  1983. "format": "int64",
  1984. "type": "integer"
  1985. },
  1986. "cpuPct": {
  1987. "example": 23.5,
  1988. "type": "number"
  1989. },
  1990. "createdAt": {
  1991. "example": 1700000000,
  1992. "format": "int64",
  1993. "type": "integer"
  1994. },
  1995. "depletedCount": {
  1996. "example": 1,
  1997. "type": "integer"
  1998. },
  1999. "disabledCount": {
  2000. "example": 3,
  2001. "type": "integer"
  2002. },
  2003. "enable": {
  2004. "example": true,
  2005. "type": "boolean"
  2006. },
  2007. "guid": {
  2008. "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.",
  2009. "type": "string"
  2010. },
  2011. "id": {
  2012. "example": 1,
  2013. "type": "integer"
  2014. },
  2015. "inboundCount": {
  2016. "example": 5,
  2017. "type": "integer"
  2018. },
  2019. "inboundSyncMode": {
  2020. "enum": [
  2021. "all",
  2022. "selected"
  2023. ],
  2024. "type": "string"
  2025. },
  2026. "inboundTags": {
  2027. "items": {
  2028. "type": "string"
  2029. },
  2030. "type": "array"
  2031. },
  2032. "lastError": {
  2033. "type": "string"
  2034. },
  2035. "lastHeartbeat": {
  2036. "description": "unix seconds, 0 = never",
  2037. "example": 1700000000,
  2038. "format": "int64",
  2039. "type": "integer"
  2040. },
  2041. "latencyMs": {
  2042. "example": 42,
  2043. "type": "integer"
  2044. },
  2045. "memPct": {
  2046. "example": 45.1,
  2047. "type": "number"
  2048. },
  2049. "name": {
  2050. "example": "de-fra-1",
  2051. "type": "string"
  2052. },
  2053. "netDown": {
  2054. "example": 2097152,
  2055. "format": "int64",
  2056. "type": "integer"
  2057. },
  2058. "netUp": {
  2059. "example": 1048576,
  2060. "format": "int64",
  2061. "type": "integer"
  2062. },
  2063. "onlineCount": {
  2064. "example": 3,
  2065. "type": "integer"
  2066. },
  2067. "outboundTag": {
  2068. "type": "string"
  2069. },
  2070. "panelVersion": {
  2071. "example": "v3.x.x",
  2072. "type": "string"
  2073. },
  2074. "parentGuid": {
  2075. "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.",
  2076. "type": "string"
  2077. },
  2078. "pinnedCertSha256": {
  2079. "type": "string"
  2080. },
  2081. "port": {
  2082. "example": 2053,
  2083. "maximum": 65535,
  2084. "minimum": 1,
  2085. "type": "integer"
  2086. },
  2087. "remark": {
  2088. "type": "string"
  2089. },
  2090. "scheme": {
  2091. "enum": [
  2092. "http",
  2093. "https"
  2094. ],
  2095. "example": "https",
  2096. "type": "string"
  2097. },
  2098. "status": {
  2099. "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",
  2100. "example": "online",
  2101. "type": "string"
  2102. },
  2103. "tlsVerifyMode": {
  2104. "enum": [
  2105. "verify",
  2106. "skip",
  2107. "pin",
  2108. "mtls"
  2109. ],
  2110. "type": "string"
  2111. },
  2112. "transitive": {
  2113. "type": "boolean"
  2114. },
  2115. "updatedAt": {
  2116. "example": 1700000000,
  2117. "format": "int64",
  2118. "type": "integer"
  2119. },
  2120. "uptimeSecs": {
  2121. "example": 86400,
  2122. "format": "int64",
  2123. "type": "integer"
  2124. },
  2125. "xrayError": {
  2126. "type": "string"
  2127. },
  2128. "xrayState": {
  2129. "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.",
  2130. "type": "string"
  2131. },
  2132. "xrayVersion": {
  2133. "example": "25.10.31",
  2134. "type": "string"
  2135. }
  2136. },
  2137. "required": [
  2138. "activeCount",
  2139. "address",
  2140. "allowPrivateAddress",
  2141. "apiToken",
  2142. "basePath",
  2143. "clientCount",
  2144. "configDirty",
  2145. "configDirtyAt",
  2146. "cpuPct",
  2147. "createdAt",
  2148. "depletedCount",
  2149. "disabledCount",
  2150. "enable",
  2151. "guid",
  2152. "id",
  2153. "inboundCount",
  2154. "inboundSyncMode",
  2155. "inboundTags",
  2156. "lastError",
  2157. "lastHeartbeat",
  2158. "latencyMs",
  2159. "memPct",
  2160. "name",
  2161. "netDown",
  2162. "netUp",
  2163. "onlineCount",
  2164. "outboundTag",
  2165. "panelVersion",
  2166. "pinnedCertSha256",
  2167. "port",
  2168. "remark",
  2169. "scheme",
  2170. "status",
  2171. "tlsVerifyMode",
  2172. "updatedAt",
  2173. "uptimeSecs",
  2174. "xrayError",
  2175. "xrayState",
  2176. "xrayVersion"
  2177. ],
  2178. "type": "object"
  2179. },
  2180. "OutboundTraffics": {
  2181. "description": "OutboundTraffics tracks traffic statistics for Xray outbound connections.",
  2182. "properties": {
  2183. "down": {
  2184. "format": "int64",
  2185. "type": "integer"
  2186. },
  2187. "id": {
  2188. "type": "integer"
  2189. },
  2190. "tag": {
  2191. "type": "string"
  2192. },
  2193. "total": {
  2194. "format": "int64",
  2195. "type": "integer"
  2196. },
  2197. "up": {
  2198. "format": "int64",
  2199. "type": "integer"
  2200. }
  2201. },
  2202. "required": [
  2203. "down",
  2204. "id",
  2205. "tag",
  2206. "total",
  2207. "up"
  2208. ],
  2209. "type": "object"
  2210. },
  2211. "PanelUpdateStatus": {
  2212. "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.",
  2213. "properties": {
  2214. "exitCode": {
  2215. "example": 0,
  2216. "type": "integer"
  2217. },
  2218. "finishedAt": {
  2219. "example": 1735689612,
  2220. "format": "int64",
  2221. "type": "integer"
  2222. },
  2223. "runId": {
  2224. "example": "1735689600123456789",
  2225. "type": "string"
  2226. },
  2227. "state": {
  2228. "example": "success",
  2229. "type": "string"
  2230. }
  2231. },
  2232. "required": [
  2233. "exitCode",
  2234. "finishedAt",
  2235. "runId",
  2236. "state"
  2237. ],
  2238. "type": "object"
  2239. },
  2240. "ProbeResultUI": {
  2241. "properties": {
  2242. "cpuPct": {
  2243. "example": 12.5,
  2244. "type": "number"
  2245. },
  2246. "error": {
  2247. "type": "string"
  2248. },
  2249. "latencyMs": {
  2250. "example": 42,
  2251. "type": "integer"
  2252. },
  2253. "memPct": {
  2254. "example": 45.2,
  2255. "type": "number"
  2256. },
  2257. "panelVersion": {
  2258. "example": "v3.x.x",
  2259. "type": "string"
  2260. },
  2261. "status": {
  2262. "example": "online",
  2263. "type": "string"
  2264. },
  2265. "uptimeSecs": {
  2266. "example": 86400,
  2267. "format": "int64",
  2268. "type": "integer"
  2269. },
  2270. "xrayError": {
  2271. "type": "string"
  2272. },
  2273. "xrayState": {
  2274. "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.",
  2275. "type": "string"
  2276. },
  2277. "xrayVersion": {
  2278. "example": "25.10.31",
  2279. "type": "string"
  2280. }
  2281. },
  2282. "required": [
  2283. "cpuPct",
  2284. "error",
  2285. "latencyMs",
  2286. "memPct",
  2287. "panelVersion",
  2288. "status",
  2289. "uptimeSecs",
  2290. "xrayError",
  2291. "xrayState",
  2292. "xrayVersion"
  2293. ],
  2294. "type": "object"
  2295. },
  2296. "RealityScanResult": {
  2297. "properties": {
  2298. "alpn": {
  2299. "example": "h2",
  2300. "type": "string"
  2301. },
  2302. "certIssuer": {
  2303. "example": "Google Trust Services",
  2304. "type": "string"
  2305. },
  2306. "certSubject": {
  2307. "example": "cloudflare.com",
  2308. "type": "string"
  2309. },
  2310. "certValid": {
  2311. "example": true,
  2312. "type": "boolean"
  2313. },
  2314. "curveID": {
  2315. "example": "X25519",
  2316. "type": "string"
  2317. },
  2318. "feasible": {
  2319. "example": true,
  2320. "type": "boolean"
  2321. },
  2322. "h2": {
  2323. "example": true,
  2324. "type": "boolean"
  2325. },
  2326. "host": {
  2327. "example": "www.cloudflare.com",
  2328. "type": "string"
  2329. },
  2330. "ip": {
  2331. "example": "104.16.124.96",
  2332. "type": "string"
  2333. },
  2334. "latencyMs": {
  2335. "example": 180,
  2336. "type": "integer"
  2337. },
  2338. "notAfter": {
  2339. "example": "2026-08-01T00:00:00Z",
  2340. "type": "string"
  2341. },
  2342. "port": {
  2343. "example": 443,
  2344. "type": "integer"
  2345. },
  2346. "reason": {
  2347. "type": "string"
  2348. },
  2349. "serverNames": {
  2350. "items": {
  2351. "type": "string"
  2352. },
  2353. "type": "array"
  2354. },
  2355. "target": {
  2356. "example": "www.cloudflare.com:443",
  2357. "type": "string"
  2358. },
  2359. "tls13": {
  2360. "example": true,
  2361. "type": "boolean"
  2362. },
  2363. "tlsVersion": {
  2364. "example": "1.3",
  2365. "type": "string"
  2366. },
  2367. "x25519": {
  2368. "example": true,
  2369. "type": "boolean"
  2370. }
  2371. },
  2372. "required": [
  2373. "alpn",
  2374. "certIssuer",
  2375. "certSubject",
  2376. "certValid",
  2377. "curveID",
  2378. "feasible",
  2379. "h2",
  2380. "host",
  2381. "ip",
  2382. "latencyMs",
  2383. "notAfter",
  2384. "port",
  2385. "reason",
  2386. "serverNames",
  2387. "target",
  2388. "tls13",
  2389. "tlsVersion",
  2390. "x25519"
  2391. ],
  2392. "type": "object"
  2393. },
  2394. "Setting": {
  2395. "description": "Setting stores key-value configuration settings for the 3x-ui panel.",
  2396. "properties": {
  2397. "id": {
  2398. "type": "integer"
  2399. },
  2400. "key": {
  2401. "type": "string"
  2402. },
  2403. "value": {
  2404. "type": "string"
  2405. }
  2406. },
  2407. "required": [
  2408. "id",
  2409. "key",
  2410. "value"
  2411. ],
  2412. "type": "object"
  2413. },
  2414. "User": {
  2415. "description": "User represents a user account in the 3x-ui panel.",
  2416. "properties": {
  2417. "id": {
  2418. "type": "integer"
  2419. },
  2420. "password": {
  2421. "type": "string"
  2422. },
  2423. "username": {
  2424. "type": "string"
  2425. }
  2426. },
  2427. "required": [
  2428. "id",
  2429. "password",
  2430. "username"
  2431. ],
  2432. "type": "object"
  2433. }
  2434. };