schemas.ts 58 KB

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