| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374 |
- // Code generated by tools/openapigen. DO NOT EDIT.
- export const SCHEMAS: Record<string, unknown> = {
- "AllSetting": {
- "description": "AllSetting contains all configuration settings for the 3x-ui panel including web server, Telegram bot, and subscription settings.",
- "properties": {
- "datepicker": {
- "description": "Date picker format",
- "type": "string"
- },
- "expireDiff": {
- "description": "Expiration warning threshold in days",
- "minimum": 0,
- "type": "integer"
- },
- "externalTrafficInformEnable": {
- "description": "Enable external traffic reporting",
- "type": "boolean"
- },
- "externalTrafficInformURI": {
- "description": "URI for external traffic reporting",
- "type": "string"
- },
- "ldapAutoCreate": {
- "type": "boolean"
- },
- "ldapAutoDelete": {
- "type": "boolean"
- },
- "ldapBaseDN": {
- "type": "string"
- },
- "ldapBindDN": {
- "type": "string"
- },
- "ldapDefaultExpiryDays": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapDefaultLimitIP": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapDefaultTotalGB": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapEnable": {
- "description": "LDAP settings",
- "type": "boolean"
- },
- "ldapFlagField": {
- "description": "Generic flag configuration",
- "type": "string"
- },
- "ldapHost": {
- "type": "string"
- },
- "ldapInboundTags": {
- "type": "string"
- },
- "ldapInsecureSkipVerify": {
- "type": "boolean"
- },
- "ldapInvertFlag": {
- "type": "boolean"
- },
- "ldapPassword": {
- "type": "string"
- },
- "ldapPort": {
- "maximum": 65535,
- "minimum": 0,
- "type": "integer"
- },
- "ldapSyncCron": {
- "type": "string"
- },
- "ldapTruthyValues": {
- "type": "string"
- },
- "ldapUseTLS": {
- "type": "boolean"
- },
- "ldapUserAttr": {
- "description": "e.g., mail or uid",
- "type": "string"
- },
- "ldapUserFilter": {
- "type": "string"
- },
- "ldapVlessField": {
- "type": "string"
- },
- "pageSize": {
- "description": "UI settings\nNumber of items per page in lists (0 disables pagination)",
- "maximum": 1000,
- "minimum": 0,
- "type": "integer"
- },
- "panelOutbound": {
- "description": "Xray outbound tag for the panel's own outbound HTTP (update checks/downloads, Telegram, geo updates, outbound-subscription fetches)",
- "type": "string"
- },
- "remarkTemplate": {
- "description": "Subscription remark template ({{VAR}} tokens) rendered per client",
- "type": "string"
- },
- "restartXrayOnClientDisable": {
- "description": "Restart Xray when clients are auto-disabled by expiry/traffic limit",
- "type": "boolean"
- },
- "sessionMaxAge": {
- "description": "Session maximum age in minutes (cap at one year)",
- "maximum": 525600,
- "minimum": 1,
- "type": "integer"
- },
- "smtpCpu": {
- "description": "CPU threshold for email notifications",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "smtpEnable": {
- "description": "Email (SMTP) notification settings\nEnable email notifications",
- "type": "boolean"
- },
- "smtpEnabledEvents": {
- "description": "Comma-separated event types to send via email",
- "type": "string"
- },
- "smtpEncryptionType": {
- "description": "SMTP encryption: none, starttls, tls",
- "type": "string"
- },
- "smtpHost": {
- "description": "SMTP server host",
- "type": "string"
- },
- "smtpMemory": {
- "description": "Memory threshold for email notifications",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "smtpPassword": {
- "description": "SMTP password",
- "type": "string"
- },
- "smtpPort": {
- "description": "SMTP server port",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- },
- "smtpTo": {
- "description": "Comma-separated recipient emails",
- "type": "string"
- },
- "smtpUsername": {
- "description": "SMTP username",
- "type": "string"
- },
- "subAnnounce": {
- "description": "Subscription announce",
- "type": "string"
- },
- "subCertFile": {
- "description": "SSL certificate file for subscription server",
- "type": "string"
- },
- "subClashEnable": {
- "description": "Enable Clash/Mihomo subscription endpoint",
- "type": "boolean"
- },
- "subClashEnableRouting": {
- "description": "Enable global routing rules for Clash/Mihomo",
- "type": "boolean"
- },
- "subClashPath": {
- "description": "Path for Clash/Mihomo subscription endpoint",
- "type": "string"
- },
- "subClashRules": {
- "description": "Clash/Mihomo global routing rules",
- "type": "string"
- },
- "subClashURI": {
- "description": "Clash/Mihomo subscription server URI",
- "type": "string"
- },
- "subDomain": {
- "description": "Domain for subscription server validation",
- "type": "string"
- },
- "subEnable": {
- "description": "Subscription server settings\nEnable subscription server",
- "type": "boolean"
- },
- "subEnableRouting": {
- "description": "Enable routing for subscription",
- "type": "boolean"
- },
- "subEncrypt": {
- "description": "Encrypt subscription responses",
- "type": "boolean"
- },
- "subHideSettings": {
- "description": "Hide server settings in happ subscription (Only for Happ)",
- "type": "boolean"
- },
- "subIncyEnableRouting": {
- "description": "Enable routing injection for the Incy client",
- "type": "boolean"
- },
- "subIncyRoutingRules": {
- "description": "Incy routing deep-link injected into the subscription body (Only for Incy)",
- "type": "string"
- },
- "subJsonEnable": {
- "description": "Enable JSON subscription endpoint",
- "type": "boolean"
- },
- "subJsonFinalMask": {
- "description": "JSON subscription global finalmask (tcp/udp masks + quicParams)",
- "type": "string"
- },
- "subJsonMux": {
- "description": "JSON subscription mux configuration",
- "type": "string"
- },
- "subJsonPath": {
- "description": "Path for JSON subscription endpoint",
- "type": "string"
- },
- "subJsonRules": {
- "type": "string"
- },
- "subJsonURI": {
- "description": "JSON subscription server URI",
- "type": "string"
- },
- "subKeyFile": {
- "description": "SSL private key file for subscription server",
- "type": "string"
- },
- "subListen": {
- "description": "Subscription server listen IP",
- "type": "string"
- },
- "subPath": {
- "description": "Base path for subscription URLs",
- "type": "string"
- },
- "subPort": {
- "description": "Subscription server port",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- },
- "subProfileUrl": {
- "description": "Subscription profile URL",
- "type": "string"
- },
- "subRoutingRules": {
- "description": "Subscription global routing rules (Only for Happ)",
- "type": "string"
- },
- "subSupportUrl": {
- "description": "Subscription support URL",
- "type": "string"
- },
- "subThemeDir": {
- "description": "Absolute path to a folder containing a custom subscription page template",
- "type": "string"
- },
- "subTitle": {
- "description": "Subscription title",
- "type": "string"
- },
- "subURI": {
- "description": "Subscription server URI",
- "type": "string"
- },
- "subUpdates": {
- "description": "Subscription update interval in minutes",
- "maximum": 525600,
- "minimum": 0,
- "type": "integer"
- },
- "tgBotAPIServer": {
- "description": "Custom API server for Telegram bot",
- "type": "string"
- },
- "tgBotBackup": {
- "description": "Enable database backup via Telegram",
- "type": "boolean"
- },
- "tgBotChatId": {
- "description": "Telegram chat ID for notifications",
- "type": "string"
- },
- "tgBotEnable": {
- "description": "Telegram bot settings\nEnable Telegram bot notifications",
- "type": "boolean"
- },
- "tgBotProxy": {
- "description": "Proxy URL for Telegram bot",
- "type": "string"
- },
- "tgBotToken": {
- "description": "Telegram bot token",
- "type": "string"
- },
- "tgCpu": {
- "description": "CPU usage threshold for alerts (percent)",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "tgEnabledEvents": {
- "description": "Comma-separated event types to send via Telegram",
- "type": "string"
- },
- "tgLang": {
- "description": "Telegram bot language",
- "type": "string"
- },
- "tgMemory": {
- "description": "Memory usage threshold for alerts (percent)",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "tgRunTime": {
- "description": "Cron schedule for Telegram notifications",
- "type": "string"
- },
- "timeLocation": {
- "description": "Security settings\nTime zone location",
- "type": "string"
- },
- "trafficDiff": {
- "description": "Traffic warning threshold percentage",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "trustedProxyCIDRs": {
- "description": "Trusted reverse proxy IPs/CIDRs for forwarded headers",
- "type": "string"
- },
- "twoFactorEnable": {
- "description": "Enable two-factor authentication",
- "type": "boolean"
- },
- "twoFactorToken": {
- "description": "Two-factor authentication token",
- "type": "string"
- },
- "warpUpdateInterval": {
- "description": "WARP",
- "minimum": 0,
- "type": "integer"
- },
- "webBasePath": {
- "description": "Base path for web panel URLs",
- "type": "string"
- },
- "webCertFile": {
- "description": "Path to SSL certificate file for web server",
- "type": "string"
- },
- "webDomain": {
- "description": "Web server domain for domain validation",
- "type": "string"
- },
- "webKeyFile": {
- "description": "Path to SSL private key file for web server",
- "type": "string"
- },
- "webListen": {
- "description": "Web server settings\nWeb server listen IP address",
- "type": "string"
- },
- "webPort": {
- "description": "Web server port number",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "datepicker",
- "expireDiff",
- "externalTrafficInformEnable",
- "externalTrafficInformURI",
- "ldapAutoCreate",
- "ldapAutoDelete",
- "ldapBaseDN",
- "ldapBindDN",
- "ldapDefaultExpiryDays",
- "ldapDefaultLimitIP",
- "ldapDefaultTotalGB",
- "ldapEnable",
- "ldapFlagField",
- "ldapHost",
- "ldapInboundTags",
- "ldapInsecureSkipVerify",
- "ldapInvertFlag",
- "ldapPassword",
- "ldapPort",
- "ldapSyncCron",
- "ldapTruthyValues",
- "ldapUseTLS",
- "ldapUserAttr",
- "ldapUserFilter",
- "ldapVlessField",
- "pageSize",
- "panelOutbound",
- "remarkTemplate",
- "restartXrayOnClientDisable",
- "sessionMaxAge",
- "smtpCpu",
- "smtpEnable",
- "smtpEnabledEvents",
- "smtpEncryptionType",
- "smtpHost",
- "smtpMemory",
- "smtpPassword",
- "smtpPort",
- "smtpTo",
- "smtpUsername",
- "subAnnounce",
- "subCertFile",
- "subClashEnable",
- "subClashEnableRouting",
- "subClashPath",
- "subClashRules",
- "subClashURI",
- "subDomain",
- "subEnable",
- "subEnableRouting",
- "subEncrypt",
- "subHideSettings",
- "subIncyEnableRouting",
- "subIncyRoutingRules",
- "subJsonEnable",
- "subJsonFinalMask",
- "subJsonMux",
- "subJsonPath",
- "subJsonRules",
- "subJsonURI",
- "subKeyFile",
- "subListen",
- "subPath",
- "subPort",
- "subProfileUrl",
- "subRoutingRules",
- "subSupportUrl",
- "subThemeDir",
- "subTitle",
- "subURI",
- "subUpdates",
- "tgBotAPIServer",
- "tgBotBackup",
- "tgBotChatId",
- "tgBotEnable",
- "tgBotProxy",
- "tgBotToken",
- "tgCpu",
- "tgEnabledEvents",
- "tgLang",
- "tgMemory",
- "tgRunTime",
- "timeLocation",
- "trafficDiff",
- "trustedProxyCIDRs",
- "twoFactorEnable",
- "twoFactorToken",
- "warpUpdateInterval",
- "webBasePath",
- "webCertFile",
- "webDomain",
- "webKeyFile",
- "webListen",
- "webPort"
- ],
- "type": "object"
- },
- "AllSettingView": {
- "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.",
- "properties": {
- "datepicker": {
- "description": "Date picker format",
- "type": "string"
- },
- "expireDiff": {
- "description": "Expiration warning threshold in days",
- "minimum": 0,
- "type": "integer"
- },
- "externalTrafficInformEnable": {
- "description": "Enable external traffic reporting",
- "type": "boolean"
- },
- "externalTrafficInformURI": {
- "description": "URI for external traffic reporting",
- "type": "string"
- },
- "hasApiToken": {
- "type": "boolean"
- },
- "hasLdapPassword": {
- "type": "boolean"
- },
- "hasNordSecret": {
- "type": "boolean"
- },
- "hasSmtpPassword": {
- "type": "boolean"
- },
- "hasTgBotToken": {
- "type": "boolean"
- },
- "hasTwoFactorToken": {
- "type": "boolean"
- },
- "hasWarpSecret": {
- "type": "boolean"
- },
- "ldapAutoCreate": {
- "type": "boolean"
- },
- "ldapAutoDelete": {
- "type": "boolean"
- },
- "ldapBaseDN": {
- "type": "string"
- },
- "ldapBindDN": {
- "type": "string"
- },
- "ldapDefaultExpiryDays": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapDefaultLimitIP": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapDefaultTotalGB": {
- "minimum": 0,
- "type": "integer"
- },
- "ldapEnable": {
- "description": "LDAP settings",
- "type": "boolean"
- },
- "ldapFlagField": {
- "description": "Generic flag configuration",
- "type": "string"
- },
- "ldapHost": {
- "type": "string"
- },
- "ldapInboundTags": {
- "type": "string"
- },
- "ldapInsecureSkipVerify": {
- "type": "boolean"
- },
- "ldapInvertFlag": {
- "type": "boolean"
- },
- "ldapPassword": {
- "type": "string"
- },
- "ldapPort": {
- "maximum": 65535,
- "minimum": 0,
- "type": "integer"
- },
- "ldapSyncCron": {
- "type": "string"
- },
- "ldapTruthyValues": {
- "type": "string"
- },
- "ldapUseTLS": {
- "type": "boolean"
- },
- "ldapUserAttr": {
- "description": "e.g., mail or uid",
- "type": "string"
- },
- "ldapUserFilter": {
- "type": "string"
- },
- "ldapVlessField": {
- "type": "string"
- },
- "pageSize": {
- "description": "UI settings\nNumber of items per page in lists (0 disables pagination)",
- "maximum": 1000,
- "minimum": 0,
- "type": "integer"
- },
- "panelOutbound": {
- "description": "Xray outbound tag for the panel's own outbound HTTP (update checks/downloads, Telegram, geo updates, outbound-subscription fetches)",
- "type": "string"
- },
- "remarkTemplate": {
- "description": "Subscription remark template ({{VAR}} tokens) rendered per client",
- "type": "string"
- },
- "restartXrayOnClientDisable": {
- "description": "Restart Xray when clients are auto-disabled by expiry/traffic limit",
- "type": "boolean"
- },
- "sessionMaxAge": {
- "description": "Session maximum age in minutes (cap at one year)",
- "maximum": 525600,
- "minimum": 1,
- "type": "integer"
- },
- "smtpCpu": {
- "description": "CPU threshold for email notifications",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "smtpEnable": {
- "description": "Email (SMTP) notification settings\nEnable email notifications",
- "type": "boolean"
- },
- "smtpEnabledEvents": {
- "description": "Comma-separated event types to send via email",
- "type": "string"
- },
- "smtpEncryptionType": {
- "description": "SMTP encryption: none, starttls, tls",
- "type": "string"
- },
- "smtpHost": {
- "description": "SMTP server host",
- "type": "string"
- },
- "smtpMemory": {
- "description": "Memory threshold for email notifications",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "smtpPassword": {
- "description": "SMTP password",
- "type": "string"
- },
- "smtpPort": {
- "description": "SMTP server port",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- },
- "smtpTo": {
- "description": "Comma-separated recipient emails",
- "type": "string"
- },
- "smtpUsername": {
- "description": "SMTP username",
- "type": "string"
- },
- "subAnnounce": {
- "description": "Subscription announce",
- "type": "string"
- },
- "subCertFile": {
- "description": "SSL certificate file for subscription server",
- "type": "string"
- },
- "subClashEnable": {
- "description": "Enable Clash/Mihomo subscription endpoint",
- "type": "boolean"
- },
- "subClashEnableRouting": {
- "description": "Enable global routing rules for Clash/Mihomo",
- "type": "boolean"
- },
- "subClashPath": {
- "description": "Path for Clash/Mihomo subscription endpoint",
- "type": "string"
- },
- "subClashRules": {
- "description": "Clash/Mihomo global routing rules",
- "type": "string"
- },
- "subClashURI": {
- "description": "Clash/Mihomo subscription server URI",
- "type": "string"
- },
- "subDomain": {
- "description": "Domain for subscription server validation",
- "type": "string"
- },
- "subEnable": {
- "description": "Subscription server settings\nEnable subscription server",
- "type": "boolean"
- },
- "subEnableRouting": {
- "description": "Enable routing for subscription",
- "type": "boolean"
- },
- "subEncrypt": {
- "description": "Encrypt subscription responses",
- "type": "boolean"
- },
- "subHideSettings": {
- "description": "Hide server settings in happ subscription (Only for Happ)",
- "type": "boolean"
- },
- "subIncyEnableRouting": {
- "description": "Enable routing injection for the Incy client",
- "type": "boolean"
- },
- "subIncyRoutingRules": {
- "description": "Incy routing deep-link injected into the subscription body (Only for Incy)",
- "type": "string"
- },
- "subJsonEnable": {
- "description": "Enable JSON subscription endpoint",
- "type": "boolean"
- },
- "subJsonFinalMask": {
- "description": "JSON subscription global finalmask (tcp/udp masks + quicParams)",
- "type": "string"
- },
- "subJsonMux": {
- "description": "JSON subscription mux configuration",
- "type": "string"
- },
- "subJsonPath": {
- "description": "Path for JSON subscription endpoint",
- "type": "string"
- },
- "subJsonRules": {
- "type": "string"
- },
- "subJsonURI": {
- "description": "JSON subscription server URI",
- "type": "string"
- },
- "subKeyFile": {
- "description": "SSL private key file for subscription server",
- "type": "string"
- },
- "subListen": {
- "description": "Subscription server listen IP",
- "type": "string"
- },
- "subPath": {
- "description": "Base path for subscription URLs",
- "type": "string"
- },
- "subPort": {
- "description": "Subscription server port",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- },
- "subProfileUrl": {
- "description": "Subscription profile URL",
- "type": "string"
- },
- "subRoutingRules": {
- "description": "Subscription global routing rules (Only for Happ)",
- "type": "string"
- },
- "subSupportUrl": {
- "description": "Subscription support URL",
- "type": "string"
- },
- "subThemeDir": {
- "description": "Absolute path to a folder containing a custom subscription page template",
- "type": "string"
- },
- "subTitle": {
- "description": "Subscription title",
- "type": "string"
- },
- "subURI": {
- "description": "Subscription server URI",
- "type": "string"
- },
- "subUpdates": {
- "description": "Subscription update interval in minutes",
- "maximum": 525600,
- "minimum": 0,
- "type": "integer"
- },
- "tgBotAPIServer": {
- "description": "Custom API server for Telegram bot",
- "type": "string"
- },
- "tgBotBackup": {
- "description": "Enable database backup via Telegram",
- "type": "boolean"
- },
- "tgBotChatId": {
- "description": "Telegram chat ID for notifications",
- "type": "string"
- },
- "tgBotEnable": {
- "description": "Telegram bot settings\nEnable Telegram bot notifications",
- "type": "boolean"
- },
- "tgBotProxy": {
- "description": "Proxy URL for Telegram bot",
- "type": "string"
- },
- "tgBotToken": {
- "description": "Telegram bot token",
- "type": "string"
- },
- "tgCpu": {
- "description": "CPU usage threshold for alerts (percent)",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "tgEnabledEvents": {
- "description": "Comma-separated event types to send via Telegram",
- "type": "string"
- },
- "tgLang": {
- "description": "Telegram bot language",
- "type": "string"
- },
- "tgMemory": {
- "description": "Memory usage threshold for alerts (percent)",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "tgRunTime": {
- "description": "Cron schedule for Telegram notifications",
- "type": "string"
- },
- "timeLocation": {
- "description": "Security settings\nTime zone location",
- "type": "string"
- },
- "trafficDiff": {
- "description": "Traffic warning threshold percentage",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
- },
- "trustedProxyCIDRs": {
- "description": "Trusted reverse proxy IPs/CIDRs for forwarded headers",
- "type": "string"
- },
- "twoFactorEnable": {
- "description": "Enable two-factor authentication",
- "type": "boolean"
- },
- "twoFactorToken": {
- "description": "Two-factor authentication token",
- "type": "string"
- },
- "warpUpdateInterval": {
- "description": "WARP",
- "minimum": 0,
- "type": "integer"
- },
- "webBasePath": {
- "description": "Base path for web panel URLs",
- "type": "string"
- },
- "webCertFile": {
- "description": "Path to SSL certificate file for web server",
- "type": "string"
- },
- "webDomain": {
- "description": "Web server domain for domain validation",
- "type": "string"
- },
- "webKeyFile": {
- "description": "Path to SSL private key file for web server",
- "type": "string"
- },
- "webListen": {
- "description": "Web server settings\nWeb server listen IP address",
- "type": "string"
- },
- "webPort": {
- "description": "Web server port number",
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "datepicker",
- "expireDiff",
- "externalTrafficInformEnable",
- "externalTrafficInformURI",
- "hasApiToken",
- "hasLdapPassword",
- "hasNordSecret",
- "hasSmtpPassword",
- "hasTgBotToken",
- "hasTwoFactorToken",
- "hasWarpSecret",
- "ldapAutoCreate",
- "ldapAutoDelete",
- "ldapBaseDN",
- "ldapBindDN",
- "ldapDefaultExpiryDays",
- "ldapDefaultLimitIP",
- "ldapDefaultTotalGB",
- "ldapEnable",
- "ldapFlagField",
- "ldapHost",
- "ldapInboundTags",
- "ldapInsecureSkipVerify",
- "ldapInvertFlag",
- "ldapPassword",
- "ldapPort",
- "ldapSyncCron",
- "ldapTruthyValues",
- "ldapUseTLS",
- "ldapUserAttr",
- "ldapUserFilter",
- "ldapVlessField",
- "pageSize",
- "panelOutbound",
- "remarkTemplate",
- "restartXrayOnClientDisable",
- "sessionMaxAge",
- "smtpCpu",
- "smtpEnable",
- "smtpEnabledEvents",
- "smtpEncryptionType",
- "smtpHost",
- "smtpMemory",
- "smtpPassword",
- "smtpPort",
- "smtpTo",
- "smtpUsername",
- "subAnnounce",
- "subCertFile",
- "subClashEnable",
- "subClashEnableRouting",
- "subClashPath",
- "subClashRules",
- "subClashURI",
- "subDomain",
- "subEnable",
- "subEnableRouting",
- "subEncrypt",
- "subHideSettings",
- "subIncyEnableRouting",
- "subIncyRoutingRules",
- "subJsonEnable",
- "subJsonFinalMask",
- "subJsonMux",
- "subJsonPath",
- "subJsonRules",
- "subJsonURI",
- "subKeyFile",
- "subListen",
- "subPath",
- "subPort",
- "subProfileUrl",
- "subRoutingRules",
- "subSupportUrl",
- "subThemeDir",
- "subTitle",
- "subURI",
- "subUpdates",
- "tgBotAPIServer",
- "tgBotBackup",
- "tgBotChatId",
- "tgBotEnable",
- "tgBotProxy",
- "tgBotToken",
- "tgCpu",
- "tgEnabledEvents",
- "tgLang",
- "tgMemory",
- "tgRunTime",
- "timeLocation",
- "trafficDiff",
- "trustedProxyCIDRs",
- "twoFactorEnable",
- "twoFactorToken",
- "warpUpdateInterval",
- "webBasePath",
- "webCertFile",
- "webDomain",
- "webKeyFile",
- "webListen",
- "webPort"
- ],
- "type": "object"
- },
- "ApiToken": {
- "properties": {
- "createdAt": {
- "type": "integer"
- },
- "enabled": {
- "type": "boolean"
- },
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "token": {
- "description": "SHA-256 hash; the plaintext is shown only once at creation",
- "type": "string"
- }
- },
- "required": [
- "createdAt",
- "enabled",
- "id",
- "name",
- "token"
- ],
- "type": "object"
- },
- "ApiTokenView": {
- "properties": {
- "createdAt": {
- "example": 1736000000,
- "type": "integer"
- },
- "enabled": {
- "example": true,
- "type": "boolean"
- },
- "id": {
- "example": 2,
- "type": "integer"
- },
- "name": {
- "example": "central-panel-a",
- "type": "string"
- },
- "token": {
- "example": "new-token-string",
- "type": "string"
- }
- },
- "required": [
- "createdAt",
- "enabled",
- "id",
- "name"
- ],
- "type": "object"
- },
- "Client": {
- "description": "Client represents a client configuration for Xray inbounds with traffic limits and settings.",
- "properties": {
- "allowedIPs": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "auth": {
- "description": "Auth password (Hysteria)",
- "type": "string"
- },
- "comment": {
- "description": "Client comment",
- "type": "string"
- },
- "created_at": {
- "description": "Creation timestamp",
- "type": "integer"
- },
- "email": {
- "description": "Client email identifier",
- "type": "string"
- },
- "enable": {
- "description": "Whether the client is enabled",
- "type": "boolean"
- },
- "expiryTime": {
- "description": "Expiration timestamp",
- "type": "integer"
- },
- "flow": {
- "description": "Flow control (XTLS)",
- "type": "string"
- },
- "group": {
- "description": "Logical grouping label",
- "type": "string"
- },
- "id": {
- "description": "Unique client identifier",
- "type": "string"
- },
- "keepAlive": {
- "type": "integer"
- },
- "limitIp": {
- "description": "IP limit for this client",
- "type": "integer"
- },
- "password": {
- "description": "Client password",
- "type": "string"
- },
- "preSharedKey": {
- "type": "string"
- },
- "privateKey": {
- "type": "string"
- },
- "publicKey": {
- "type": "string"
- },
- "reset": {
- "description": "Reset period in days",
- "type": "integer"
- },
- "reverse": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ClientReverse"
- }
- ],
- "description": "VLESS simple reverse proxy settings",
- "nullable": true
- },
- "secret": {
- "example": "ee1234567890abcdef1234567890abcd7777772e636c6f7564666c6172652e636f6d",
- "type": "string"
- },
- "security": {
- "description": "Security method (e.g., \"auto\", \"aes-128-gcm\")",
- "type": "string"
- },
- "subId": {
- "description": "Subscription identifier",
- "type": "string"
- },
- "tgId": {
- "description": "Telegram user ID for notifications",
- "type": "integer"
- },
- "totalGB": {
- "description": "Total traffic limit in GB",
- "type": "integer"
- },
- "updated_at": {
- "description": "Last update timestamp",
- "type": "integer"
- }
- },
- "required": [
- "comment",
- "email",
- "enable",
- "expiryTime",
- "limitIp",
- "reset",
- "security",
- "subId",
- "tgId",
- "totalGB"
- ],
- "type": "object"
- },
- "ClientInbound": {
- "properties": {
- "clientId": {
- "type": "integer"
- },
- "createdAt": {
- "type": "integer"
- },
- "flowOverride": {
- "type": "string"
- },
- "inboundId": {
- "type": "integer"
- }
- },
- "required": [
- "clientId",
- "createdAt",
- "flowOverride",
- "inboundId"
- ],
- "type": "object"
- },
- "ClientRecord": {
- "properties": {
- "allowedIPs": {
- "type": "string"
- },
- "auth": {
- "type": "string"
- },
- "comment": {
- "type": "string"
- },
- "createdAt": {
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "enable": {
- "type": "boolean"
- },
- "expiryTime": {
- "type": "integer"
- },
- "flow": {
- "type": "string"
- },
- "group": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "keepAlive": {
- "type": "integer"
- },
- "limitIp": {
- "type": "integer"
- },
- "password": {
- "type": "string"
- },
- "preSharedKey": {
- "type": "string"
- },
- "privateKey": {
- "type": "string"
- },
- "publicKey": {
- "type": "string"
- },
- "reset": {
- "type": "integer"
- },
- "reverse": {},
- "secret": {
- "type": "string"
- },
- "security": {
- "type": "string"
- },
- "subId": {
- "type": "string"
- },
- "tgId": {
- "type": "integer"
- },
- "totalGB": {
- "type": "integer"
- },
- "updatedAt": {
- "type": "integer"
- },
- "uuid": {
- "type": "string"
- }
- },
- "required": [
- "allowedIPs",
- "auth",
- "comment",
- "createdAt",
- "email",
- "enable",
- "expiryTime",
- "flow",
- "group",
- "id",
- "keepAlive",
- "limitIp",
- "password",
- "preSharedKey",
- "privateKey",
- "publicKey",
- "reset",
- "reverse",
- "secret",
- "security",
- "subId",
- "tgId",
- "totalGB",
- "updatedAt",
- "uuid"
- ],
- "type": "object"
- },
- "ClientReverse": {
- "properties": {
- "tag": {
- "type": "string"
- }
- },
- "required": [
- "tag"
- ],
- "type": "object"
- },
- "ClientTraffic": {
- "description": "ClientTraffic represents traffic statistics and limits for a specific client.\nIt tracks upload/download usage, expiry times, and online status for inbound clients.",
- "properties": {
- "down": {
- "example": 2097152,
- "type": "integer"
- },
- "email": {
- "example": "user1",
- "type": "string"
- },
- "enable": {
- "example": true,
- "type": "boolean"
- },
- "expiryTime": {
- "example": 1735689600000,
- "type": "integer"
- },
- "id": {
- "example": 14825,
- "type": "integer"
- },
- "inboundId": {
- "example": 1,
- "type": "integer"
- },
- "lastOnline": {
- "example": 1735680000000,
- "type": "integer"
- },
- "reset": {
- "example": 0,
- "type": "integer"
- },
- "subId": {
- "example": "i7tvdpeffi0hvvf1",
- "type": "string"
- },
- "total": {
- "example": 10737418240,
- "type": "integer"
- },
- "up": {
- "example": 1048576,
- "type": "integer"
- },
- "uuid": {
- "example": "e18c9a96-71bf-48d4-933f-8b9a46d4290c",
- "type": "string"
- }
- },
- "required": [
- "down",
- "email",
- "enable",
- "expiryTime",
- "id",
- "inboundId",
- "lastOnline",
- "reset",
- "subId",
- "total",
- "up",
- "uuid"
- ],
- "type": "object"
- },
- "FallbackParentInfo": {
- "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.",
- "properties": {
- "masterId": {
- "type": "integer"
- },
- "path": {
- "type": "string"
- }
- },
- "required": [
- "masterId"
- ],
- "type": "object"
- },
- "HistoryOfSeeders": {
- "description": "HistoryOfSeeders tracks which database seeders have been executed to prevent re-running.",
- "properties": {
- "id": {
- "type": "integer"
- },
- "seederName": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "seederName"
- ],
- "type": "object"
- },
- "Host": {
- "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.",
- "properties": {
- "address": {
- "example": "cdn.example.com",
- "type": "string"
- },
- "allowInsecure": {
- "type": "boolean"
- },
- "alpn": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "createdAt": {
- "type": "integer"
- },
- "echConfigList": {
- "type": "string"
- },
- "excludeFromSubTypes": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "finalMask": {
- "description": "FinalMask is a JSON object of xray finalmask masks (tcp/udp/quicParams),\nmerged into this host's JSON-subscription stream. Empty = no override.",
- "type": "string"
- },
- "fingerprint": {
- "type": "string"
- },
- "hostHeader": {
- "type": "string"
- },
- "id": {
- "example": 1,
- "type": "integer"
- },
- "inboundId": {
- "example": 1,
- "type": "integer"
- },
- "isDisabled": {
- "type": "boolean"
- },
- "isHidden": {
- "type": "boolean"
- },
- "keepSniBlank": {
- "type": "boolean"
- },
- "mihomoIpVersion": {
- "enum": [
- "dual",
- "ipv4",
- "ipv6",
- "ipv4-prefer",
- "ipv6-prefer"
- ],
- "type": "string"
- },
- "mihomoX25519": {
- "type": "boolean"
- },
- "muxParams": {},
- "nodeGuids": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "overrideSniFromAddress": {
- "type": "boolean"
- },
- "path": {
- "type": "string"
- },
- "pinnedPeerCertSha256": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "port": {
- "example": 8443,
- "maximum": 65535,
- "minimum": 0,
- "type": "integer"
- },
- "remark": {
- "example": "cdn-front",
- "maxLength": 256,
- "type": "string"
- },
- "security": {
- "enum": [
- "same",
- "tls",
- "none",
- "reality"
- ],
- "example": "same",
- "type": "string"
- },
- "serverDescription": {
- "maxLength": 64,
- "type": "string"
- },
- "shuffleHost": {
- "type": "boolean"
- },
- "sni": {
- "type": "string"
- },
- "sockoptParams": {},
- "sortOrder": {
- "type": "integer"
- },
- "tags": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "updatedAt": {
- "type": "integer"
- },
- "verifyPeerCertByName": {
- "type": "string"
- },
- "vlessRoute": {
- "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.",
- "example": "443",
- "type": "string"
- }
- },
- "required": [
- "address",
- "allowInsecure",
- "alpn",
- "createdAt",
- "echConfigList",
- "excludeFromSubTypes",
- "finalMask",
- "fingerprint",
- "hostHeader",
- "id",
- "inboundId",
- "isDisabled",
- "isHidden",
- "keepSniBlank",
- "mihomoIpVersion",
- "mihomoX25519",
- "muxParams",
- "overrideSniFromAddress",
- "path",
- "pinnedPeerCertSha256",
- "port",
- "remark",
- "security",
- "serverDescription",
- "shuffleHost",
- "sni",
- "sockoptParams",
- "sortOrder",
- "tags",
- "updatedAt",
- "verifyPeerCertByName",
- "vlessRoute"
- ],
- "type": "object"
- },
- "Inbound": {
- "description": "Inbound represents an Xray inbound configuration with traffic statistics and settings.",
- "properties": {
- "clientStats": {
- "description": "Client traffic statistics",
- "items": {
- "$ref": "#/components/schemas/ClientTraffic"
- },
- "type": "array"
- },
- "down": {
- "description": "Download traffic in bytes",
- "type": "integer"
- },
- "enable": {
- "description": "Whether the inbound is enabled",
- "example": true,
- "type": "boolean"
- },
- "expiryTime": {
- "description": "Expiration timestamp",
- "type": "integer"
- },
- "fallbackParent": {
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackParentInfo"
- }
- ],
- "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.",
- "nullable": true
- },
- "id": {
- "description": "Unique identifier",
- "example": 1,
- "type": "integer"
- },
- "lastTrafficResetTime": {
- "description": "Last traffic reset timestamp",
- "type": "integer"
- },
- "listen": {
- "description": "Xray configuration fields",
- "type": "string"
- },
- "nodeId": {
- "nullable": true,
- "type": "integer"
- },
- "originNodeGuid": {
- "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.",
- "type": "string"
- },
- "port": {
- "example": 443,
- "maximum": 65535,
- "minimum": 0,
- "type": "integer"
- },
- "protocol": {
- "enum": [
- "vmess",
- "vless",
- "trojan",
- "shadowsocks",
- "wireguard",
- "hysteria",
- "http",
- "mixed",
- "tunnel",
- "tun",
- "mtproto"
- ],
- "example": "vless",
- "type": "string"
- },
- "remark": {
- "description": "Human-readable remark",
- "example": "VLESS-443",
- "type": "string"
- },
- "settings": {},
- "shareAddr": {
- "type": "string"
- },
- "shareAddrStrategy": {
- "enum": [
- "node",
- "listen",
- "custom"
- ],
- "type": "string"
- },
- "sniffing": {},
- "streamSettings": {},
- "subSortIndex": {
- "description": "1-based sort order of this inbound's links in subscription output only (lower first; ties by id)",
- "example": 1,
- "minimum": 1,
- "type": "integer"
- },
- "tag": {
- "example": "in-443-tcp",
- "type": "string"
- },
- "total": {
- "description": "Total traffic limit in bytes",
- "type": "integer"
- },
- "trafficReset": {
- "description": "Traffic reset schedule",
- "enum": [
- "never",
- "hourly",
- "daily",
- "weekly",
- "monthly"
- ],
- "type": "string"
- },
- "up": {
- "description": "Upload traffic in bytes",
- "type": "integer"
- }
- },
- "required": [
- "clientStats",
- "down",
- "enable",
- "expiryTime",
- "id",
- "lastTrafficResetTime",
- "listen",
- "port",
- "protocol",
- "remark",
- "settings",
- "shareAddr",
- "shareAddrStrategy",
- "sniffing",
- "streamSettings",
- "subSortIndex",
- "tag",
- "total",
- "trafficReset",
- "up"
- ],
- "type": "object"
- },
- "InboundClientIps": {
- "description": "InboundClientIps stores IP addresses associated with inbound clients for access control.",
- "properties": {
- "clientEmail": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "ips": {}
- },
- "required": [
- "clientEmail",
- "id",
- "ips"
- ],
- "type": "object"
- },
- "InboundFallback": {
- "properties": {
- "alpn": {
- "type": "string"
- },
- "childId": {
- "type": "integer"
- },
- "dest": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "masterId": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "sortOrder": {
- "type": "integer"
- },
- "xver": {
- "type": "integer"
- }
- },
- "required": [
- "alpn",
- "childId",
- "dest",
- "id",
- "masterId",
- "name",
- "path",
- "sortOrder",
- "xver"
- ],
- "type": "object"
- },
- "InboundOption": {
- "properties": {
- "enable": {
- "example": true,
- "type": "boolean"
- },
- "id": {
- "example": 1,
- "type": "integer"
- },
- "listen": {
- "type": "string"
- },
- "mtprotoDomain": {
- "type": "string"
- },
- "nodeAddress": {
- "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.",
- "type": "string"
- },
- "nodeId": {
- "description": "Hosting node; nil for this panel's own inbounds. Lets the clients\npage map a node filter onto inbound IDs (#4997).",
- "nullable": true,
- "type": "integer"
- },
- "port": {
- "example": 443,
- "type": "integer"
- },
- "protocol": {
- "example": "vless",
- "type": "string"
- },
- "remark": {
- "example": "VLESS-443",
- "type": "string"
- },
- "shareAddr": {
- "type": "string"
- },
- "shareAddrStrategy": {
- "type": "string"
- },
- "ssMethod": {
- "type": "string"
- },
- "tag": {
- "example": "in-443-tcp",
- "type": "string"
- },
- "tlsFlowCapable": {
- "example": true,
- "type": "boolean"
- },
- "wgDns": {
- "type": "string"
- },
- "wgMtu": {
- "type": "integer"
- },
- "wgPublicKey": {
- "type": "string"
- }
- },
- "required": [
- "enable",
- "id",
- "port",
- "protocol",
- "remark",
- "ssMethod",
- "tag",
- "tlsFlowCapable"
- ],
- "type": "object"
- },
- "Msg": {
- "description": "Msg represents a standard API response message with success status, message text, and optional data object.",
- "properties": {
- "msg": {
- "description": "Response message text",
- "type": "string"
- },
- "obj": {
- "description": "Optional data object"
- },
- "success": {
- "description": "Indicates if the operation was successful",
- "type": "boolean"
- }
- },
- "required": [
- "msg",
- "obj",
- "success"
- ],
- "type": "object"
- },
- "Node": {
- "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.",
- "properties": {
- "activeCount": {
- "example": 23,
- "type": "integer"
- },
- "address": {
- "example": "node1.example.com",
- "type": "string"
- },
- "allowPrivateAddress": {
- "type": "boolean"
- },
- "apiToken": {
- "example": "abcdef0123456789",
- "type": "string"
- },
- "basePath": {
- "example": "/",
- "type": "string"
- },
- "clientCount": {
- "example": 27,
- "type": "integer"
- },
- "configDirty": {
- "type": "boolean"
- },
- "configDirtyAt": {
- "type": "integer"
- },
- "cpuPct": {
- "example": 23.5,
- "type": "number"
- },
- "createdAt": {
- "example": 1700000000,
- "type": "integer"
- },
- "depletedCount": {
- "example": 1,
- "type": "integer"
- },
- "disabledCount": {
- "example": 3,
- "type": "integer"
- },
- "enable": {
- "example": true,
- "type": "boolean"
- },
- "guid": {
- "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.",
- "type": "string"
- },
- "id": {
- "example": 1,
- "type": "integer"
- },
- "inboundCount": {
- "example": 5,
- "type": "integer"
- },
- "inboundSyncMode": {
- "enum": [
- "all",
- "selected"
- ],
- "type": "string"
- },
- "inboundTags": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "lastError": {
- "type": "string"
- },
- "lastHeartbeat": {
- "description": "unix seconds, 0 = never",
- "example": 1700000000,
- "type": "integer"
- },
- "latencyMs": {
- "example": 42,
- "type": "integer"
- },
- "memPct": {
- "example": 45.1,
- "type": "number"
- },
- "name": {
- "example": "de-fra-1",
- "type": "string"
- },
- "netDown": {
- "example": 2097152,
- "type": "integer"
- },
- "netUp": {
- "example": 1048576,
- "type": "integer"
- },
- "onlineCount": {
- "example": 3,
- "type": "integer"
- },
- "outboundTag": {
- "type": "string"
- },
- "panelVersion": {
- "example": "v3.x.x",
- "type": "string"
- },
- "parentGuid": {
- "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.",
- "type": "string"
- },
- "pinnedCertSha256": {
- "type": "string"
- },
- "port": {
- "example": 2053,
- "maximum": 65535,
- "minimum": 1,
- "type": "integer"
- },
- "remark": {
- "type": "string"
- },
- "scheme": {
- "enum": [
- "http",
- "https"
- ],
- "example": "https",
- "type": "string"
- },
- "status": {
- "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",
- "example": "online",
- "type": "string"
- },
- "tlsVerifyMode": {
- "enum": [
- "verify",
- "skip",
- "pin",
- "mtls"
- ],
- "type": "string"
- },
- "transitive": {
- "type": "boolean"
- },
- "updatedAt": {
- "example": 1700000000,
- "type": "integer"
- },
- "uptimeSecs": {
- "example": 86400,
- "type": "integer"
- },
- "xrayError": {
- "type": "string"
- },
- "xrayState": {
- "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.",
- "type": "string"
- },
- "xrayVersion": {
- "example": "25.10.31",
- "type": "string"
- }
- },
- "required": [
- "activeCount",
- "address",
- "allowPrivateAddress",
- "apiToken",
- "basePath",
- "clientCount",
- "configDirty",
- "configDirtyAt",
- "cpuPct",
- "createdAt",
- "depletedCount",
- "disabledCount",
- "enable",
- "guid",
- "id",
- "inboundCount",
- "inboundSyncMode",
- "inboundTags",
- "lastError",
- "lastHeartbeat",
- "latencyMs",
- "memPct",
- "name",
- "netDown",
- "netUp",
- "onlineCount",
- "outboundTag",
- "panelVersion",
- "pinnedCertSha256",
- "port",
- "remark",
- "scheme",
- "status",
- "tlsVerifyMode",
- "updatedAt",
- "uptimeSecs",
- "xrayError",
- "xrayState",
- "xrayVersion"
- ],
- "type": "object"
- },
- "OutboundTraffics": {
- "description": "OutboundTraffics tracks traffic statistics for Xray outbound connections.",
- "properties": {
- "down": {
- "type": "integer"
- },
- "id": {
- "type": "integer"
- },
- "tag": {
- "type": "string"
- },
- "total": {
- "type": "integer"
- },
- "up": {
- "type": "integer"
- }
- },
- "required": [
- "down",
- "id",
- "tag",
- "total",
- "up"
- ],
- "type": "object"
- },
- "PanelUpdateStatus": {
- "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.",
- "properties": {
- "exitCode": {
- "example": 0,
- "type": "integer"
- },
- "finishedAt": {
- "example": 1735689612,
- "type": "integer"
- },
- "runId": {
- "example": "1735689600123456789",
- "type": "string"
- },
- "state": {
- "example": "success",
- "type": "string"
- }
- },
- "required": [
- "exitCode",
- "finishedAt",
- "runId",
- "state"
- ],
- "type": "object"
- },
- "ProbeResultUI": {
- "properties": {
- "cpuPct": {
- "example": 12.5,
- "type": "number"
- },
- "error": {
- "type": "string"
- },
- "latencyMs": {
- "example": 42,
- "type": "integer"
- },
- "memPct": {
- "example": 45.2,
- "type": "number"
- },
- "panelVersion": {
- "example": "v3.x.x",
- "type": "string"
- },
- "status": {
- "example": "online",
- "type": "string"
- },
- "uptimeSecs": {
- "example": 86400,
- "type": "integer"
- },
- "xrayError": {
- "type": "string"
- },
- "xrayState": {
- "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.",
- "type": "string"
- },
- "xrayVersion": {
- "example": "25.10.31",
- "type": "string"
- }
- },
- "required": [
- "cpuPct",
- "error",
- "latencyMs",
- "memPct",
- "panelVersion",
- "status",
- "uptimeSecs",
- "xrayError",
- "xrayState",
- "xrayVersion"
- ],
- "type": "object"
- },
- "RealityScanResult": {
- "properties": {
- "alpn": {
- "example": "h2",
- "type": "string"
- },
- "certIssuer": {
- "example": "Google Trust Services",
- "type": "string"
- },
- "certSubject": {
- "example": "cloudflare.com",
- "type": "string"
- },
- "certValid": {
- "example": true,
- "type": "boolean"
- },
- "curveID": {
- "example": "X25519",
- "type": "string"
- },
- "feasible": {
- "example": true,
- "type": "boolean"
- },
- "h2": {
- "example": true,
- "type": "boolean"
- },
- "host": {
- "example": "www.cloudflare.com",
- "type": "string"
- },
- "ip": {
- "example": "104.16.124.96",
- "type": "string"
- },
- "latencyMs": {
- "example": 180,
- "type": "integer"
- },
- "notAfter": {
- "example": "2026-08-01T00:00:00Z",
- "type": "string"
- },
- "port": {
- "example": 443,
- "type": "integer"
- },
- "reason": {
- "type": "string"
- },
- "serverNames": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "target": {
- "example": "www.cloudflare.com:443",
- "type": "string"
- },
- "tls13": {
- "example": true,
- "type": "boolean"
- },
- "tlsVersion": {
- "example": "1.3",
- "type": "string"
- },
- "x25519": {
- "example": true,
- "type": "boolean"
- }
- },
- "required": [
- "alpn",
- "certIssuer",
- "certSubject",
- "certValid",
- "curveID",
- "feasible",
- "h2",
- "host",
- "ip",
- "latencyMs",
- "notAfter",
- "port",
- "reason",
- "serverNames",
- "target",
- "tls13",
- "tlsVersion",
- "x25519"
- ],
- "type": "object"
- },
- "Setting": {
- "description": "Setting stores key-value configuration settings for the 3x-ui panel.",
- "properties": {
- "id": {
- "type": "integer"
- },
- "key": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "key",
- "value"
- ],
- "type": "object"
- },
- "User": {
- "description": "User represents a user account in the 3x-ui panel.",
- "properties": {
- "id": {
- "type": "integer"
- },
- "password": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "password",
- "username"
- ],
- "type": "object"
- }
- };
|