diff --git a/frontend/package.json b/frontend/package.json index c82f5f2..e8728bc 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -10,7 +10,7 @@ }, "scripts": { "dev": "vite", - "build": "npm run gen:api && vite build", + "build": "vite build", "preview": "vite preview", "lint": "oxlint src tools", "lint:fix": "oxlint --fix src tools", @@ -22,8 +22,7 @@ "test:watch": "vitest", "storybook": "storybook dev -p 6006", "build-storybook": "storybook build", - "gen": "npm run gen:zod && npm run gen:api", - "gen:api": "node scripts/build-openapi.mjs", + "gen": "npm run gen:zod", "gen:zod": "cd .. && go run ./tools/openapigen", "prepare": "cd .. && husky frontend/.husky || true" }, diff --git a/frontend/public/openapi.json b/frontend/public/openapi.json deleted file mode 100644 index 4fc501c..0000000 --- a/frontend/public/openapi.json +++ /dev/null @@ -1,12802 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "3X-UI Panel API", - "version": "3.x", - "description": "Programmatic interface to a 3X-UI panel. Authenticate either by logging in (cookie) or with an API token from Settings → Security → API Token (Bearer). All endpoints under /panel/api/* honour both modes — an API token is a full-admin credential, so treat it like the panel password." - }, - "servers": [ - { - "url": "/", - "description": "Current panel (basePath aware)" - } - ], - "components": { - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer", - "description": "API token from Settings → Security → API Token. Send as `Authorization: Bearer `." - }, - "cookieAuth": { - "type": "apiKey", - "in": "cookie", - "name": "3x-ui", - "description": "Session cookie set by POST /login. Browser-only." - } - }, - "schemas": { - "AllSetting": { - "properties": { - "datepicker": { - "type": "string" - }, - "expireDiff": { - "minimum": 0, - "type": "integer" - }, - "externalTrafficInformEnable": { - "type": "boolean" - }, - "externalTrafficInformURI": { - "type": "string" - }, - "ipLimitAllowlist": { - "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": { - "type": "boolean" - }, - "ldapFlagField": { - "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": { - "type": "string" - }, - "ldapUserFilter": { - "type": "string" - }, - "ldapVlessField": { - "type": "string" - }, - "outboundDownThreshold": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "pageSize": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - }, - "panelOutbound": { - "type": "string" - }, - "remarkTemplate": { - "type": "string" - }, - "restartXrayOnClientDisable": { - "type": "boolean" - }, - "sessionMaxAge": { - "maximum": 525600, - "minimum": 1, - "type": "integer" - }, - "smtpCpu": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "smtpEnable": { - "type": "boolean" - }, - "smtpEnabledEvents": { - "type": "string" - }, - "smtpEncryptionType": { - "type": "string" - }, - "smtpFrom": { - "type": "string" - }, - "smtpFromName": { - "type": "string" - }, - "smtpHost": { - "type": "string" - }, - "smtpMemory": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "smtpPassword": { - "type": "string" - }, - "smtpPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "smtpTo": { - "type": "string" - }, - "smtpUsername": { - "type": "string" - }, - "subAnnounce": { - "type": "string" - }, - "subCertFile": { - "type": "string" - }, - "subClashAutoDetect": { - "type": "boolean" - }, - "subClashEnable": { - "type": "boolean" - }, - "subClashEnableRouting": { - "type": "boolean" - }, - "subClashPath": { - "type": "string" - }, - "subClashRules": { - "type": "string" - }, - "subClashURI": { - "type": "string" - }, - "subClashUserAgentRegex": { - "type": "string" - }, - "subDomain": { - "type": "string" - }, - "subEnable": { - "type": "boolean" - }, - "subEnableRouting": { - "type": "boolean" - }, - "subEncrypt": { - "type": "boolean" - }, - "subHideSettings": { - "type": "boolean" - }, - "subIncyEnableRouting": { - "type": "boolean" - }, - "subIncyRoutingRules": { - "type": "string" - }, - "subJsonAlwaysArray": { - "type": "boolean" - }, - "subJsonAutoDetect": { - "type": "boolean" - }, - "subJsonEnable": { - "type": "boolean" - }, - "subJsonFinalMask": { - "type": "string" - }, - "subJsonMux": { - "type": "string" - }, - "subJsonObservatory": { - "type": "string" - }, - "subJsonPath": { - "type": "string" - }, - "subJsonRules": { - "type": "string" - }, - "subJsonURI": { - "type": "string" - }, - "subJsonUserAgentRegex": { - "type": "string" - }, - "subKeyFile": { - "type": "string" - }, - "subListen": { - "type": "string" - }, - "subPath": { - "type": "string" - }, - "subPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "subProfileUrl": { - "type": "string" - }, - "subRoutingRules": { - "type": "string" - }, - "subShowIdentityOnAllLinks": { - "type": "boolean" - }, - "subSupportUrl": { - "type": "string" - }, - "subThemeDir": { - "type": "string" - }, - "subTitle": { - "type": "string" - }, - "subURI": { - "type": "string" - }, - "subUpdates": { - "maximum": 525600, - "minimum": 0, - "type": "integer" - }, - "tgBotAPIServer": { - "type": "string" - }, - "tgBotBackup": { - "type": "boolean" - }, - "tgBotChatId": { - "type": "string" - }, - "tgBotEnable": { - "type": "boolean" - }, - "tgBotProxy": { - "type": "string" - }, - "tgBotToken": { - "type": "string" - }, - "tgCpu": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "tgEnabledEvents": { - "type": "string" - }, - "tgLang": { - "type": "string" - }, - "tgMemory": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "tgRunTime": { - "type": "string" - }, - "timeLocation": { - "type": "string" - }, - "trafficDiff": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "trustedProxyCIDRs": { - "type": "string" - }, - "twoFactorEnable": { - "type": "boolean" - }, - "twoFactorToken": { - "type": "string" - }, - "warpUpdateInterval": { - "minimum": 0, - "type": "integer" - }, - "webBasePath": { - "type": "string" - }, - "webCertFile": { - "type": "string" - }, - "webDomain": { - "type": "string" - }, - "webKeyFile": { - "type": "string" - }, - "webListen": { - "type": "string" - }, - "webPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "datepicker", - "expireDiff", - "externalTrafficInformEnable", - "externalTrafficInformURI", - "ipLimitAllowlist", - "ldapAutoCreate", - "ldapAutoDelete", - "ldapBaseDN", - "ldapBindDN", - "ldapDefaultExpiryDays", - "ldapDefaultLimitIP", - "ldapDefaultTotalGB", - "ldapEnable", - "ldapFlagField", - "ldapHost", - "ldapInboundTags", - "ldapInsecureSkipVerify", - "ldapInvertFlag", - "ldapPassword", - "ldapPort", - "ldapSyncCron", - "ldapTruthyValues", - "ldapUseTLS", - "ldapUserAttr", - "ldapUserFilter", - "ldapVlessField", - "outboundDownThreshold", - "pageSize", - "panelOutbound", - "remarkTemplate", - "restartXrayOnClientDisable", - "sessionMaxAge", - "smtpCpu", - "smtpEnable", - "smtpEnabledEvents", - "smtpEncryptionType", - "smtpFrom", - "smtpFromName", - "smtpHost", - "smtpMemory", - "smtpPassword", - "smtpPort", - "smtpTo", - "smtpUsername", - "subAnnounce", - "subCertFile", - "subClashAutoDetect", - "subClashEnable", - "subClashEnableRouting", - "subClashPath", - "subClashRules", - "subClashURI", - "subClashUserAgentRegex", - "subDomain", - "subEnable", - "subEnableRouting", - "subEncrypt", - "subHideSettings", - "subIncyEnableRouting", - "subIncyRoutingRules", - "subJsonAlwaysArray", - "subJsonAutoDetect", - "subJsonEnable", - "subJsonFinalMask", - "subJsonMux", - "subJsonObservatory", - "subJsonPath", - "subJsonRules", - "subJsonURI", - "subJsonUserAgentRegex", - "subKeyFile", - "subListen", - "subPath", - "subPort", - "subProfileUrl", - "subRoutingRules", - "subShowIdentityOnAllLinks", - "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": { - "properties": { - "datepicker": { - "type": "string" - }, - "expireDiff": { - "minimum": 0, - "type": "integer" - }, - "externalTrafficInformEnable": { - "type": "boolean" - }, - "externalTrafficInformURI": { - "type": "string" - }, - "hasApiToken": { - "type": "boolean" - }, - "hasLdapPassword": { - "type": "boolean" - }, - "hasNordSecret": { - "type": "boolean" - }, - "hasSmtpPassword": { - "type": "boolean" - }, - "hasTgBotToken": { - "type": "boolean" - }, - "hasTwoFactorToken": { - "type": "boolean" - }, - "hasWarpSecret": { - "type": "boolean" - }, - "ipLimitAllowlist": { - "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": { - "type": "boolean" - }, - "ldapFlagField": { - "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": { - "type": "string" - }, - "ldapUserFilter": { - "type": "string" - }, - "ldapVlessField": { - "type": "string" - }, - "outboundDownThreshold": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "pageSize": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - }, - "panelOutbound": { - "type": "string" - }, - "remarkTemplate": { - "type": "string" - }, - "restartXrayOnClientDisable": { - "type": "boolean" - }, - "sessionMaxAge": { - "maximum": 525600, - "minimum": 1, - "type": "integer" - }, - "smtpCpu": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "smtpEnable": { - "type": "boolean" - }, - "smtpEnabledEvents": { - "type": "string" - }, - "smtpEncryptionType": { - "type": "string" - }, - "smtpFrom": { - "type": "string" - }, - "smtpFromName": { - "type": "string" - }, - "smtpHost": { - "type": "string" - }, - "smtpMemory": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "smtpPassword": { - "type": "string" - }, - "smtpPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "smtpTo": { - "type": "string" - }, - "smtpUsername": { - "type": "string" - }, - "subAnnounce": { - "type": "string" - }, - "subCertFile": { - "type": "string" - }, - "subClashAutoDetect": { - "type": "boolean" - }, - "subClashEnable": { - "type": "boolean" - }, - "subClashEnableRouting": { - "type": "boolean" - }, - "subClashPath": { - "type": "string" - }, - "subClashRules": { - "type": "string" - }, - "subClashURI": { - "type": "string" - }, - "subClashUserAgentRegex": { - "type": "string" - }, - "subDomain": { - "type": "string" - }, - "subEnable": { - "type": "boolean" - }, - "subEnableRouting": { - "type": "boolean" - }, - "subEncrypt": { - "type": "boolean" - }, - "subHideSettings": { - "type": "boolean" - }, - "subIncyEnableRouting": { - "type": "boolean" - }, - "subIncyRoutingRules": { - "type": "string" - }, - "subJsonAlwaysArray": { - "type": "boolean" - }, - "subJsonAutoDetect": { - "type": "boolean" - }, - "subJsonEnable": { - "type": "boolean" - }, - "subJsonFinalMask": { - "type": "string" - }, - "subJsonMux": { - "type": "string" - }, - "subJsonObservatory": { - "type": "string" - }, - "subJsonPath": { - "type": "string" - }, - "subJsonRules": { - "type": "string" - }, - "subJsonURI": { - "type": "string" - }, - "subJsonUserAgentRegex": { - "type": "string" - }, - "subKeyFile": { - "type": "string" - }, - "subListen": { - "type": "string" - }, - "subPath": { - "type": "string" - }, - "subPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "subProfileUrl": { - "type": "string" - }, - "subRoutingRules": { - "type": "string" - }, - "subShowIdentityOnAllLinks": { - "type": "boolean" - }, - "subSupportUrl": { - "type": "string" - }, - "subThemeDir": { - "type": "string" - }, - "subTitle": { - "type": "string" - }, - "subURI": { - "type": "string" - }, - "subUpdates": { - "maximum": 525600, - "minimum": 0, - "type": "integer" - }, - "tgBotAPIServer": { - "type": "string" - }, - "tgBotBackup": { - "type": "boolean" - }, - "tgBotChatId": { - "type": "string" - }, - "tgBotEnable": { - "type": "boolean" - }, - "tgBotProxy": { - "type": "string" - }, - "tgBotToken": { - "type": "string" - }, - "tgCpu": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "tgEnabledEvents": { - "type": "string" - }, - "tgLang": { - "type": "string" - }, - "tgMemory": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "tgRunTime": { - "type": "string" - }, - "timeLocation": { - "type": "string" - }, - "trafficDiff": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "trustedProxyCIDRs": { - "type": "string" - }, - "twoFactorEnable": { - "type": "boolean" - }, - "twoFactorToken": { - "type": "string" - }, - "warpUpdateInterval": { - "minimum": 0, - "type": "integer" - }, - "webBasePath": { - "type": "string" - }, - "webCertFile": { - "type": "string" - }, - "webDomain": { - "type": "string" - }, - "webKeyFile": { - "type": "string" - }, - "webListen": { - "type": "string" - }, - "webPort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "datepicker", - "expireDiff", - "externalTrafficInformEnable", - "externalTrafficInformURI", - "hasApiToken", - "hasLdapPassword", - "hasNordSecret", - "hasSmtpPassword", - "hasTgBotToken", - "hasTwoFactorToken", - "hasWarpSecret", - "ipLimitAllowlist", - "ldapAutoCreate", - "ldapAutoDelete", - "ldapBaseDN", - "ldapBindDN", - "ldapDefaultExpiryDays", - "ldapDefaultLimitIP", - "ldapDefaultTotalGB", - "ldapEnable", - "ldapFlagField", - "ldapHost", - "ldapInboundTags", - "ldapInsecureSkipVerify", - "ldapInvertFlag", - "ldapPassword", - "ldapPort", - "ldapSyncCron", - "ldapTruthyValues", - "ldapUseTLS", - "ldapUserAttr", - "ldapUserFilter", - "ldapVlessField", - "outboundDownThreshold", - "pageSize", - "panelOutbound", - "remarkTemplate", - "restartXrayOnClientDisable", - "sessionMaxAge", - "smtpCpu", - "smtpEnable", - "smtpEnabledEvents", - "smtpEncryptionType", - "smtpFrom", - "smtpFromName", - "smtpHost", - "smtpMemory", - "smtpPassword", - "smtpPort", - "smtpTo", - "smtpUsername", - "subAnnounce", - "subCertFile", - "subClashAutoDetect", - "subClashEnable", - "subClashEnableRouting", - "subClashPath", - "subClashRules", - "subClashURI", - "subClashUserAgentRegex", - "subDomain", - "subEnable", - "subEnableRouting", - "subEncrypt", - "subHideSettings", - "subIncyEnableRouting", - "subIncyRoutingRules", - "subJsonAlwaysArray", - "subJsonAutoDetect", - "subJsonEnable", - "subJsonFinalMask", - "subJsonMux", - "subJsonObservatory", - "subJsonPath", - "subJsonRules", - "subJsonURI", - "subJsonUserAgentRegex", - "subKeyFile", - "subListen", - "subPath", - "subPort", - "subProfileUrl", - "subRoutingRules", - "subShowIdentityOnAllLinks", - "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" - }, - "AmneziaWGLogs": { - "description": "AmneziaWGLogs is what the overview's AmneziaWG log view renders: the live\nper-peer activity of every running embedded interface, plus the panel's\nown recent AmneziaWG lifecycle log lines that explain a peer being absent\nfrom Peers at all.", - "properties": { - "events": { - "example": [ - "2025/01/01 12:00:00 amneziawg: started interface awg1 for inbound 1" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "peers": { - "items": { - "$ref": "#/components/schemas/PeerActivity" - }, - "type": "array" - }, - "running": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "events", - "peers", - "running" - ], - "type": "object" - }, - "ApiToken": { - "properties": { - "createdAt": { - "format": "int64", - "type": "integer" - }, - "enabled": { - "type": "boolean" - }, - "expiresAt": { - "format": "int64", - "type": "integer" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "token": { - "description": "SHA-256 hash; the plaintext is shown only once at creation", - "type": "string" - } - }, - "required": [ - "createdAt", - "enabled", - "expiresAt", - "id", - "name", - "scope", - "token" - ], - "type": "object" - }, - "ApiTokenView": { - "properties": { - "createdAt": { - "example": 1736000000, - "format": "int64", - "type": "integer" - }, - "enabled": { - "example": true, - "type": "boolean" - }, - "expiresAt": { - "example": 0, - "format": "int64", - "type": "integer" - }, - "id": { - "example": 2, - "type": "integer" - }, - "name": { - "example": "central-panel-a", - "type": "string" - }, - "scope": { - "example": "admin", - "type": "string" - }, - "token": { - "example": "new-token-string", - "type": "string" - } - }, - "required": [ - "createdAt", - "enabled", - "expiresAt", - "id", - "name", - "scope" - ], - "type": "object" - }, - "Client": { - "description": "Client represents a client configuration for Xray inbounds with traffic limits and settings.", - "properties": { - "adTag": { - "example": "0123456789abcdef0123456789abcdef", - "type": "string" - }, - "allowedIPs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "allowedIPsByInbound": { - "additionalProperties": { - "items": { - "type": "string" - }, - "type": "array" - }, - "description": "AllowedIPsByInbound optionally overrides AllowedIPs on a per-inbound\nbasis, keyed by inbound id. Lets one identity attached to both\nWireGuard and AmneziaWG carry two genuinely different addresses in a\nsingle Create/Update call instead of the shared AllowedIPs field\nbeing broadcast to every attached tunnel inbound. Absent/unset for a\ngiven inbound id falls back to the shared AllowedIPs exactly as\nbefore -- fully backward compatible for callers that never set this.", - "type": "object" - }, - "auth": { - "description": "Auth password (Hysteria)", - "type": "string" - }, - "comment": { - "description": "Client comment", - "type": "string" - }, - "created_at": { - "description": "Creation timestamp", - "format": "int64", - "type": "integer" - }, - "email": { - "description": "Client email identifier", - "type": "string" - }, - "enable": { - "description": "Whether the client is enabled", - "type": "boolean" - }, - "expiryTime": { - "description": "Expiration timestamp", - "format": "int64", - "type": "integer" - }, - "flow": { - "description": "Flow control (XTLS)", - "type": "string" - }, - "forwardedPorts": { - "description": "AmneziaWG per-client port-forwarding spec, e.g. \"80,443,8000-8100\"", - "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" - }, - "resetDay": { - "description": "Calendar renewal day 1-31, 0 = interval mode", - "type": "integer" - }, - "resetMax": { - "description": "Max auto-renew count, 0 = unlimited", - "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", - "format": "int64", - "type": "integer" - }, - "totalGB": { - "description": "Total traffic limit in GB", - "format": "int64", - "type": "integer" - }, - "trafficReset": { - "description": "Per-client traffic reset cycle, independent of the inbound's own (#5497).", - "enum": [ - "never", - "hourly", - "daily", - "weekly", - "monthly" - ], - "type": "string" - }, - "trafficResetDay": { - "maximum": 31, - "minimum": 1, - "type": "integer" - }, - "updated_at": { - "description": "Last update timestamp", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "comment", - "email", - "enable", - "expiryTime", - "limitIp", - "reset", - "resetDay", - "resetMax", - "security", - "subId", - "tgId", - "totalGB" - ], - "type": "object" - }, - "ClientInbound": { - "properties": { - "clientId": { - "type": "integer" - }, - "createdAt": { - "format": "int64", - "type": "integer" - }, - "flowOverride": { - "type": "string" - }, - "inboundId": { - "type": "integer" - } - }, - "required": [ - "clientId", - "createdAt", - "flowOverride", - "inboundId" - ], - "type": "object" - }, - "ClientRecord": { - "properties": { - "adTag": { - "type": "string" - }, - "allowedIPs": { - "type": "string" - }, - "auth": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "createdAt": { - "format": "int64", - "type": "integer" - }, - "email": { - "type": "string" - }, - "enable": { - "type": "boolean" - }, - "expiryTime": { - "format": "int64", - "type": "integer" - }, - "flow": { - "type": "string" - }, - "forwardedPorts": { - "type": "string" - }, - "group": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "keepAlive": { - "type": "integer" - }, - "limitHwid": { - "type": "integer" - }, - "limitIp": { - "type": "integer" - }, - "password": { - "type": "string" - }, - "preSharedKey": { - "type": "string" - }, - "privateKey": { - "type": "string" - }, - "publicKey": { - "type": "string" - }, - "reset": { - "type": "integer" - }, - "resetDay": { - "type": "integer" - }, - "resetMax": { - "type": "integer" - }, - "reverse": {}, - "secret": { - "type": "string" - }, - "security": { - "type": "string" - }, - "subId": { - "type": "string" - }, - "tgId": { - "format": "int64", - "type": "integer" - }, - "totalGB": { - "format": "int64", - "type": "integer" - }, - "trafficReset": { - "type": "string" - }, - "trafficResetDay": { - "type": "integer" - }, - "updatedAt": { - "format": "int64", - "type": "integer" - }, - "uuid": { - "type": "string" - } - }, - "required": [ - "adTag", - "allowedIPs", - "auth", - "comment", - "createdAt", - "email", - "enable", - "expiryTime", - "flow", - "forwardedPorts", - "group", - "id", - "keepAlive", - "limitHwid", - "limitIp", - "password", - "preSharedKey", - "privateKey", - "publicKey", - "reset", - "resetDay", - "resetMax", - "reverse", - "secret", - "security", - "subId", - "tgId", - "totalGB", - "trafficReset", - "trafficResetDay", - "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, - "format": "int64", - "type": "integer" - }, - "email": { - "example": "user1", - "type": "string" - }, - "enable": { - "example": true, - "type": "boolean" - }, - "expiryTime": { - "example": 1735689600000, - "format": "int64", - "type": "integer" - }, - "id": { - "example": 14825, - "type": "integer" - }, - "inboundId": { - "example": 1, - "type": "integer" - }, - "lastOnline": { - "example": 1735680000000, - "format": "int64", - "type": "integer" - }, - "lastSubFetch": { - "example": 1735680000000, - "format": "int64", - "type": "integer" - }, - "reset": { - "example": 0, - "type": "integer" - }, - "resetCount": { - "description": "ResetCount is how many have fired, so a prepaid plan stops on its own.", - "example": 0, - "type": "integer" - }, - "resetDay": { - "description": "ResetDay renews on that day of each calendar month instead of every\nReset days; 0 keeps the interval behaviour.", - "example": 0, - "type": "integer" - }, - "resetMax": { - "description": "ResetMax caps how many times auto-renew may fire; 0 means no cap.", - "example": 0, - "type": "integer" - }, - "subId": { - "example": "i7tvdpeffi0hvvf1", - "type": "string" - }, - "total": { - "example": 10737418240, - "format": "int64", - "type": "integer" - }, - "up": { - "example": 1048576, - "format": "int64", - "type": "integer" - }, - "uuid": { - "example": "e18c9a96-71bf-48d4-933f-8b9a46d4290c", - "type": "string" - } - }, - "required": [ - "down", - "email", - "enable", - "expiryTime", - "id", - "inboundId", - "lastOnline", - "lastSubFetch", - "reset", - "resetCount", - "resetDay", - "resetMax", - "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" - }, - "GeoCategory": { - "description": "GeoCategory is one code inside a database, such as geosite's \"google\".", - "properties": { - "attributes": { - "example": [ - "ads", - "cn" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "code": { - "example": "google", - "type": "string" - }, - "entries": { - "example": 1284, - "type": "integer" - } - }, - "required": [ - "attributes", - "code", - "entries" - ], - "type": "object" - }, - "GeoCategoryPage": { - "description": "GeoCategoryPage is one page of categories plus the unpaged total.", - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GeoCategory" - }, - "type": "array" - }, - "total": { - "example": 1043, - "type": "integer" - } - }, - "required": [ - "items", - "total" - ], - "type": "object" - }, - "GeoEntry": { - "description": "GeoEntry is a single rule inside a category: a domain rule for geosite\ndatabases, a CIDR for geoip ones.", - "properties": { - "kind": { - "example": "domain", - "type": "string" - }, - "value": { - "example": "google.com", - "type": "string" - } - }, - "required": [ - "kind", - "value" - ], - "type": "object" - }, - "GeoEntryPage": { - "description": "GeoEntryPage is one page of category entries plus the unpaged total.", - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GeoEntry" - }, - "type": "array" - }, - "total": { - "example": 1284, - "type": "integer" - } - }, - "required": [ - "items", - "total" - ], - "type": "object" - }, - "GeoFile": { - "description": "GeoFile describes one .dat database found in the asset directory.", - "properties": { - "categories": { - "example": 1043, - "type": "integer" - }, - "error": { - "type": "string" - }, - "kind": { - "example": "site", - "type": "string" - }, - "modifiedAt": { - "example": 1769558400000, - "format": "int64", - "type": "integer" - }, - "name": { - "example": "geosite.dat", - "type": "string" - }, - "size": { - "example": 1467392, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "categories", - "kind", - "modifiedAt", - "name", - "size" - ], - "type": "object" - }, - "GeodataTokenIssue": { - "description": "GeodataTokenIssue reports a routing token the running core would reject,\nor would silently match nothing against.", - "properties": { - "code": { - "example": "blabla", - "type": "string" - }, - "file": { - "example": "geosite.dat", - "type": "string" - }, - "reason": { - "example": "categoryMissing", - "type": "string" - }, - "token": { - "example": "geosite:blabla", - "type": "string" - } - }, - "required": [ - "reason", - "token" - ], - "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": { - "properties": { - "address": { - "example": "cdn.example.com", - "type": "string" - }, - "allowInsecure": { - "type": "boolean" - }, - "alpn": { - "items": { - "type": "string" - }, - "type": "array" - }, - "createdAt": { - "format": "int64", - "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" - }, - "groupId": { - "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": { - "format": "int64", - "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", - "groupId", - "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" - }, - "HostGroup": { - "properties": { - "allowInsecure": { - "type": "boolean" - }, - "alpn": { - "items": { - "type": "string" - }, - "type": "array" - }, - "echConfigList": { - "type": "string" - }, - "excludeFromSubTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "finalMask": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "groupId": { - "type": "string" - }, - "hostHeader": { - "type": "string" - }, - "hosts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "inboundIds": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "isDisabled": { - "type": "boolean" - }, - "isHidden": { - "type": "boolean" - }, - "keepSniBlank": { - "type": "boolean" - }, - "mihomoIpVersion": { - "enum": [ - "dual", - "ipv4", - "ipv6", - "ipv4-prefer", - "ipv6-prefer" - ], - "type": "string" - }, - "mihomoX25519": { - "type": "boolean" - }, - "muxParams": { - "type": "string" - }, - "nodeGuids": { - "items": { - "type": "string" - }, - "type": "array" - }, - "overrideSniFromAddress": { - "type": "boolean" - }, - "path": { - "type": "string" - }, - "pinnedPeerCertSha256": { - "items": { - "type": "string" - }, - "type": "array" - }, - "port": { - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "remark": { - "maxLength": 256, - "type": "string" - }, - "security": { - "enum": [ - "same", - "tls", - "none", - "reality" - ], - "type": "string" - }, - "serverDescription": { - "maxLength": 64, - "type": "string" - }, - "shuffleHost": { - "type": "boolean" - }, - "sni": { - "type": "string" - }, - "sockoptParams": { - "type": "string" - }, - "sortOrder": { - "type": "integer" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "verifyPeerCertByName": { - "type": "string" - }, - "vlessRoute": { - "type": "string" - } - }, - "required": [ - "allowInsecure", - "alpn", - "echConfigList", - "excludeFromSubTypes", - "finalMask", - "fingerprint", - "groupId", - "hostHeader", - "hosts", - "inboundIds", - "isDisabled", - "isHidden", - "keepSniBlank", - "mihomoIpVersion", - "mihomoX25519", - "muxParams", - "nodeGuids", - "overrideSniFromAddress", - "path", - "pinnedPeerCertSha256", - "port", - "remark", - "security", - "serverDescription", - "shuffleHost", - "sni", - "sockoptParams", - "sortOrder", - "tags", - "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" - }, - "disableFlow": { - "example": false, - "type": "boolean" - }, - "down": { - "description": "Download traffic in bytes", - "format": "int64", - "type": "integer" - }, - "enable": { - "description": "Whether the inbound is enabled", - "example": true, - "type": "boolean" - }, - "expiryTime": { - "description": "Expiration timestamp", - "format": "int64", - "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", - "format": "int64", - "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", - "amneziawg" - ], - "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", - "format": "int64", - "type": "integer" - }, - "trafficReset": { - "description": "Traffic reset schedule", - "enum": [ - "never", - "hourly", - "daily", - "weekly", - "monthly" - ], - "type": "string" - }, - "trafficResetDay": { - "description": "Day of month for monthly traffic resets", - "example": 1, - "maximum": 31, - "minimum": 1, - "type": "integer" - }, - "up": { - "description": "Upload traffic in bytes", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "clientStats", - "disableFlow", - "down", - "enable", - "expiryTime", - "id", - "lastTrafficResetTime", - "listen", - "port", - "protocol", - "remark", - "settings", - "shareAddr", - "shareAddrStrategy", - "sniffing", - "streamSettings", - "subSortIndex", - "tag", - "total", - "trafficReset", - "trafficResetDay", - "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": { - "awgServer": { - "allOf": [ - { - "$ref": "#/components/schemas/ServerSettings" - } - ], - "description": "AwgServer carries the full AmneziaWG server block (keys, subnet,\nobfuscation params) so the clients page can render a downloadable\nper-client .conf without a second round trip.", - "nullable": true - }, - "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": { - "properties": { - "msg": { - "type": "string" - }, - "obj": {}, - "success": { - "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" - }, - "basePath": { - "example": "/", - "type": "string" - }, - "clientCount": { - "example": 27, - "type": "integer" - }, - "configDirty": { - "type": "boolean" - }, - "configDirtyAt": { - "format": "int64", - "type": "integer" - }, - "cpuPct": { - "example": 23.5, - "type": "number" - }, - "createdAt": { - "example": 1700000000, - "format": "int64", - "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, - "format": "int64", - "type": "integer" - }, - "latencyMs": { - "example": 42, - "type": "integer" - }, - "memPct": { - "example": 45.1, - "type": "number" - }, - "name": { - "example": "de-fra-1", - "type": "string" - }, - "netDown": { - "example": 2097152, - "format": "int64", - "type": "integer" - }, - "netUp": { - "example": 1048576, - "format": "int64", - "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, - "format": "int64", - "type": "integer" - }, - "uptimeSecs": { - "example": 86400, - "format": "int64", - "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", - "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" - }, - "NodeMutationRequest": { - "description": "NodeMutationRequest is the node write/probe contract. ApiToken is accepted\nonly as input. On update, nil means keep the stored token; replacement and\nclearing are explicit and mutually exclusive.", - "properties": { - "address": { - "type": "string" - }, - "allowPrivateAddress": { - "type": "boolean" - }, - "apiToken": { - "nullable": true, - "type": "string" - }, - "basePath": { - "type": "string" - }, - "clearApiToken": { - "type": "boolean" - }, - "enable": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "inboundSyncMode": { - "enum": [ - "all", - "selected" - ], - "type": "string" - }, - "inboundTags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "outboundTag": { - "type": "string" - }, - "pinnedCertSha256": { - "type": "string" - }, - "port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "remark": { - "type": "string" - }, - "scheme": { - "enum": [ - "http", - "https" - ], - "type": "string" - }, - "tlsVerifyMode": { - "enum": [ - "verify", - "skip", - "pin", - "mtls" - ], - "type": "string" - } - }, - "required": [ - "address", - "allowPrivateAddress", - "basePath", - "enable", - "id", - "inboundSyncMode", - "inboundTags", - "name", - "outboundTag", - "pinnedCertSha256", - "port", - "remark", - "scheme", - "tlsVerifyMode" - ], - "type": "object" - }, - "NodeView": { - "description": "NodeView is the browser/API read contract for nodes. Credentials are\nwrite-only: responses expose only whether a node has a token configured.", - "properties": { - "activeCount": { - "example": 20, - "type": "integer" - }, - "address": { - "example": "node.example.com", - "type": "string" - }, - "allowPrivateAddress": { - "example": false, - "type": "boolean" - }, - "basePath": { - "example": "/", - "type": "string" - }, - "clientCount": { - "example": 25, - "type": "integer" - }, - "configDirty": { - "example": false, - "type": "boolean" - }, - "configDirtyAt": { - "example": 0, - "format": "int64", - "type": "integer" - }, - "cpuPct": { - "example": 12.5, - "type": "number" - }, - "createdAt": { - "example": 1700000000, - "format": "int64", - "type": "integer" - }, - "depletedCount": { - "example": 1, - "type": "integer" - }, - "disabledCount": { - "example": 2, - "type": "integer" - }, - "enable": { - "example": true, - "type": "boolean" - }, - "guid": { - "example": "node-guid", - "type": "string" - }, - "hasApiToken": { - "example": true, - "type": "boolean" - }, - "id": { - "example": 1, - "type": "integer" - }, - "inboundCount": { - "example": 3, - "type": "integer" - }, - "inboundSyncMode": { - "example": "all", - "type": "string" - }, - "inboundTags": { - "example": [ - "in-443-tcp" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "lastError": { - "type": "string" - }, - "lastHeartbeat": { - "example": 1700000000, - "format": "int64", - "type": "integer" - }, - "latencyMs": { - "example": 42, - "type": "integer" - }, - "memPct": { - "example": 45.2, - "type": "number" - }, - "name": { - "example": "edge-1", - "type": "string" - }, - "netDown": { - "example": 1048576, - "format": "int64", - "type": "integer" - }, - "netUp": { - "example": 2097152, - "format": "int64", - "type": "integer" - }, - "onlineCount": { - "example": 5, - "type": "integer" - }, - "outboundTag": { - "example": "direct", - "type": "string" - }, - "panelVersion": { - "example": "v3.x.x", - "type": "string" - }, - "parentGuid": { - "type": "string" - }, - "pinnedCertSha256": { - "type": "string" - }, - "port": { - "example": 2053, - "type": "integer" - }, - "remark": { - "example": "Primary edge", - "type": "string" - }, - "scheme": { - "example": "https", - "type": "string" - }, - "status": { - "example": "online", - "type": "string" - }, - "tlsVerifyMode": { - "example": "verify", - "type": "string" - }, - "transitive": { - "example": false, - "type": "boolean" - }, - "updatedAt": { - "example": 1700003600, - "format": "int64", - "type": "integer" - }, - "uptimeSecs": { - "example": 86400, - "format": "int64", - "type": "integer" - }, - "xrayError": { - "type": "string" - }, - "xrayState": { - "example": "running", - "type": "string" - }, - "xrayVersion": { - "example": "25.10.31", - "type": "string" - } - }, - "required": [ - "activeCount", - "address", - "allowPrivateAddress", - "basePath", - "clientCount", - "configDirty", - "configDirtyAt", - "cpuPct", - "createdAt", - "depletedCount", - "disabledCount", - "enable", - "guid", - "hasApiToken", - "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": { - "format": "int64", - "type": "integer" - }, - "id": { - "type": "integer" - }, - "tag": { - "type": "string" - }, - "total": { - "format": "int64", - "type": "integer" - }, - "up": { - "format": "int64", - "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, - "format": "int64", - "type": "integer" - }, - "runId": { - "example": "1735689600123456789", - "type": "string" - }, - "state": { - "example": "success", - "type": "string" - } - }, - "required": [ - "exitCode", - "finishedAt", - "runId", - "state" - ], - "type": "object" - }, - "PeerActivity": { - "description": "PeerActivity is one peer's live embedded-Device-reported state, the\ncounterpart of an Xray access-log entry: a tunnel logs no requests, only\nhandshakes and bytes.", - "properties": { - "allowedIPs": { - "example": "10.8.1.2/32", - "type": "string" - }, - "down": { - "example": 4194304, - "format": "int64", - "type": "integer" - }, - "email": { - "example": "peer@example.com", - "type": "string" - }, - "endpoint": { - "example": "203.0.113.9:51820", - "type": "string" - }, - "handshake": { - "description": "Handshake is unix milliseconds, 0 when the peer has never connected.", - "example": 1735732800000, - "format": "int64", - "type": "integer" - }, - "inboundId": { - "example": 1, - "type": "integer" - }, - "interface": { - "example": "awg1", - "type": "string" - }, - "online": { - "example": true, - "type": "boolean" - }, - "tag": { - "example": "inbound-51820", - "type": "string" - }, - "up": { - "example": 1048576, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "allowedIPs", - "down", - "email", - "endpoint", - "handshake", - "inboundId", - "interface", - "online", - "tag", - "up" - ], - "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, - "format": "int64", - "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" - }, - "certChainValid": { - "description": "CertChainValid ignores the name: a trusted chain presented for other names\nstill has serverNames the panel can offer instead of the failing SNI.", - "example": true, - "type": "boolean" - }, - "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" - }, - "privateTarget": { - "description": "PrivateTarget marks a target that resolves to a loopback/private/link-local\naddress: blocked before the probe unless the caller opted in, then flagged.", - "example": false, - "type": "boolean" - }, - "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", - "certChainValid", - "certIssuer", - "certSubject", - "certValid", - "curveID", - "feasible", - "h2", - "host", - "ip", - "latencyMs", - "notAfter", - "port", - "privateTarget", - "reason", - "serverNames", - "target", - "tls13", - "tlsVersion", - "x25519" - ], - "type": "object" - }, - "ServerSettings": { - "description": "ServerSettings is the \"server\" block of an AmneziaWG inbound's Settings\nJSON: the interface-level configuration shared by every client/peer. The\nlisten port is deliberately not duplicated here — it lives on the inbound\nrow itself (Inbound.Port), like every other protocol.", - "properties": { - "contentPaddingAddition": { - "type": "string" - }, - "disableCookies": { - "type": "boolean" - }, - "externalInterface": { - "description": "ExternalInterface, IPv6Enabled, and IPv6ExternalInterface are live\nagain as of Phase 3.5 -- see the matching fields on Instance for what\nthey gate (internal/amneziawgnet's IPv6-address-alias mechanism).\nIPv6Subnet was never actually vestigial either: InstanceFromInbound\nalready consumes it (via serverAddressV6) to build the server's own\ntunnel address, same as always. Only RouteThroughXray, below, remains\ngenuinely vestigial as of the hard cutover to the embedded path\n(internal/amneziawgnet) -- read from existing stored settings for\nbackward compatibility, but not acted on by anything.", - "type": "string" - }, - "h1": { - "type": "string" - }, - "h2": { - "type": "string" - }, - "h3": { - "type": "string" - }, - "h4": { - "type": "string" - }, - "headerProtectionKey": { - "description": "HeaderProtectionKey and ContentPaddingAddition are AmneziaWG 3.0\nfields, flat and top-level for the same tools/openapigen reason as\nthe block above; Obfuscation() below folds them back into\nObfuscation31's own identically named fields.\nHeaderProtectionKey is a base64 32-byte key; empty (the default)\ndisables AWG 3.0 header protection. A non-empty value requires\nevery one of S1-S4 above to be >= 12 -- ValidateObfuscation\nenforces this at save time, not just at IpcSet time.\nContentPaddingAddition is a \"low-high\" range or bare integer, the\nsame grammar and uint32 cap as H1-H4.", - "type": "string" - }, - "i1": { - "type": "string" - }, - "i2": { - "type": "string" - }, - "i3": { - "type": "string" - }, - "i4": { - "type": "string" - }, - "i5": { - "type": "string" - }, - "ipv6Enabled": { - "type": "boolean" - }, - "ipv6ExternalInterface": { - "type": "string" - }, - "ipv6Subnet": { - "type": "string" - }, - "jc": { - "description": "Obfuscation31's fields, repeated flat (not embedded) rather than\nnested under their own key: encoding/json would happily inline an\nembedded Obfuscation31 the same way, but the frontend's Go->Zod/TS\ngenerator (tools/openapigen) does not — it emits a genuinely nested\n`obfuscation31` object, which would silently diverge from the real\nwire JSON. See Obfuscation() below for the manager-facing conversion.", - "type": "integer" - }, - "jmax": { - "type": "integer" - }, - "jmin": { - "type": "integer" - }, - "keepaliveTimeout": { - "type": "string" - }, - "maxHandshakeAttempts": { - "type": "string" - }, - "mtu": { - "type": "integer" - }, - "primaryDns": { - "description": "PrimaryDNS/SecondaryDNS seed client configs' DNS line. Blank is\nmeaningful, so no omitempty: a dropped key resurrects frontend defaults.", - "type": "string" - }, - "privateKey": { - "type": "string" - }, - "publicKey": { - "type": "string" - }, - "randomTrailers": { - "description": "RandomTrailers/DisableCookies mirror Instance's identically named\nAmneziaWG 3.1 fields -- see that type's own doc comment for the real\nprotocol/interop details. Both real bool fields (not omitempty):\nbuildUAPIConfig always emits both lines explicitly so the\nreconfigure-in-place diff correctly notices a true->false edit, not\njust false->true.", - "type": "boolean" - }, - "rejectAfterTime": { - "type": "string" - }, - "rekeyAfterTime": { - "description": "RekeyAfterTime/RekeyTimeout/RejectAfterTime/KeepaliveTimeout/\nMaxHandshakeAttempts mirror Instance's identically named fields --\nsee that type's own doc comment for the grammar/width/real-default\ndetails. Flat and top-level for the same tools/openapigen reason as\nthe rest of this struct.", - "type": "string" - }, - "rekeyTimeout": { - "type": "string" - }, - "routeThroughXray": { - "type": "boolean" - }, - "s1": { - "type": "integer" - }, - "s2": { - "type": "integer" - }, - "s3": { - "type": "integer" - }, - "s4": { - "type": "integer" - }, - "secondaryDns": { - "type": "string" - }, - "subnetCidr": { - "type": "integer" - }, - "subnetIp": { - "type": "string" - } - }, - "required": [ - "disableCookies", - "h1", - "h2", - "h3", - "h4", - "jc", - "jmax", - "jmin", - "primaryDns", - "privateKey", - "publicKey", - "randomTrailers", - "s1", - "s2", - "s3", - "s4", - "secondaryDns", - "subnetCidr", - "subnetIp" - ], - "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" - }, - "SubBalancer": { - "description": "SubBalancer is one extra JSON-subscription config document whose members are\nthe selected inbounds' proxy outbounds. SortOrder shares SubSortIndex semantics.", - "properties": { - "createdAt": { - "example": 1710000000000, - "format": "int64", - "type": "integer" - }, - "enabled": { - "description": "No gorm default:true — a bool default makes an explicit false at insert\ncollapse back to the column default (zero value is skipped).", - "example": true, - "type": "boolean" - }, - "id": { - "example": 1, - "type": "integer" - }, - "inboundIds": { - "example": [ - 1, - 3 - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "remark": { - "example": "auto-fastest", - "maxLength": 256, - "type": "string" - }, - "sortOrder": { - "example": 1, - "minimum": 1, - "type": "integer" - }, - "strategy": { - "enum": [ - "leastLoad", - "leastPing", - "random", - "roundRobin" - ], - "example": "random", - "type": "string" - }, - "updatedAt": { - "example": 1710000000000, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "createdAt", - "enabled", - "id", - "inboundIds", - "remark", - "sortOrder", - "strategy", - "updatedAt" - ], - "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" - } - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "cookieAuth": [] - } - ], - "tags": [ - { - "name": "Authentication", - "description": "Two authentication modes are supported. UI sessions use a cookie set by the login endpoint. Programmatic clients (bots, scripts, remote panels) authenticate with a Bearer token taken from Settings → Security → API Token. Both work for every endpoint under /panel/api/*." - }, - { - "name": "Inbounds", - "description": "Manage inbound configurations and their clients. All endpoints live under /panel/api/inbounds and require a logged-in session or Bearer token. Link-generating endpoints honour forwarded headers only when the request comes from a configured trusted proxy." - }, - { - "name": "Server", - "description": "System status, log retrieval, certificate generators, Xray binary management, and backup/restore. All under /panel/api/server." - }, - { - "name": "Clients", - "description": "Manage clients as first-class entities that can be attached to one or more inbounds. A single client row drives the settings.clients entry in every inbound it belongs to. Endpoints live under /panel/api/clients." - }, - { - "name": "Nodes", - "description": "Manage remote 3x-ui panels acting as nodes for a central panel. All endpoints under /panel/api/nodes." - }, - { - "name": "Hosts", - "description": "Per-inbound override endpoints. Each enabled host renders one extra subscription link/proxy with its own address/port/TLS, superseding the legacy externalProxy array. All endpoints under /panel/api/hosts." - }, - { - "name": "Backup", - "description": "Operations that interact with the configured Telegram bot." - }, - { - "name": "Settings", - "description": "Panel configuration and user credentials. All endpoints live under /panel/api/setting and require a logged-in session or Bearer token." - }, - { - "name": "API Tokens", - "description": "Manage scoped Bearer tokens for programmatic auth. Tokens grant admin, monitor, or node-sync access, may expire, and are stored as SHA-256 hashes. The plaintext is returned only once at creation." - }, - { - "name": "Xray Settings", - "description": "Xray configuration template, outbound management, Warp/Nord/PIA integration, and config testing. All endpoints under /panel/api/xray." - }, - { - "name": "Subscription Balancers", - "description": "Client-side balancers for the JSON subscription: each enabled balancer is emitted as one extra config document whose members are the proxy outbounds of the selected inbounds (routing.balancers + burstObservatory). Managed in Settings → Sub Balancers." - }, - { - "name": "Subscription Server", - "description": "A separate HTTP/HTTPS server that serves proxy subscription links (standard, JSON, and Clash) to clients. The server listens on its own port (default 10882) and is configured in Settings → Subscription. Paths are configurable; defaults are shown below. All subscription endpoints set response headers for client apps to read traffic/expiry info." - }, - { - "name": "WebSocket", - "description": "Real-time status updates via WebSocket. Connect once at ws:///ws to receive a stream of JSON messages without polling. Requires an authenticated session cookie (Bearer token auth is not supported). Each message has a type field that identifies the payload shape." - } - ], - "paths": { - "/login": { - "post": { - "tags": [ - "Authentication" - ], - "summary": "Authenticate with username + password and receive a session cookie. Required before any cookie-based API call.", - "operationId": "post_login", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "Panel admin username." - }, - "password": { - "type": "string", - "description": "Panel admin password." - }, - "twoFactorCode": { - "type": "string", - "description": "OTP code when 2FA is enabled. Omit otherwise." - } - }, - "required": [ - "username", - "password", - "twoFactorCode" - ] - }, - "example": { - "username": "admin", - "password": "admin", - "twoFactorCode": "123456" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Logged in successfully" - } - } - } - }, - "400": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - } - } - }, - "example": { - "success": false, - "msg": "Wrong username or password" - } - } - } - } - } - } - }, - "/logout": { - "post": { - "tags": [ - "Authentication" - ], - "summary": "Clear the session cookie. Requires the CSRF header for browser sessions.", - "operationId": "post_logout", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/csrf-token": { - "get": { - "tags": [ - "Authentication" - ], - "summary": "Mint a CSRF token for the current session. The SPA replays it in the X-CSRF-Token header on unsafe requests. Bearer-token callers can skip this — the middleware short-circuits CSRF for authenticated API requests.", - "operationId": "get_csrf_token", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": "csrf-token-string" - } - } - } - } - } - } - }, - "/getTwoFactorEnable": { - "post": { - "tags": [ - "Authentication" - ], - "summary": "Returns whether 2FA is enabled on the panel — used by the login page to decide whether to show the OTP field.", - "operationId": "post_getTwoFactorEnable", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": false - } - } - } - } - } - } - }, - "/panel/api/inbounds/list": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "List every inbound owned by the authenticated user, including each inbound’s clientStats traffic counters. settings, streamSettings, and sniffing are returned as nested JSON objects (no escaped strings); legacy callers that send them back as JSON-encoded strings are still accepted on write.", - "operationId": "get_panel_api_inbounds_list", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Inbound" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "clientStats": [ - { - "down": 2097152, - "email": "user1", - "enable": true, - "expiryTime": 1735689600000, - "id": 14825, - "inboundId": 1, - "lastOnline": 1735680000000, - "lastSubFetch": 1735680000000, - "reset": 0, - "resetCount": 0, - "resetDay": 0, - "resetMax": 0, - "subId": "i7tvdpeffi0hvvf1", - "total": 10737418240, - "up": 1048576, - "uuid": "e18c9a96-71bf-48d4-933f-8b9a46d4290c" - } - ], - "disableFlow": false, - "down": 0, - "enable": true, - "expiryTime": 0, - "fallbackParent": null, - "id": 1, - "lastTrafficResetTime": 0, - "listen": "", - "nodeId": null, - "originNodeGuid": "", - "port": 443, - "protocol": "vless", - "remark": "VLESS-443", - "settings": null, - "shareAddr": "", - "shareAddrStrategy": "node", - "sniffing": null, - "streamSettings": null, - "subSortIndex": 1, - "tag": "in-443-tcp", - "total": 0, - "trafficReset": "never", - "trafficResetDay": 1, - "up": 0 - } - ] - } - } - } - } - } - } - }, - "/panel/api/inbounds/list/slim": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "Same shape as /list but with settings.clients[] stripped down to {email, enable, comment} and ClientStats not enriched with UUID/SubId. Use this for list pages; fetch /get/:id when you need the full per-client payload (uuid, password, flow, ...).", - "operationId": "get_panel_api_inbounds_list_slim", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "remark": "VLESS-443", - "settings": { - "clients": [ - { - "email": "alice", - "enable": true - } - ], - "decryption": "none" - }, - "clientStats": [] - } - ] - } - } - } - } - } - } - }, - "/panel/api/inbounds/options": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "Lightweight picker projection of the authenticated user’s inbounds. Returns id, remark, tag, protocol, port, a server-computed tlsFlowCapable flag (true for VLESS on TCP with tls or reality, or on XHTTP with VLESS encryption / vlessenc enabled), and ssMethod (the Shadowsocks cipher, empty for non-Shadowsocks inbounds — used by the client UI to generate a valid Shadowsocks 2022 PSK). Use this for dropdowns and attach pickers — it skips settings, streamSettings, and clientStats so the payload stays small even on panels with thousands of clients.", - "operationId": "get_panel_api_inbounds_options", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InboundOption" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "awgServer": null, - "enable": true, - "id": 1, - "listen": "", - "mtprotoDomain": "", - "nodeAddress": "", - "nodeId": null, - "port": 443, - "protocol": "vless", - "remark": "VLESS-443", - "shareAddr": "", - "shareAddrStrategy": "", - "ssMethod": "", - "tag": "in-443-tcp", - "tlsFlowCapable": true, - "wgDns": "", - "wgMtu": 0, - "wgPublicKey": "" - } - ] - } - } - } - } - } - } - }, - "/panel/api/inbounds/allLinks": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "Return every protocol URL (vless://, vmess://, trojan://, ss://, hysteria://, mtproto) across all inbounds and all of their clients. Links are rendered through the subscription engine, so the configured remark template (name-only display part) is applied per client — the same output the client info/QR pages use. Protocols without a URL form (socks, http, mixed, wireguard, dokodemo, tunnel) contribute nothing. Used by the panel’s \"Export all inbound links\" action.", - "operationId": "get_panel_api_inbounds_allLinks", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "vless://uuid@host:443?security=reality&...#Germany-alice", - "vmess://eyJ2IjoyLC..." - ] - } - } - } - } - } - } - }, - "/panel/api/inbounds/get/{id}": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "Fetch a single inbound by numeric ID.", - "operationId": "get_panel_api_inbounds_get_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/add": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Create a new inbound. Send the full inbound payload (protocol, port, settings, streamSettings, sniffing, remark, expiryTime, total, enable). settings, streamSettings, and sniffing may be sent as nested JSON objects (preferred) or as JSON-encoded strings (legacy).", - "operationId": "post_panel_api_inbounds_add", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "enable": true, - "remark": "VLESS-443", - "listen": "", - "port": 443, - "protocol": "vless", - "expiryTime": 0, - "total": 0, - "settings": { - "clients": [ - { - "id": "...", - "email": "user1" - } - ], - "decryption": "none", - "fallbacks": [] - }, - "streamSettings": { - "network": "tcp", - "security": "reality", - "realitySettings": { - "show": false, - "dest": "..." - } - }, - "sniffing": { - "enabled": true, - "destOverride": [ - "http", - "tls" - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - }, - "400": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - } - } - }, - "example": { - "success": false, - "msg": "Port 443 is already in use" - } - } - } - } - } - } - }, - "/panel/api/inbounds/del/{id}": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Delete an inbound by ID. Also removes its associated client stats rows.", - "operationId": "post_panel_api_inbounds_del_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/bulkDel": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Delete many inbounds in one call. Processes the list sequentially; failures are reported per id and the rest still proceed. Restarts xray at most once.", - "operationId": "post_panel_api_inbounds_bulkDel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "ids": [ - 1, - 2, - 3 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "deleted": 2, - "skipped": [ - { - "id": 3, - "reason": "..." - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/update/{id}": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Replace an inbound’s configuration. Body shape mirrors /add. Heavy on inbounds with thousands of clients — prefer /setEnable for enable-only flips.", - "operationId": "post_panel_api_inbounds_update_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/setEnable/{id}": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Toggle only the enable flag without serialising the whole settings JSON. Recommended for UI switches on large inbounds.", - "operationId": "post_panel_api_inbounds_setEnable_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "enable": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/{id}/subSortIndex": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Set only the subscription sort order. Reads the stored inbound, so a reorder cannot carry a stale client list over a concurrent edit.", - "operationId": "post_panel_api_inbounds_id_subSortIndex", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "subSortIndex": 2 - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/{id}/resetTraffic": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Zero out upload + download counters for a single inbound. Does not touch per-client counters.", - "operationId": "post_panel_api_inbounds_id_resetTraffic", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/{id}/delAllClients": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Remove every client attached to a single inbound while keeping the inbound itself. Collects emails from settings.clients[] and feeds them into the optimized bulk-delete path (runtime user removal + traffic-row cleanup + SyncInbound). Destructive and cannot be undone.", - "operationId": "post_panel_api_inbounds_id_delAllClients", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "deleted": 12 - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/resetAllTraffics": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Reset upload + download counters on every inbound. Destructive — accounting history is lost.", - "operationId": "post_panel_api_inbounds_resetAllTraffics", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/import": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Bulk-import an inbound from a JSON blob (e.g. one exported via the UI). The body uses form encoding with a single \"data\" field.", - "operationId": "post_panel_api_inbounds_import", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/inbounds/pushClientTraffics": { - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Receive a master panel's aggregated per-client usage, keyed by the master's GUID. Stored in a side table used only for the UI display overlay and local quota enforcement — never folded into the local counters that masters poll, so delta accounting stays intact. Called panel-to-panel by the node traffic sync job.", - "operationId": "post_panel_api_inbounds_pushClientTraffics", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "masterGuid": "9f6c2d-…", - "traffics": [ - { - "email": "alice", - "up": 1048576, - "down": 2097152 - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/inbounds/{id}/fallbacks": { - "get": { - "tags": [ - "Inbounds" - ], - "summary": "List the fallback rules attached to a master VLESS/Trojan TCP-TLS inbound. Each rule links one child inbound (the dest) to optional SNI/ALPN/path/dest/xver match criteria. When dest is empty the child inbound's listen+port is used.", - "operationId": "get_panel_api_inbounds_id_fallbacks", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Master inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "masterId": 10, - "childId": 11, - "name": "", - "alpn": "", - "path": "/vlws", - "dest": "", - "xver": 2, - "sortOrder": 0 - } - ] - } - } - } - } - } - }, - "post": { - "tags": [ - "Inbounds" - ], - "summary": "Replace the entire fallback list for a master inbound. Body is JSON. Triggers an Xray restart.", - "operationId": "post_panel_api_inbounds_id_fallbacks", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Master inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "fallbacks": [ - { - "childId": 11, - "path": "/vlws", - "xver": 2 - }, - { - "childId": 12, - "alpn": "h2", - "dest": "8443" - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Inbound updated" - } - } - } - } - } - } - }, - "/panel/api/openapi.json": { - "get": { - "tags": [ - "Server" - ], - "summary": "Serve this API description as an OpenAPI 3 document — the same file that powers the API Docs page. Requires a session or Bearer token like the rest of /panel/api. Useful for generating clients or importing into API tooling.", - "operationId": "get_panel_api_openapi_json", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/status": { - "get": { - "tags": [ - "Server" - ], - "summary": "Real-time machine snapshot: CPU, memory, swap, disk, network IO, load averages, open connections, Xray state. Cached and refreshed every 2 seconds in the background.", - "operationId": "get_panel_api_server_status", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "cpu": 12.5, - "mem": { - "current": 2147483648, - "total": 8589934592 - }, - "swap": { - "current": 0, - "total": 4294967296 - }, - "disk": { - "current": 53687091200, - "total": 268435456000 - }, - "netIO": { - "up": 1073741824, - "down": 2147483648 - }, - "xray": { - "state": "running", - "version": "v25.10.31" - }, - "tcpCount": 42, - "load": { - "load1": 0.5, - "load5": 0.3, - "load15": 0.2 - } - } - } - } - } - } - } - } - }, - "/panel/api/server/fail2banStatus": { - "get": { - "tags": [ - "Server" - ], - "summary": "Reports whether per-client IP limits can be enforced on this host. The panel uses it to gate the \"IP Limit\" field, since enforcement depends on Fail2ban being installed.", - "operationId": "get_panel_api_server_fail2banStatus", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "enabled": true, - "installed": true, - "usable": true, - "windows": false - } - } - } - } - } - } - } - }, - "/panel/api/server/cpuHistory/{bucket}": { - "get": { - "tags": [ - "Server" - ], - "summary": "Legacy: aggregated CPU history. Use /history/cpu/:bucket instead — same data with a uniform {t, v} shape.", - "operationId": "get_panel_api_server_cpuHistory_bucket", - "parameters": [ - { - "name": "bucket", - "in": "path", - "required": true, - "description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/history/{metric}/{bucket}": { - "get": { - "tags": [ - "Server" - ], - "summary": "Aggregated time-series for one metric. Returns an array of {t, v} samples covering the last ~6 hours.", - "operationId": "get_panel_api_server_history_metric_bucket", - "parameters": [ - { - "name": "metric", - "in": "path", - "required": true, - "description": "cpu | mem | netUp | netDown | online | load1 | load5 | load15.", - "schema": { - "type": "string" - } - }, - { - "name": "bucket", - "in": "path", - "required": true, - "description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "t": 1700000000, - "v": 12.5 - }, - { - "t": 1700000002, - "v": 13.1 - } - ] - } - } - } - } - } - } - }, - "/panel/api/server/xrayMetricsState": { - "get": { - "tags": [ - "Server" - ], - "summary": "Xray runtime metrics state — whether the xray config has a `metrics` block, which expvar keys are flowing, and the current snapshot values for each. Returns an empty state when metrics are not configured.", - "operationId": "get_panel_api_server_xrayMetricsState", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/xrayMetricsHistory/{metric}/{bucket}": { - "get": { - "tags": [ - "Server" - ], - "summary": "Time-series history for one Xray runtime metric over the last ~6 hours. Same {t, v} shape as /history/:metric/:bucket.", - "operationId": "get_panel_api_server_xrayMetricsHistory_metric_bucket", - "parameters": [ - { - "name": "metric", - "in": "path", - "required": true, - "description": "xrAlloc | xrSys | xrHeapObjects | xrNumGC | xrPauseNs.", - "schema": { - "type": "string" - } - }, - { - "name": "bucket", - "in": "path", - "required": true, - "description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/xrayObservatory": { - "get": { - "tags": [ - "Server" - ], - "summary": "Latest snapshot from the Xray observatory — per-outbound latency, health status, and last-probe time. Only populated when the Xray config has an observatory configured.", - "operationId": "get_panel_api_server_xrayObservatory", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/xrayObservatoryHistory/{tag}/{bucket}": { - "get": { - "tags": [ - "Server" - ], - "summary": "Time-series of observatory probe results for one outbound tag. Same {t, v} shape as the other history endpoints.", - "operationId": "get_panel_api_server_xrayObservatoryHistory_tag_bucket", - "parameters": [ - { - "name": "tag", - "in": "path", - "required": true, - "description": "Outbound tag from the observatory config.", - "schema": { - "type": "string" - } - }, - { - "name": "bucket", - "in": "path", - "required": true, - "description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getPanelUpdateInfo": { - "get": { - "tags": [ - "Server" - ], - "summary": "Check whether a newer 3x-ui release is available on GitHub.", - "operationId": "get_panel_api_server_getPanelUpdateInfo", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getUpdateStatus": { - "get": { - "tags": [ - "Server" - ], - "summary": "Report the outcome of the most recently launched panel self-update (see POST updatePanel). Compare the returned runId against the one updatePanel returned to tell this run apart from a stale result.", - "operationId": "get_panel_api_server_getUpdateStatus", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/PanelUpdateStatus" - } - } - }, - "example": { - "success": true, - "obj": { - "exitCode": 0, - "finishedAt": 1735689612, - "runId": "1735689600123456789", - "state": "success" - } - } - } - } - } - } - } - }, - "/panel/api/server/getConfigJson": { - "get": { - "tags": [ - "Server" - ], - "summary": "Return the assembled Xray config that’s currently running on this host.", - "operationId": "get_panel_api_server_getConfigJson", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getDb": { - "get": { - "tags": [ - "Server" - ], - "summary": "Stream a full database backup as an attachment: the SQLite .db file on SQLite panels, or a pg_dump custom-format archive (.dump) on PostgreSQL panels. Use as a manual backup.", - "operationId": "get_panel_api_server_getDb", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getMigration": { - "get": { - "tags": [ - "Server" - ], - "summary": "Stream a cross-engine migration file as an attachment: a .dump (SQL text) on SQLite, or a .db SQLite database built from the live data on PostgreSQL.", - "operationId": "get_panel_api_server_getMigration", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getNewUUID": { - "get": { - "tags": [ - "Server" - ], - "summary": "Generate a fresh UUID v4. Convenience helper for client IDs.", - "operationId": "get_panel_api_server_getNewUUID", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": "550e8400-e29b-41d4-a716-446655440000" - } - } - } - } - } - } - }, - "/panel/api/server/getWebCertFiles": { - "get": { - "tags": [ - "Server" - ], - "summary": "Return this panel's own web TLS certificate and key file paths. The central panel calls it on a node (via the node API token) so \"Set Cert from Panel\" fills a node-assigned inbound with paths that exist on the node.", - "operationId": "get_panel_api_server_getWebCertFiles", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "webCertFile": "/root/cert/example.com/fullchain.pem", - "webKeyFile": "/root/cert/example.com/privkey.pem" - } - } - } - } - } - } - } - }, - "/panel/api/server/descendants": { - "get": { - "tags": [ - "Server" - ], - "summary": "Read-only summaries (guid, parentGuid, name, address, status, versions) of the nodes this panel manages. A parent panel calls it on a node (via the node API token) to surface transitive sub-nodes in a chained topology. Counts are computed by the parent, not returned here.", - "operationId": "get_panel_api_server_descendants", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "guid": "c3d4-...", - "parentGuid": "a1b2-...", - "name": "Node3", - "address": "10.0.0.3", - "status": "online" - } - ] - } - } - } - } - } - } - }, - "/panel/api/server/getNewX25519Cert": { - "get": { - "tags": [ - "Server" - ], - "summary": "Generate a new X25519 keypair for Reality.", - "operationId": "get_panel_api_server_getNewX25519Cert", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "privateKey": "uN9qLfV3zH8w...", - "publicKey": "5v8xPqR2sM7k..." - } - } - } - } - } - } - } - }, - "/panel/api/server/getNewmldsa65": { - "get": { - "tags": [ - "Server" - ], - "summary": "Generate a new ML-DSA-65 keypair (post-quantum signature). Returns {privateKey, publicKey, seed}.", - "operationId": "get_panel_api_server_getNewmldsa65", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "privateKey": "mdsa65priv...", - "publicKey": "mdsa65pub...", - "seed": "random-seed..." - } - } - } - } - } - } - } - }, - "/panel/api/server/getNewmlkem768": { - "get": { - "tags": [ - "Server" - ], - "summary": "Generate a new ML-KEM-768 keypair (post-quantum KEM). Returns {clientKey, serverKey}.", - "operationId": "get_panel_api_server_getNewmlkem768", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "clientKey": "mlkem768-client...", - "serverKey": "mlkem768-server..." - } - } - } - } - } - } - } - }, - "/panel/api/server/getNewVlessEnc": { - "get": { - "tags": [ - "Server" - ], - "summary": "Generate VLESS encryption auth options. Returns an auths array each with id, label, encryption, and decryption fields.", - "operationId": "get_panel_api_server_getNewVlessEnc", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "auths": [ - { - "id": 0, - "label": "Auth #0", - "encryption": "aes-256-gcm", - "decryption": "" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/server/stopXrayService": { - "post": { - "tags": [ - "Server" - ], - "summary": "Stop the Xray binary. All proxies go offline immediately.", - "operationId": "post_panel_api_server_stopXrayService", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - }, - "400": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - } - } - }, - "example": { - "success": false, - "msg": "Xray is not running" - } - } - } - } - } - } - }, - "/panel/api/server/restartXrayService": { - "post": { - "tags": [ - "Server" - ], - "summary": "Reload Xray with the current config. Typically required after structural inbound or routing changes.", - "operationId": "post_panel_api_server_restartXrayService", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - }, - "400": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - } - } - }, - "example": { - "success": false, - "msg": "Xray config is invalid: ..." - } - } - } - } - } - } - }, - "/panel/api/server/updatePanel": { - "post": { - "tags": [ - "Server" - ], - "summary": "Self-update the panel to the latest version. The server restarts on success.", - "operationId": "post_panel_api_server_updatePanel", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "runId": "1735689600123456789" - } - } - } - } - } - } - } - }, - "/panel/api/server/setUpdateChannel": { - "post": { - "tags": [ - "Server" - ], - "summary": "Toggle the panel update channel between stable and the rolling per-commit dev release. Only effective on dev builds.", - "operationId": "post_panel_api_server_setUpdateChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/logs/{count}": { - "post": { - "tags": [ - "Server" - ], - "summary": "Return the last N lines of the panel’s own log.", - "operationId": "post_panel_api_server_logs_count", - "parameters": [ - { - "name": "count", - "in": "path", - "required": true, - "description": "Number of trailing log lines.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "level": "info", - "syslog": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": "2025/01/01 12:00:00 [INFO] Server started\n2025/01/01 12:00:01 [INFO] Xray is running" - } - } - } - } - } - } - }, - "/panel/api/server/xraylogs/{count}": { - "post": { - "tags": [ - "Server" - ], - "summary": "Return the last N lines of the Xray process log.", - "operationId": "post_panel_api_server_xraylogs_count", - "parameters": [ - { - "name": "count", - "in": "path", - "required": true, - "description": "Number of trailing log lines.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": "2025/01/01 12:00:00 rejected vless proxy example.com reason: no valid user\n2025/01/01 12:00:01 direct freedom ok" - } - } - } - } - } - } - }, - "/panel/api/server/amneziawglogs/{count}": { - "post": { - "tags": [ - "Server" - ], - "summary": "Return live AmneziaWG peer activity (handshake, endpoint, transfer) plus the panel’s own AmneziaWG event lines.", - "operationId": "post_panel_api_server_amneziawglogs_count", - "parameters": [ - { - "name": "count", - "in": "path", - "required": true, - "description": "Maximum peer rows and event lines to return.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/AmneziaWGLogs" - } - } - }, - "example": { - "success": true, - "obj": { - "events": [ - "2025/01/01 12:00:00 amneziawg: started interface awg1 for inbound 1" - ], - "peers": [ - { - "allowedIPs": "10.8.1.2/32", - "down": 4194304, - "email": "peer@example.com", - "endpoint": "203.0.113.9:51820", - "handshake": 1735732800000, - "inboundId": 1, - "interface": "awg1", - "online": true, - "tag": "inbound-51820", - "up": 1048576 - } - ], - "running": true - } - } - } - } - } - } - } - }, - "/panel/api/server/importDB": { - "post": { - "tags": [ - "Server" - ], - "summary": "Restore the panel DB from an uploaded backup (multipart form, field name \"db\"). SQLite panels accept a SQLite database (.db) or a SQLite migration dump (.dump); PostgreSQL panels accept a pg_dump archive (.dump), a SQLite database (.db), or a SQLite migration dump. The panel restarts after restore. Destructive.", - "operationId": "post_panel_api_server_importDB", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getNewEchCert": { - "post": { - "tags": [ - "Server" - ], - "summary": "Generate a new ECH (Encrypted Client Hello) keypair and config list for the given SNI.", - "operationId": "post_panel_api_server_getNewEchCert", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/server/getCertHash": { - "post": { - "tags": [ - "Server" - ], - "summary": "Compute the hex SHA-256 of a certificate (DER) for pinning (pinnedPeerCertSha256). Provide either a server file path or inline PEM/DER content.", - "operationId": "post_panel_api_server_getCertHash", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "e8e2d3..." - ] - } - } - } - } - } - } - }, - "/panel/api/server/getRemoteCertHash": { - "post": { - "tags": [ - "Server" - ], - "summary": "Run `xray tls ping` against a remote server and return its live leaf-certificate SHA-256 hash(es) for pinning (pinnedPeerCertSha256).", - "operationId": "post_panel_api_server_getRemoteCertHash", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "e8e2d3..." - ] - } - } - } - } - } - } - }, - "/panel/api/server/scanRealityTarget": { - "post": { - "tags": [ - "Server" - ], - "summary": "Run a live TLS 1.3 probe against a candidate REALITY target and return a feasibility verdict (TLS 1.3 + h2 + X25519 + trusted certificate) plus the certificate SAN DNS names. A target on a private/loopback address is reported with privateTarget=true and probed only when allowPrivate is set.", - "operationId": "post_panel_api_server_scanRealityTarget", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/RealityScanResult" - } - } - }, - "example": { - "success": true, - "obj": { - "alpn": "h2", - "certChainValid": true, - "certIssuer": "Google Trust Services", - "certSubject": "cloudflare.com", - "certValid": true, - "curveID": "X25519", - "feasible": true, - "h2": true, - "host": "www.cloudflare.com", - "ip": "104.16.124.96", - "latencyMs": 180, - "notAfter": "2026-08-01T00:00:00Z", - "port": 443, - "privateTarget": false, - "reason": "", - "serverNames": [ - "" - ], - "target": "www.cloudflare.com:443", - "tls13": true, - "tlsVersion": "1.3", - "x25519": true - } - } - } - } - } - } - } - }, - "/panel/api/server/scanRealityTargets": { - "post": { - "tags": [ - "Server" - ], - "summary": "Probe/discover REALITY targets and return each verdict ranked by feasibility then latency. Each comma-separated token may be a domain (validated with SNI), a bare IP, or a CIDR range (discovered without SNI by reading the certificate domain). When empty, a built-in seed list is probed.", - "operationId": "post_panel_api_server_scanRealityTargets", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RealityScanResult" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "alpn": "h2", - "certChainValid": true, - "certIssuer": "Google Trust Services", - "certSubject": "cloudflare.com", - "certValid": true, - "curveID": "X25519", - "feasible": true, - "h2": true, - "host": "www.cloudflare.com", - "ip": "104.16.124.96", - "latencyMs": 180, - "notAfter": "2026-08-01T00:00:00Z", - "port": 443, - "privateTarget": false, - "reason": "", - "serverNames": [ - "" - ], - "target": "www.cloudflare.com:443", - "tls13": true, - "tlsVersion": "1.3", - "x25519": true - } - ] - } - } - } - } - } - } - }, - "/panel/api/server/clientIps": { - "get": { - "tags": [ - "Server" - ], - "summary": "Fetch the fully aggregated inbound_client_ips database table. Used by nodes to sync recently active IPs across the cluster.", - "operationId": "get_panel_api_server_clientIps", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InboundClientIps" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "clientEmail": "", - "id": 0, - "ips": null - } - ] - } - } - } - } - } - }, - "post": { - "tags": [ - "Server" - ], - "summary": "Submit a list of recently active IP timestamps. The panel merges them with the existing database to maintain a unified global IP-limit view.", - "operationId": "post_panel_api_server_clientIps", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/list": { - "get": { - "tags": [ - "Clients" - ], - "summary": "List every client with its attached inbound IDs and traffic record. The reverse field, if set, is returned as a nested JSON object (legacy JSON-encoded-string form is still accepted on write).", - "operationId": "get_panel_api_clients_list", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "email": "alice@example.com", - "subId": "abcd1234", - "uuid": "...", - "totalGB": 53687091200, - "expiryTime": 1735689600000, - "enable": true, - "reverse": null, - "inboundIds": [ - 3, - 5 - ], - "traffic": { - "up": 1024, - "down": 4096, - "enable": true - } - } - ] - } - } - } - } - } - } - }, - "/panel/api/clients/list/paged": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Filter, sort, and paginate clients on the server. Each item is a slim row (no uuid/password/auth/flow/security/reverse/tgId) so the clients page can ship 25-ish rows in a few KB instead of the full table. The response also includes a summary computed across the full DB row set so dashboard counters stay stable as the user paginates or filters: the *Count fields are exact, while the email arrays beside them stop at 200 entries so the payload does not grow with the panel. Page size capped at 200; fetch /get/:email to obtain the full per-client payload for an edit/info modal.", - "operationId": "get_panel_api_clients_list_paged", - "parameters": [ - { - "name": "page", - "in": "query", - "required": true, - "description": "1-indexed page number. Defaults to 1.", - "schema": { - "type": "integer" - } - }, - { - "name": "pageSize", - "in": "query", - "required": true, - "description": "Rows per page. Defaults to 25, capped at 200.", - "schema": { - "type": "integer" - } - }, - { - "name": "search", - "in": "query", - "required": true, - "description": "Case-insensitive substring match on email / subId / comment.", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "in": "query", - "required": true, - "description": "Status bucket: online | active | deactive | depleted | expiring.", - "schema": { - "type": "string" - } - }, - { - "name": "protocol", - "in": "query", - "required": true, - "description": "Match clients attached to at least one inbound of this protocol (vless, vmess, trojan, shadowsocks, ...).", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "required": true, - "description": "Sort key: enable | email | inboundIds | traffic | remaining | expiryTime.", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "required": true, - "description": "ascend or descend.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "items": [ - { - "email": "alice@example.com", - "subId": "abcd1234", - "enable": true, - "totalGB": 53687091200, - "expiryTime": 1735689600000, - "limitIp": 0, - "limitHwid": 0, - "reset": 0, - "inboundIds": [ - 3, - 5 - ], - "traffic": { - "up": 1024, - "down": 4096, - "enable": true - }, - "createdAt": 1735000000000, - "updatedAt": 1735100000000 - } - ], - "total": 2000, - "filtered": 47, - "page": 1, - "pageSize": 25, - "summary": { - "total": 2000, - "active": 1850, - "onlineCount": 1, - "depletedCount": 0, - "expiringCount": 0, - "deactiveCount": 150, - "online": [ - "alice@example.com" - ], - "depleted": [], - "expiring": [], - "deactive": [ - "bob@example.com" - ] - } - } - } - } - } - } - } - } - }, - "/panel/api/clients/get/{email}": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Fetch one client by email, including the inbound IDs and external config IDs it is attached to.", - "operationId": "get_panel_api_clients_get_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/get/tgId/{tgId}": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Fetch clients by Telegram user ID. Returns an array since multiple clients can share the same Telegram ID.", - "operationId": "get_panel_api_clients_get_tgId_tgId", - "parameters": [ - { - "name": "tgId", - "in": "path", - "required": true, - "description": "Telegram user ID (numeric).", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/add": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Create a new client and attach it to one or more inbounds in a single call. Body is JSON. Per-protocol secrets are generated server-side when omitted, so callers can send only the universal fields.", - "operationId": "post_panel_api_clients_add", - "description": "Fields the server fills in when they are omitted — a valid value sent by the caller is never overwritten. Re-adding an email that already exists, with its stored `subId`, reuses the stored `id`, `password`, `auth` and `secret` instead of minting new ones, so the identity stays in sync across its inbounds.\n\n- **VLESS / VMess** — `id`, a fresh UUID\n- **Trojan** — `password`\n- **Shadowsocks** — `password`. On a `2022-blake3-*` inbound a supplied password that does not base64-decode to the key length of the cipher (16 or 32 bytes) is replaced by a generated key and the call still succeeds, so read the client back if you did not let the server pick. Legacy ciphers keep any non-empty password\n- **Hysteria** — `auth`\n- **mtproto** — `secret`, a FakeTLS secret derived from the fronting domain of the inbound, or from `www.cloudflare.com` when it has none\n- **WireGuard** — `privateKey` and `publicKey` when both are blank, or `publicKey` alone when only a `privateKey` was sent, plus `allowedIPs`: one free `/32` taken from the /24 the existing peers of that inbound already sit in, or from `10.0.0.0/24` when it has none\n\nAccepted on the same body but never generated: `preSharedKey` and `keepAlive` (WireGuard), `adTag` (mtproto).\n\nWireGuard is the only one of these that can fail. Allocation widens the search to the containing /16 before giving up with `wireguard: no free address available in `, and an `allowedIPs` supplied by the caller is validated instead of allocated: `wireguard: allowedIPs entry already used by another client:
` when a different client of that same inbound already holds it. The check is per inbound, so the same address on two different inbounds is accepted. The same validation runs on POST /panel/api/clients/{email}/attach, where a client that already carries an address brings it along.", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "client": { - "email": "alice@example.com", - "totalGB": 53687091200, - "expiryTime": 1735689600000, - "tgId": 0, - "limitIp": 0, - "limitHwid": 0, - "enable": true - }, - "inboundIds": [ - 3, - 5 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Client added" - } - } - } - } - } - } - }, - "/panel/api/clients/update/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Update an existing client by email. Changes propagate to every attached inbound. Body is the JSON client payload — supply the full set of fields you want to keep (the server replaces the row, it does not patch).", - "operationId": "post_panel_api_clients_update_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Current client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "email": "alice@example.com", - "totalGB": 107374182400, - "expiryTime": 1767225600000, - "limitHwid": 2, - "tgId": 123456789, - "enable": true - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Client updated" - } - } - } - } - } - } - }, - "/panel/api/clients/del/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Delete a client by email. Removes it from every attached inbound and drops its traffic record unless keepTraffic=1 is passed.", - "operationId": "post_panel_api_clients_del_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - }, - { - "name": "keepTraffic", - "in": "query", - "required": true, - "description": "Pass 1 to retain the xray_client_traffic row after deletion.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Client deleted" - } - } - } - } - } - } - }, - "/panel/api/clients/{email}/attach": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Attach an existing client to one or more additional inbounds. Body is JSON.", - "operationId": "post_panel_api_clients_email_attach", - "description": "A WireGuard client brings its stored `allowedIPs` into the new inbound instead of being given a fresh address, so the call fails with `wireguard: allowedIPs entry already used by another client:
` when a different client of the target inbound already holds it. Free the address on that inbound first — see POST /panel/api/clients/add for the full rule.", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "inboundIds": [ - 7, - 9 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/clients/{email}/detach": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Detach a client from one or more inbounds without deleting the client.", - "operationId": "post_panel_api_clients_email_detach", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "inboundIds": [ - 5 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/clients/{email}/externalLinks": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Replace a client's external links and external subscriptions. Sends the full set; the server replaces all rows. Disabled rows stay saved for editing but are not emitted in generated subscriptions.", - "operationId": "post_panel_api_clients_email_externalLinks", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "externalLinks": { - "type": "array", - "items": { - "type": "object" - }, - "description": "Full replacement list; the server replaces all rows. Each row supports { kind, value, remark, enable, expiryTime, namePrefix }. kind=link: value must be a supported share link such as vless://, vmess://, trojan://, ss://, hysteria2://, or wireguard://, and remark overrides the exported node name. kind=subscription: value must be an http(s) subscription URL, and namePrefix is prepended to fetched node names. Omit enable to default true; enable=false or an expired expiryTime keeps the row saved but excludes it from generated subscriptions. expiryTime is a unix millisecond timestamp where 0 means never expire; a negative value is rejected. Rows are matched by kind+value across saves, so id is ignored on write. lastFetchAt and lastFetchError are read-only status fields returned by GET." - } - }, - "required": [ - "externalLinks" - ] - }, - "example": { - "externalLinks": [ - { - "kind": "link", - "value": "vless://uuid@host:443?...#srv", - "remark": "DE", - "enable": true, - "expiryTime": 0 - }, - { - "kind": "subscription", - "value": "https://provider.example/sub/abc", - "remark": "Provider", - "enable": false, - "expiryTime": 1767225600000, - "namePrefix": "[zjh] " - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/clients/resetAllTraffics": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Reset the up/down counters for every client globally. Quotas and expiry are not affected. Triggers an Xray restart if any counter actually moved.", - "operationId": "post_panel_api_clients_resetAllTraffics", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/clients/delDepleted": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Delete every client whose traffic quota is exhausted (used >= total, when reset is disabled) or whose expiry has passed. Returns the deleted count and triggers an Xray restart when any client was on a running inbound.", - "operationId": "post_panel_api_clients_delDepleted", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "deleted": 0 - } - } - } - } - } - } - } - }, - "/panel/api/clients/delOrphans": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Delete every client that is not attached to any inbound, along with its traffic record, IP log, HWID devices, and external links. Useful for clearing clients left unattached after their inbounds were removed. Returns the deleted count. Cannot be undone.", - "operationId": "post_panel_api_clients_delOrphans", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "deleted": 0 - } - } - } - } - } - } - } - }, - "/panel/api/clients/export": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Return every client as a {client, inboundIds} array — the same shape /bulkCreate and /import accept — so the payload round-trips straight back through /import. Clients with no inbound attachment are included with an empty inboundIds list. The UI shows this in a CodeMirror viewer (copy / download); programmatic callers get the array in obj.", - "operationId": "get_panel_api_clients_export", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "client": { - "email": "alice@example.com", - "id": "...", - "totalGB": 53687091200, - "expiryTime": 0, - "limitHwid": 2, - "enable": true, - "subId": "..." - }, - "inboundIds": [ - 7, - 9 - ] - } - ] - } - } - } - } - } - } - }, - "/panel/api/clients/import": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Import clients from a JSON body { \"data\": \"\" }, where data is a string-encoded array produced by /export ([{client, inboundIds}]). Items with inboundIds are created and attached to those inbounds; items with an empty inboundIds list are restored as unattached client records. Existing emails are never overwritten — they are returned in skipped. Triggers a single Xray restart at the end if any target inbound was running.", - "operationId": "post_panel_api_clients_import", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "data": "[{\"client\":{\"email\":\"alice@example.com\",\"enable\":true},\"inboundIds\":[7]}]" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "created": 2, - "skipped": [ - { - "email": "alice@example.com", - "reason": "email already in use: alice@example.com" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkAdjust": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Shift expiry and/or traffic quota for many clients in one call. addDays/addBytes may be negative. Clients with unlimited expiry (expiryTime=0) or unlimited traffic (totalGB=0) are skipped for the corresponding field — bulk extend never converts unlimited to limited. A client that was auto-disabled solely because it was depleted (expired or over quota) is automatically re-enabled — locally and on its node — when the adjustment lifts it out of depletion; a manually-disabled or still-depleted client is left disabled. The optional flow directive sets the XTLS flow on every client: \"none\" clears it, \"xtls-rprx-vision\"/\"xtls-rprx-vision-udp443\" set it where the inbound supports it (omit or \"\" to leave it unchanged). Returns the adjusted count and per-email skip reasons.", - "operationId": "post_panel_api_clients_bulkAdjust", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ], - "addDays": 30, - "addBytes": 53687091200, - "flow": "xtls-rprx-vision" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "adjusted": 2, - "skipped": [ - { - "email": "carol", - "reason": "unlimited expiry" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkEnable": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Enable many clients in one call. Emails are grouped by inbound and applied with a single read-modify-write per inbound; the running Xray (local or remote node) is updated to add each user. Note that enabling a client whose quota is exhausted or whose expiry has passed only flips the flag — the traffic loop will disable it again on the next tick. Returns the changed count and per-email skip reasons.", - "operationId": "post_panel_api_clients_bulkEnable", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "changed": 2, - "skipped": [ - { - "email": "carol", - "reason": "client not found" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkDisable": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Disable many clients in one call. Emails are grouped by inbound and applied with a single read-modify-write per inbound; the running Xray (local or remote node) is updated to remove each user. Returns the changed count and per-email skip reasons.", - "operationId": "post_panel_api_clients_bulkDisable", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "changed": 2, - "skipped": [ - { - "email": "carol", - "reason": "client not found" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkDel": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Delete many clients in one call. The server processes the list sequentially so each delete sees the committed state of the previous one — avoids the race the per-email fan-out had on the panel side. Pass keepTraffic=true to retain the xray_client_traffic rows after deletion.", - "operationId": "post_panel_api_clients_bulkDel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ], - "keepTraffic": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "deleted": 2, - "skipped": [ - { - "email": "carol", - "reason": "client not found" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkCreate": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Create many clients in one call. Body is a JSON array of {client, inboundIds} payloads — the same shape /add accepts. Items are processed sequentially; per-email skip reasons are returned for items that fail (e.g., duplicate email). Triggers a single Xray restart at the end if any inbound was running.", - "operationId": "post_panel_api_clients_bulkCreate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": [ - { - "client": { - "email": "alice@example.com", - "totalGB": 53687091200, - "expiryTime": 0, - "limitHwid": 2, - "enable": true - }, - "inboundIds": [ - 7 - ] - }, - { - "client": { - "email": "bob@example.com", - "totalGB": 53687091200, - "expiryTime": 0, - "limitHwid": 0, - "enable": true - }, - "inboundIds": [ - 7, - 9 - ] - } - ] - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "created": 2, - "skipped": [ - { - "email": "alice@example.com", - "reason": "email already in use" - } - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups/bulkAdd": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Add many clients to a group in one call. Updates clients.group_name and patches the matching client entry inside every owning inbound's settings JSON in a single transaction. If the group name does not yet exist (in client_groups or as a derived label), it is auto-created as a persistent group. To clear the group label, use /groups/bulkRemove instead.", - "operationId": "post_panel_api_clients_groups_bulkAdd", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ], - "group": "customer-a" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "affected": 2 - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups/bulkRemove": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Clear the group label on many clients in one call. Inverse of /groups/bulkAdd. Clients themselves are kept — only the group label is cleared from clients.group_name and from each owning inbound's settings JSON. Groups become empty if all their members are removed.", - "operationId": "post_panel_api_clients_groups_bulkRemove", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "affected": 2 - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkAttach": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Attach many existing clients to many inbounds in one call. Each client keeps its identity (email/UUID/password/subId) and a shared traffic row; all clients are added to a target inbound in a single AddInboundClient call. Clients already present on a target are reported under skipped. Returns per-email attached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.", - "operationId": "post_panel_api_clients_bulkAttach", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ], - "inboundIds": [ - 7, - 9 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "attached": [ - "alice", - "bob" - ], - "skipped": [ - "bob" - ], - "errors": [] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkDetach": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Mirror of bulkAttach: detach many existing clients from many inbounds in one call. For each email, intersects the client's current inbounds with the requested set and detaches from those only; (email, inbound) pairs where the client is not currently attached are silently no-ops. Emails not attached to any of the requested inbounds are reported under skipped. Client records are kept even if they become orphaned — use bulkDel for full removal. Returns per-email detached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.", - "operationId": "post_panel_api_clients_bulkDetach", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ], - "inboundIds": [ - 7, - 9 - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "detached": [ - "alice", - "bob" - ], - "skipped": [], - "errors": [] - } - } - } - } - } - } - } - }, - "/panel/api/clients/bulkResetTraffic": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Zero up/down counters for many clients in one call. Loops the single-reset path so each client is re-enabled across its attached inbounds and pushed to Xray/remote nodes. Returns the count of successfully reset clients.", - "operationId": "post_panel_api_clients_bulkResetTraffic", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "emails": [ - "alice", - "bob" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "affected": 2 - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups": { - "get": { - "tags": [ - "Clients" - ], - "summary": "List all client groups with their member counts. Merges persisted groups (rows in client_groups, including empty placeholders) with the distinct group_name values currently set on clients. Sorted alphabetically (case-insensitive).", - "operationId": "get_panel_api_clients_groups", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "name": "customer-a", - "clientCount": 5 - }, - { - "name": "internal", - "clientCount": 0 - } - ] - } - } - } - } - } - } - }, - "/panel/api/clients/groups/{name}/emails": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Return just the email list of clients that currently belong to the given group. Useful for fanning a single bulk action over an entire group without round-tripping the full client list.", - "operationId": "get_panel_api_clients_groups_name_emails", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "description": "Group name (URL-encoded).", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "alice", - "bob", - "carol" - ] - } - } - } - } - } - } - }, - "/panel/api/clients/groups/create": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Create a new empty (placeholder) group. The group becomes selectable in client forms and the filter drawer even before any client is added to it. Errors if a group with the same name already exists.", - "operationId": "post_panel_api_clients_groups_create", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "customer-a" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "name": "customer-a" - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups/rename": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Rename a group. The new name is applied to the client_groups row AND propagated to every matching client (both clients.group_name and the client entry inside every owning inbound's settings JSON) in a single transaction. Returns the number of clients whose label was updated.", - "operationId": "post_panel_api_clients_groups_rename", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "oldName": "customer-a", - "newName": "tier-1" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "affected": 5 - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups/delete": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Remove a group. Deletes the client_groups row and clears the group label from every matching client (both clients.group_name and the inbound settings JSON). The clients themselves are NOT deleted — use /bulkDel after filtering by group for that. Returns the count of clients whose label was cleared.", - "operationId": "post_panel_api_clients_groups_delete", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "customer-a" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "affected": 5 - } - } - } - } - } - } - } - }, - "/panel/api/clients/groups/resetTraffic": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Reset only the group-level traffic counter shown on the groups page. Snapshots the current up/down sum of the group's members as a baseline so the group total reads zero, while leaving each client's own counters (and their quotas) untouched. No Xray restart is triggered. Creates the client_groups row if the group exists only as a derived label.", - "operationId": "post_panel_api_clients_groups_resetTraffic", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "customer-a" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "name": "customer-a" - } - } - } - } - } - } - } - }, - "/panel/api/clients/resetTraffic/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Zero out a single client’s up/down counters. Re-enables the client across every attached inbound and pushes the change to Xray (or the remote node) so depleted users can connect again immediately.", - "operationId": "post_panel_api_clients_resetTraffic_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/updateTraffic/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Manually adjust a client’s upload + download counters. Useful for migrations from external accounting systems.", - "operationId": "post_panel_api_clients_updateTraffic_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "upload": 1073741824, - "download": 5368709120 - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/ips/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "List source IPs that have connected with the given client’s credentials. Returns an array of \"ip (timestamp)\" strings.", - "operationId": "post_panel_api_clients_ips_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/clearIps/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Reset the recorded IP list for a client.", - "operationId": "post_panel_api_clients_clearIps_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/hwids/{email}": { - "post": { - "tags": [ - "Clients" - ], - "summary": "List registered HWID devices for a client. Hashes are not exposed.", - "operationId": "post_panel_api_clients_hwids_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "firstSeen": 1735000000000, - "lastSeen": 1735100000000, - "userAgent": "Happ/1.0", - "deviceOs": "android", - "osVersion": "15", - "deviceModel": "Pixel 9" - } - ] - } - } - } - } - } - }, - "delete": { - "tags": [ - "Clients" - ], - "summary": "Clear all registered HWID devices for a client so new devices can register again.", - "operationId": "delete_panel_api_clients_hwids_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/hwids/{email}/{id}": { - "delete": { - "tags": [ - "Clients" - ], - "summary": "Remove a single registered HWID device by its id, freeing one slot under the HWID limit.", - "operationId": "delete_panel_api_clients_hwids_email_id", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email.", - "schema": { - "type": "string" - } - }, - { - "name": "id", - "in": "path", - "required": true, - "description": "Device id, from the list endpoint.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/clients/onlines": { - "post": { - "tags": [ - "Clients" - ], - "summary": "List the emails of currently connected clients (last seen within the heartbeat window), deduped across every node.", - "operationId": "post_panel_api_clients_onlines", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "user1", - "user2" - ] - } - } - } - } - } - } - }, - "/panel/api/clients/onlinesByGuid": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Online client emails grouped by the panelGuid of the node that physically hosts each client. The local panel uses its own GUID; each node (at any depth in a chain) uses its GUID. Lets the inbounds page attribute online status to the real node instead of the intermediate one it syncs through.", - "operationId": "post_panel_api_clients_onlinesByGuid", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "a1b2-...": [ - "user1" - ], - "c3d4-...": [ - "user1", - "user2" - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/clientIpsByGuid": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Per-client source IPs grouped by the panelGuid of the node that observed them. Lets the central panel attribute and enforce per-client IP limits using the real visitor IPs each node sees, instead of the address of the intermediate panel it syncs through.", - "operationId": "post_panel_api_clients_clientIpsByGuid", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "a1b2-...": { - "user1": [ - { - "ip": "1.2.3.4", - "timestamp": 1700000000 - } - ] - } - } - } - } - } - } - } - } - }, - "/panel/api/clients/activeInbounds": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Inbound tags that carried traffic within the heartbeat window, grouped by the hosting node's panelGuid. Pairs with onlinesByGuid so the inbounds page only marks a multi-inbound client online on the inbounds it actually used. Nodes that do not report per-inbound activity are absent.", - "operationId": "post_panel_api_clients_activeInbounds", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "a1b2-...": [ - "in-443-tcp", - "in-8443-tcp" - ] - } - } - } - } - } - } - } - }, - "/panel/api/clients/lastOnline": { - "post": { - "tags": [ - "Clients" - ], - "summary": "Map of client email → last-seen unix timestamp.", - "operationId": "post_panel_api_clients_lastOnline", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "user1": 1700000000, - "user2": 1699999000 - } - } - } - } - } - } - } - }, - "/panel/api/clients/traffic/{email}": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Traffic counters for a client identified by email.", - "operationId": "get_panel_api_clients_traffic_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique across the panel).", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/ClientTraffic" - } - } - }, - "example": { - "success": true, - "obj": { - "down": 2097152, - "email": "user1", - "enable": true, - "expiryTime": 1735689600000, - "id": 14825, - "inboundId": 1, - "lastOnline": 1735680000000, - "lastSubFetch": 1735680000000, - "reset": 0, - "resetCount": 0, - "resetDay": 0, - "resetMax": 0, - "subId": "i7tvdpeffi0hvvf1", - "total": 10737418240, - "up": 1048576, - "uuid": "e18c9a96-71bf-48d4-933f-8b9a46d4290c" - } - } - } - } - } - } - } - }, - "/panel/api/clients/subLinks/{subId}": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Return every protocol URL (vless://, vmess://, trojan://, ss://, hysteria://, hy2://) for clients matching the subscription ID. Same result set as /sub/, but as a JSON array — no base64. When an inbound has streamSettings.externalProxy set, one URL is emitted per external proxy. Empty array when the subId has no enabled clients.", - "operationId": "get_panel_api_clients_subLinks_subId", - "parameters": [ - { - "name": "subId", - "in": "path", - "required": true, - "description": "Subscription ID, taken from the client's subId field.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "vless://uuid@host:443?security=reality&...#user1", - "vmess://eyJ2IjoyLC..." - ] - } - } - } - } - } - } - }, - "/panel/api/clients/links/{email}": { - "get": { - "tags": [ - "Clients" - ], - "summary": "Return every URL for one client across all attached inbounds — the same strings the Copy URL button copies in the panel UI. Supported protocols: vmess, vless, trojan, shadowsocks, hysteria. If streamSettings.externalProxy is set, returns one URL per external proxy. Protocols without a URL form (socks, http, mixed, wireguard, dokodemo, tunnel) contribute nothing.", - "operationId": "get_panel_api_clients_links_email", - "parameters": [ - { - "name": "email", - "in": "path", - "required": true, - "description": "Client email (unique identifier).", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "vless://uuid@host:443?...#user1" - ] - } - } - } - } - } - } - }, - "/panel/api/nodes/list": { - "get": { - "tags": [ - "Nodes" - ], - "summary": "List every configured node with its connection details, health, and last heartbeat patch.", - "operationId": "get_panel_api_nodes_list", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NodeView" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "activeCount": 20, - "address": "node.example.com", - "allowPrivateAddress": false, - "basePath": "/", - "clientCount": 25, - "configDirty": false, - "configDirtyAt": 0, - "cpuPct": 12.5, - "createdAt": 1700000000, - "depletedCount": 1, - "disabledCount": 2, - "enable": true, - "guid": "node-guid", - "hasApiToken": true, - "id": 1, - "inboundCount": 3, - "inboundSyncMode": "all", - "inboundTags": [ - "in-443-tcp" - ], - "lastError": "", - "lastHeartbeat": 1700000000, - "latencyMs": 42, - "memPct": 45.2, - "name": "edge-1", - "netDown": 1048576, - "netUp": 2097152, - "onlineCount": 5, - "outboundTag": "direct", - "panelVersion": "v3.x.x", - "parentGuid": "", - "pinnedCertSha256": "", - "port": 2053, - "remark": "Primary edge", - "scheme": "https", - "status": "online", - "tlsVerifyMode": "verify", - "transitive": false, - "updatedAt": 1700003600, - "uptimeSecs": 86400, - "xrayError": "", - "xrayState": "running", - "xrayVersion": "25.10.31" - } - ] - } - } - } - } - } - } - }, - "/panel/api/nodes/mtls/ca": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "This panel's node-auth CA certificate (public, PEM) to paste into a node's mTLS trust setting. Lazily mints the CA and the master client cert on first call. Pair with setting tlsVerifyMode=mtls on the node.", - "operationId": "post_panel_api_nodes_mtls_ca", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "caCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" - } - } - } - } - } - } - } - }, - "/panel/api/nodes/mtls/trustCA": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Set the CA certificate this panel trusts for incoming node-API client certificates (this panel acting as a node). Paste the managing panel's CA (from nodes/mtls/ca). An empty caCert disables it. A non-empty value must be a PEM certificate. Applied on the next panel restart.", - "operationId": "post_panel_api_nodes_mtls_trustCA", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "caCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/mtls/reloadClient": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Validate the stored master mTLS client credential and invalidate cached transports. Each transport closes its old idle pool and rebuilds with the rotated certificate before its next request.", - "operationId": "post_panel_api_nodes_mtls_reloadClient", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/get/{id}": { - "get": { - "tags": [ - "Nodes" - ], - "summary": "Fetch a single node by ID.", - "operationId": "get_panel_api_nodes_get_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/NodeView" - } - } - }, - "example": { - "success": true, - "obj": { - "activeCount": 20, - "address": "node.example.com", - "allowPrivateAddress": false, - "basePath": "/", - "clientCount": 25, - "configDirty": false, - "configDirtyAt": 0, - "cpuPct": 12.5, - "createdAt": 1700000000, - "depletedCount": 1, - "disabledCount": 2, - "enable": true, - "guid": "node-guid", - "hasApiToken": true, - "id": 1, - "inboundCount": 3, - "inboundSyncMode": "all", - "inboundTags": [ - "in-443-tcp" - ], - "lastError": "", - "lastHeartbeat": 1700000000, - "latencyMs": 42, - "memPct": 45.2, - "name": "edge-1", - "netDown": 1048576, - "netUp": 2097152, - "onlineCount": 5, - "outboundTag": "direct", - "panelVersion": "v3.x.x", - "parentGuid": "", - "pinnedCertSha256": "", - "port": 2053, - "remark": "Primary edge", - "scheme": "https", - "status": "online", - "tlsVerifyMode": "verify", - "transitive": false, - "updatedAt": 1700003600, - "uptimeSecs": 86400, - "xrayError": "", - "xrayState": "running", - "xrayVersion": "25.10.31" - } - } - } - } - } - } - } - }, - "/panel/api/nodes/webCert/{id}": { - "get": { - "tags": [ - "Nodes" - ], - "summary": "Fetch a node's own web TLS certificate/key file paths (proxied to the node). Used by the inbound form's \"Set Cert from Panel\" so a node-assigned inbound gets paths that exist on the node, not the central panel.", - "operationId": "get_panel_api_nodes_webCert_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "webCertFile": "/root/cert/example.com/fullchain.pem", - "webKeyFile": "/root/cert/example.com/privkey.pem" - } - } - } - } - } - } - } - }, - "/panel/api/nodes/add": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Register a new remote node. Provide its URL, write-only apiToken, and optional remark / allowPrivateAddress flag. Responses expose hasApiToken only.", - "operationId": "post_panel_api_nodes_add", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "de-fra-1", - "remark": "", - "scheme": "https", - "address": "node1.example.com", - "port": 2053, - "basePath": "/", - "apiToken": "abcdef...", - "clearApiToken": false, - "enable": true, - "allowPrivateAddress": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/NodeView" - } - } - }, - "example": { - "success": true, - "obj": { - "activeCount": 20, - "address": "node.example.com", - "allowPrivateAddress": false, - "basePath": "/", - "clientCount": 25, - "configDirty": false, - "configDirtyAt": 0, - "cpuPct": 12.5, - "createdAt": 1700000000, - "depletedCount": 1, - "disabledCount": 2, - "enable": true, - "guid": "node-guid", - "hasApiToken": true, - "id": 1, - "inboundCount": 3, - "inboundSyncMode": "all", - "inboundTags": [ - "in-443-tcp" - ], - "lastError": "", - "lastHeartbeat": 1700000000, - "latencyMs": 42, - "memPct": 45.2, - "name": "edge-1", - "netDown": 1048576, - "netUp": 2097152, - "onlineCount": 5, - "outboundTag": "direct", - "panelVersion": "v3.x.x", - "parentGuid": "", - "pinnedCertSha256": "", - "port": 2053, - "remark": "Primary edge", - "scheme": "https", - "status": "online", - "tlsVerifyMode": "verify", - "transitive": false, - "updatedAt": 1700003600, - "uptimeSecs": 86400, - "xrayError": "", - "xrayState": "running", - "xrayVersion": "25.10.31" - } - } - } - } - } - } - } - }, - "/panel/api/nodes/update/{id}": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Replace a node’s connection details. apiToken is write-only: omit it or send an empty string to keep the stored token; set clearApiToken=true to clear it.", - "operationId": "post_panel_api_nodes_update_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "de-fra-1", - "remark": "", - "scheme": "https", - "address": "node1.example.com", - "port": 2053, - "basePath": "/", - "apiToken": "", - "clearApiToken": false, - "enable": true, - "allowPrivateAddress": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/del/{id}": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Delete a node. Inbounds bound to it are not auto-migrated.", - "operationId": "post_panel_api_nodes_del_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/setEnable/{id}": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Pause or resume traffic sync with this node.", - "operationId": "post_panel_api_nodes_setEnable_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "enable": true - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/test": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Probe a node without saving it. Uses the body as connection details and returns the same heartbeat snapshot a registered node would have.", - "operationId": "post_panel_api_nodes_test", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "scheme": "https", - "address": "node1.example.com", - "port": 2053, - "basePath": "/", - "apiToken": "abcdef..." - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/ProbeResultUI" - } - } - }, - "example": { - "success": true, - "obj": { - "cpuPct": 12.5, - "error": "", - "latencyMs": 42, - "memPct": 45.2, - "panelVersion": "v3.x.x", - "status": "online", - "uptimeSecs": 86400, - "xrayError": "", - "xrayState": "", - "xrayVersion": "25.10.31" - } - } - } - } - } - } - } - }, - "/panel/api/nodes/certFingerprint": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Connect to the node over HTTPS without verifying its certificate and return the leaf certificate's SHA-256 (base64). Used by the Add/Edit Node dialog to fetch and pin a self-signed certificate. Uses the same body as /test.", - "operationId": "post_panel_api_nodes_certFingerprint", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "scheme": "https", - "address": "node1.example.com", - "port": 2053, - "basePath": "/" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": "k3b1...base64-sha256...=" - } - } - } - } - } - } - }, - "/panel/api/nodes/inbounds": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Use unsaved node connection details to list the remote inbounds available for selective import.", - "operationId": "post_panel_api_nodes_inbounds", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "name": "de-fra-1", - "scheme": "https", - "address": "node1.example.com", - "port": 2053, - "basePath": "/", - "apiToken": "abcdef..." - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "tag": "inbound-443", - "remark": "VLESS", - "protocol": "vless", - "port": 443 - } - ] - } - } - } - } - } - } - }, - "/panel/api/nodes/probe/{id}": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Probe an existing node, updating its cached health state.", - "operationId": "post_panel_api_nodes_probe_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/nodes/updatePanel": { - "post": { - "tags": [ - "Nodes" - ], - "summary": "Trigger the official panel self-updater on each given node (downloads the latest release and restarts). Only enabled, online nodes are updated; offline/disabled ones are reported as skipped. Set \"dev\": true to move the nodes to the rolling per-commit dev channel instead of the latest stable release. Returns a per-node result list.", - "operationId": "post_panel_api_nodes_updatePanel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "ids": [ - 1, - 2, - 3 - ], - "dev": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "name": "de-1", - "ok": true - }, - { - "id": 2, - "name": "fr-1", - "ok": false, - "error": "node is offline" - } - ] - } - } - } - } - } - } - }, - "/panel/api/nodes/history/{id}/{metric}/{bucket}": { - "get": { - "tags": [ - "Nodes" - ], - "summary": "Aggregated metric history for a node — same shape as /server/history, scoped to one node.", - "operationId": "get_panel_api_nodes_history_id_metric_bucket", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Node ID.", - "schema": { - "type": "integer" - } - }, - { - "name": "metric", - "in": "path", - "required": true, - "description": "cpu | mem.", - "schema": { - "type": "string" - } - }, - { - "name": "bucket", - "in": "path", - "required": true, - "description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/hosts/list": { - "get": { - "tags": [ - "Hosts" - ], - "summary": "List every host across all inbounds, grouped by inbound then ordered by sort order.", - "operationId": "get_panel_api_hosts_list", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HostGroup" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "allowInsecure": false, - "alpn": [ - "" - ], - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "hosts": [ - "" - ], - "inboundIds": [ - 0 - ], - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": "", - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 0, - "remark": "", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": "", - "sortOrder": 0, - "tags": [ - "" - ], - "verifyPeerCertByName": "", - "vlessRoute": "" - } - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/get/{groupId}": { - "get": { - "tags": [ - "Hosts" - ], - "summary": "Fetch a single host group by Group ID.", - "operationId": "get_panel_api_hosts_get_groupId", - "parameters": [ - { - "name": "groupId", - "in": "path", - "required": true, - "description": "Host Group ID.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/HostGroup" - } - } - }, - "example": { - "success": true, - "obj": { - "allowInsecure": false, - "alpn": [ - "" - ], - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "hosts": [ - "" - ], - "inboundIds": [ - 0 - ], - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": "", - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 0, - "remark": "", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": "", - "sortOrder": 0, - "tags": [ - "" - ], - "verifyPeerCertByName": "", - "vlessRoute": "" - } - } - } - } - } - } - } - }, - "/panel/api/hosts/byInbound/{inboundId}": { - "get": { - "tags": [ - "Hosts" - ], - "summary": "Fetch one inbound's hosts, grouped by host group.", - "operationId": "get_panel_api_hosts_byInbound_inboundId", - "parameters": [ - { - "name": "inboundId", - "in": "path", - "required": true, - "description": "Inbound ID.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HostGroup" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "allowInsecure": false, - "alpn": [ - "" - ], - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "hosts": [ - "" - ], - "inboundIds": [ - 0 - ], - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": "", - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 0, - "remark": "", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": "", - "sortOrder": 0, - "tags": [ - "" - ], - "verifyPeerCertByName": "", - "vlessRoute": "" - } - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/tags": { - "get": { - "tags": [ - "Hosts" - ], - "summary": "Distinct, sorted set of tags used across all hosts.", - "operationId": "get_panel_api_hosts_tags", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - "CDN", - "EU", - "FAST" - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/add": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Create a host group on inbounds.", - "operationId": "post_panel_api_hosts_add", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "inboundIds": [ - 1 - ], - "remark": "cdn-front", - "hosts": [ - "cdn.example.com" - ], - "port": 8443, - "security": "same", - "tags": [ - "CDN" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Host" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "address": "cdn.example.com", - "allowInsecure": false, - "alpn": [ - "" - ], - "createdAt": 0, - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "id": 1, - "inboundId": 1, - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": null, - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 8443, - "remark": "cdn-front", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": null, - "sortOrder": 0, - "tags": [ - "" - ], - "updatedAt": 0, - "verifyPeerCertByName": "", - "vlessRoute": "443" - } - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/update/{groupId}": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Replace a host group’s content.", - "operationId": "post_panel_api_hosts_update_groupId", - "parameters": [ - { - "name": "groupId", - "in": "path", - "required": true, - "description": "Host Group ID.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "inboundIds": [ - 1 - ], - "remark": "cdn-front", - "hosts": [ - "cdn.example.com" - ], - "port": 8443, - "security": "same", - "tags": [ - "CDN" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Host" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "address": "cdn.example.com", - "allowInsecure": false, - "alpn": [ - "" - ], - "createdAt": 0, - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "id": 1, - "inboundId": 1, - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": null, - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 8443, - "remark": "cdn-front", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": null, - "sortOrder": 0, - "tags": [ - "" - ], - "updatedAt": 0, - "verifyPeerCertByName": "", - "vlessRoute": "443" - } - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/del/{groupId}": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Delete a host group.", - "operationId": "post_panel_api_hosts_del_groupId", - "parameters": [ - { - "name": "groupId", - "in": "path", - "required": true, - "description": "Host Group ID.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/hosts/setEnable/{groupId}": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Enable or disable a host group.", - "operationId": "post_panel_api_hosts_setEnable_groupId", - "parameters": [ - { - "name": "groupId", - "in": "path", - "required": true, - "description": "Host Group ID.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "enable": true - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/hosts/reorder": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Set host group sort order by the position of each groupId in the array.", - "operationId": "post_panel_api_hosts_reorder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "ids": [ - "abc-123", - "def-456" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/hosts/bulk/add": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Add a host group to inbounds (same as /add).", - "operationId": "post_panel_api_hosts_bulk_add", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "inboundIds": [ - 1, - 2 - ], - "hosts": [ - "cdn.example.com", - "cdn2.example.com:443" - ], - "remark": "Cloudflare CDN", - "port": 0, - "security": "same", - "isDisabled": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Host" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "address": "cdn.example.com", - "allowInsecure": false, - "alpn": [ - "" - ], - "createdAt": 0, - "echConfigList": "", - "excludeFromSubTypes": [ - "" - ], - "finalMask": "", - "fingerprint": "", - "groupId": "", - "hostHeader": "", - "id": 1, - "inboundId": 1, - "isDisabled": false, - "isHidden": false, - "keepSniBlank": false, - "mihomoIpVersion": "dual", - "mihomoX25519": false, - "muxParams": null, - "nodeGuids": [ - "" - ], - "overrideSniFromAddress": false, - "path": "", - "pinnedPeerCertSha256": [ - "" - ], - "port": 8443, - "remark": "cdn-front", - "security": "same", - "serverDescription": "", - "shuffleHost": false, - "sni": "", - "sockoptParams": null, - "sortOrder": 0, - "tags": [ - "" - ], - "updatedAt": 0, - "verifyPeerCertByName": "", - "vlessRoute": "443" - } - ] - } - } - } - } - } - } - }, - "/panel/api/hosts/bulk/setEnable": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Enable or disable many host groups in one call.", - "operationId": "post_panel_api_hosts_bulk_setEnable", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "ids": [ - "abc-123", - "def-456" - ], - "enable": false - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/hosts/bulk/del": { - "post": { - "tags": [ - "Hosts" - ], - "summary": "Delete many host groups in one call.", - "operationId": "post_panel_api_hosts_bulk_del", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "ids": [ - "abc-123", - "def-456" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/backuptotgbot": { - "post": { - "tags": [ - "Backup" - ], - "summary": "Send a fresh DB backup to every Telegram chat configured as an admin recipient. No body, no params.", - "operationId": "post_panel_api_backuptotgbot", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/all": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Return every panel setting: web server, Telegram bot, subscription, security, LDAP. The full JSON blob that the Settings page edits.", - "operationId": "post_panel_api_setting_all", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/defaultSettings": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Return the computed default settings based on the request host. Useful to preview what a fresh install would use.", - "operationId": "post_panel_api_setting_defaultSettings", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/factoryDefaults": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Return the shipped (factory) default value per browser-safe setting key, so clients can tell a stored value apart from the default it would fall back to. Per-install material (secret, panelGuid, mTLS keys) and credential fields are never included.", - "operationId": "post_panel_api_setting_factoryDefaults", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/update": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Persist every setting at once. The body mirrors the shape returned by /all. Invalid values (bad ports, missing cert pairs, etc.) are rejected before write.", - "operationId": "post_panel_api_setting_update", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/validateRegex": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Validate any regular expression with the backend Go RE2 compiler without saving it.", - "operationId": "post_panel_api_setting_validateRegex", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "regex": "(?m)^general-purpose$" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "" - } - } - } - } - } - } - }, - "/panel/api/setting/updateUser": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Change the panel admin username and password. Requires the current credentials for verification. The session is refreshed with the new values on success.", - "operationId": "post_panel_api_setting_updateUser", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "oldUsername": { - "type": "string", - "description": "Current admin username." - }, - "oldPassword": { - "type": "string", - "description": "Current admin password." - }, - "newUsername": { - "type": "string", - "description": "Desired new username." - }, - "newPassword": { - "type": "string", - "description": "Desired new password." - } - }, - "required": [ - "oldUsername", - "oldPassword", - "newUsername", - "newPassword" - ] - }, - "example": { - "oldUsername": "admin", - "oldPassword": "admin", - "newUsername": "newadmin", - "newPassword": "newpass" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/restartPanel": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Restart the entire 3x-ui process after a 3-second grace period. The connection drops immediately; the panel comes back online ~5-10 seconds later.", - "operationId": "post_panel_api_setting_restartPanel", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/testSmtp": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Test SMTP connection with stage-by-stage reporting (connect, auth, send). Returns structured result with stage and message.", - "operationId": "post_panel_api_setting_testSmtp", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "stage": "send", - "msg": "Test email sent successfully" - } - } - } - } - } - } - }, - "/panel/api/setting/testTgBot": { - "post": { - "tags": [ - "Settings" - ], - "summary": "Test Telegram bot connection by sending a test message to the configured chat.", - "operationId": "post_panel_api_setting_testTgBot", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "msg": "Test message sent to Telegram" - } - } - } - } - } - } - }, - "/panel/api/setting/getDefaultJsonConfig": { - "get": { - "tags": [ - "Settings" - ], - "summary": "Return the built-in default Xray JSON config template that ships with this panel version.", - "operationId": "get_panel_api_setting_getDefaultJsonConfig", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/setting/apiTokens": { - "get": { - "tags": [ - "API Tokens" - ], - "summary": "List every API token, enabled or not. The token value is never returned — only metadata.", - "operationId": "get_panel_api_setting_apiTokens", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": [ - { - "id": 1, - "name": "default", - "enabled": true, - "createdAt": 1736000000 - } - ] - } - } - } - } - } - } - }, - "/panel/api/setting/apiTokens/create": { - "post": { - "tags": [ - "API Tokens" - ], - "summary": "Mint a scoped API token. The server-generated plaintext is returned only once and stored as a hash.", - "operationId": "post_panel_api_setting_apiTokens_create", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Human-readable label, e.g. \"central-panel-a\"." - }, - "scope": { - "type": "string", - "description": "admin (default), monitor, or node-sync." - }, - "expiresAt": { - "type": "integer", - "description": "Future Unix milliseconds, or 0 for no expiry." - } - }, - "required": [ - "name", - "scope", - "expiresAt" - ] - }, - "example": { - "name": "central-panel-a", - "scope": "node-sync", - "expiresAt": 1798761600000 - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/ApiTokenView" - } - } - }, - "example": { - "success": true, - "obj": { - "createdAt": 1736000000, - "enabled": true, - "expiresAt": 0, - "id": 2, - "name": "central-panel-a", - "scope": "admin", - "token": "new-token-string" - } - } - } - } - }, - "400": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - } - } - }, - "example": { - "success": false, - "msg": "a token with that name already exists" - } - } - } - } - } - } - }, - "/panel/api/setting/apiTokens/delete/{id}": { - "post": { - "tags": [ - "API Tokens" - ], - "summary": "Permanently delete a token. Any caller using it stops authenticating immediately.", - "operationId": "post_panel_api_setting_apiTokens_delete_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Token row ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "expectedScope": { - "type": "string", - "description": "Stored scope expected by the operator." - } - }, - "required": [ - "expectedScope" - ] - }, - "example": { - "expectedScope": "node-sync" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/setting/apiTokens/setEnabled/{id}": { - "post": { - "tags": [ - "API Tokens" - ], - "summary": "Toggle a token enabled/disabled without deleting it. Disabled tokens are rejected by checkAPIAuth on the next request.", - "operationId": "post_panel_api_setting_apiTokens_setEnabled_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Token row ID.", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "New enabled state." - }, - "expectedScope": { - "type": "string", - "description": "Stored scope expected by the operator." - } - }, - "required": [ - "enabled", - "expectedScope" - ] - }, - "example": { - "enabled": false, - "expectedScope": "node-sync" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true - } - } - } - } - } - } - }, - "/panel/api/xray/": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Return the Xray config template (JSON string), available inbound tags, client reverse tags, and the configured outbound test URL in one response.", - "operationId": "post_panel_api_xray", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "success": true, - "obj": { - "xraySetting": "{...raw xray config...}", - "inboundTags": "[\"in-443-tcp\"]", - "clientReverseTags": "[]", - "outboundTestUrl": "https://www.google.com/generate_204" - } - } - } - } - } - } - } - }, - "/panel/api/xray/getDefaultJsonConfig": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "Return the built-in default Xray config shipped with the panel (identical to /panel/api/setting/getDefaultJsonConfig).", - "operationId": "get_panel_api_xray_getDefaultJsonConfig", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/getOutboundsTraffic": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "Return traffic statistics for every outbound. Each outbound shows up/down/total counters.", - "operationId": "get_panel_api_xray_getOutboundsTraffic", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/getXrayResult": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "Return the most recent Xray process stdout/stderr output. Useful to check for startup errors or runtime warnings.", - "operationId": "get_panel_api_xray_getXrayResult", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/update": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Save the Xray JSON config template and optionally the outbound test URL. Both are sent as form fields.", - "operationId": "post_panel_api_xray_update", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/warp/{action}": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Manage Cloudflare Warp integration. The action parameter selects the operation.", - "operationId": "post_panel_api_xray_warp_action", - "parameters": [ - { - "name": "action", - "in": "path", - "required": true, - "description": "data — return Warp stats (quota, remaining). del — delete Warp data. config — return current Warp config. reg — register a new Warp endpoint (sends privateKey, publicKey). license — set a Warp+ license key (sends license).", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/nord/{action}": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Manage NordVPN integration. The action parameter selects the operation.", - "operationId": "post_panel_api_xray_nord_action", - "parameters": [ - { - "name": "action", - "in": "path", - "required": true, - "description": "countries — list available countries. servers — list servers in a country (sends countryId). reg — get NordVPN credentials (sends token). setKey — store NordVPN API key (sends key). data — return current NordVPN connection data. del — delete NordVPN data.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/pia/{action}": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Manage PIA WireGuard integration. The action parameter selects the operation.", - "operationId": "post_panel_api_xray_pia_action", - "parameters": [ - { - "name": "action", - "in": "path", - "required": true, - "description": "countries — list available countries from the signed PIA server list. servers — list regions and WireGuard servers in a country (sends countryCode). reg — sign in with a PIA username and password (sends username, password). data — return the signed-in account hint. del — delete stored PIA credentials. addKey — register a WireGuard key with the selected server (sends hostname) and return fields to build the outbound.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/resetOutboundsTraffic": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Reset traffic counters for a specific outbound by tag.", - "operationId": "post_panel_api_xray_resetOutboundsTraffic", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/testOutbound": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Test an outbound configuration. Sends the outbound JSON (required), optionally all outbounds (to resolve sockopt.dialerProxy dependencies), and a mode flag.", - "operationId": "post_panel_api_xray_testOutbound", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/testOutbounds": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Test a batch of outbounds (max 50) through one shared temp xray instance. Returns an array of results in input order, each with the outbound tag, delay, HTTP status and a connect/TLS/TTFB timing breakdown.", - "operationId": "post_panel_api_xray_testOutbounds", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/balancerStatus": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Live state of routing balancers in the running core (RoutingService.GetBalancerInfo): current override and the targets the strategy prefers. Returns a map keyed by balancer tag.", - "operationId": "post_panel_api_xray_balancerStatus", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/balancerOverride": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Force a balancer in the running core to always pick one outbound (RoutingService.OverrideBalancerTarget). Applied live without a restart; cleared automatically when Xray restarts.", - "operationId": "post_panel_api_xray_balancerOverride", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/routeTest": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Ask the running core which outbound its router would pick for a synthetic connection (RoutingService.TestRoute). No traffic is sent.", - "operationId": "post_panel_api_xray_routeTest", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/geodata/files": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "List the geo databases (.dat files) in the Xray asset folder, with the layout detected from their contents, size, modification time and category count. A database that fails to parse is still listed, with the reason in \"error\".", - "operationId": "get_panel_api_xray_geodata_files", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/geodata/categories": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "One page of a database's categories, each with its entry count and the attributes its domains carry (e.g. \"ads\", \"cn\").", - "operationId": "get_panel_api_xray_geodata_categories", - "parameters": [ - { - "name": "file", - "in": "query", - "required": true, - "description": "Database file name inside the asset folder, e.g. geosite.dat (required).", - "schema": { - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "required": false, - "description": "Case-insensitive substring filter on the category code.", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "required": false, - "description": "Rows to skip. Defaults to 0.", - "schema": { - "type": "integer" - } - }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "Rows to return, capped at 500. Omit it to return every category — the index is small and the panel filters it client-side.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/geodata/entries": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "One page of the rules inside a category — domain rules typed as domain/full/keyword/regexp for geosite databases, CIDRs for geoip ones.", - "operationId": "get_panel_api_xray_geodata_entries", - "parameters": [ - { - "name": "file", - "in": "query", - "required": true, - "description": "Database file name inside the asset folder (required).", - "schema": { - "type": "string" - } - }, - { - "name": "code", - "in": "query", - "required": true, - "description": "Category code, case-insensitive, e.g. google (required).", - "schema": { - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "required": false, - "description": "Case-insensitive substring filter on the rule value.", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "required": false, - "description": "Rows to skip. Defaults to 0.", - "schema": { - "type": "integer" - } - }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "Rows to return, capped at 500. Defaults to the cap.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/geodata/validate": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Check routing tokens against the databases on disk and return only the ones that do not resolve. Plain domains and CIDRs are ignored. Each issue carries a reason: syntax, fileMissing or categoryMissing.", - "operationId": "post_panel_api_xray_geodata_validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs": { - "get": { - "tags": [ - "Xray Settings" - ], - "summary": "List all outbound subscriptions (remote URLs that supply additional outbounds), newest first.", - "operationId": "get_panel_api_xray_outbound_subs", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Create an outbound subscription. The URL is fetched, parsed into outbounds with stable tags, and merged additively into the running Xray config.", - "operationId": "post_panel_api_xray_outbound_subs", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs/{id}": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Update an existing outbound subscription by id. Accepts the same form fields as create.", - "operationId": "post_panel_api_xray_outbound_subs_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Subscription id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Xray Settings" - ], - "summary": "Delete an outbound subscription by id.", - "operationId": "delete_panel_api_xray_outbound_subs_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Subscription id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs/{id}/del": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Delete an outbound subscription by id (POST alias of DELETE for clients that cannot send DELETE).", - "operationId": "post_panel_api_xray_outbound_subs_id_del", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Subscription id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs/{id}/refresh": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Force an immediate re-fetch of the subscription and return the parsed outbounds. Signals Xray to reload.", - "operationId": "post_panel_api_xray_outbound_subs_id_refresh", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Subscription id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs/{id}/move": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Reorder a subscription one step up or down in priority (controls its position in the merged outbounds).", - "operationId": "post_panel_api_xray_outbound_subs_id_move", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Subscription id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/xray/outbound-subs/parse": { - "post": { - "tags": [ - "Xray Settings" - ], - "summary": "Preview a subscription URL: fetch and parse it into outbounds without persisting anything.", - "operationId": "post_panel_api_xray_outbound_subs_parse", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/panel/api/sub-balancers": { - "get": { - "tags": [ - "Subscription Balancers" - ], - "summary": "List all subscription balancers in sort order (sort_order asc, id asc).", - "operationId": "get_panel_api_sub_balancers", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubBalancer" - } - } - } - }, - "example": { - "success": true, - "obj": [ - { - "createdAt": 1710000000000, - "enabled": true, - "id": 1, - "inboundIds": [ - 1, - 3 - ], - "remark": "auto-fastest", - "sortOrder": 1, - "strategy": "random", - "updatedAt": 1710000000000 - } - ] - } - } - } - } - } - }, - "post": { - "tags": [ - "Subscription Balancers" - ], - "summary": "Create a subscription balancer. It appears in the JSON subscription of every client that sits on at least one selected inbound.", - "operationId": "post_panel_api_sub_balancers", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/SubBalancer" - } - } - }, - "example": { - "success": true, - "obj": { - "createdAt": 1710000000000, - "enabled": true, - "id": 1, - "inboundIds": [ - 1, - 3 - ], - "remark": "auto-fastest", - "sortOrder": 1, - "strategy": "random", - "updatedAt": 1710000000000 - } - } - } - } - } - } - } - }, - "/panel/api/sub-balancers/{id}": { - "post": { - "tags": [ - "Subscription Balancers" - ], - "summary": "Update a balancer by id. Accepts the same form fields as create (full-row update, including the enabled toggle).", - "operationId": "post_panel_api_sub_balancers_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Balancer id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/SubBalancer" - } - } - }, - "example": { - "success": true, - "obj": { - "createdAt": 1710000000000, - "enabled": true, - "id": 1, - "inboundIds": [ - 1, - 3 - ], - "remark": "auto-fastest", - "sortOrder": 1, - "strategy": "random", - "updatedAt": 1710000000000 - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Subscription Balancers" - ], - "summary": "Delete a balancer by id.", - "operationId": "delete_panel_api_sub_balancers_id", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Balancer id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/SubBalancer" - } - } - }, - "example": { - "success": true, - "obj": { - "createdAt": 1710000000000, - "enabled": true, - "id": 1, - "inboundIds": [ - 1, - 3 - ], - "remark": "auto-fastest", - "sortOrder": 1, - "strategy": "random", - "updatedAt": 1710000000000 - } - } - } - } - } - } - } - }, - "/panel/api/sub-balancers/{id}/del": { - "post": { - "tags": [ - "Subscription Balancers" - ], - "summary": "Delete a balancer by id (POST alias of DELETE for clients that cannot send DELETE).", - "operationId": "post_panel_api_sub_balancers_id_del", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "Balancer id.", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": { - "$ref": "#/components/schemas/SubBalancer" - } - } - }, - "example": { - "success": true, - "obj": { - "createdAt": 1710000000000, - "enabled": true, - "id": 1, - "inboundIds": [ - 1, - 3 - ], - "remark": "auto-fastest", - "sortOrder": 1, - "strategy": "random", - "updatedAt": 1710000000000 - } - } - } - } - } - } - } - }, - "/{subPath}{subid}": { - "get": { - "tags": [ - "Subscription Server" - ], - "summary": "Return base64-encoded subscription links for all enabled clients matching the subscription ID. When the request has an Accept: text/html header or ?html=1, renders a styled info page instead. With ?format=info, returns the page view-model as JSON (traffic, expiry, online status; no links) for live polling. Default path: /sub/:subid.", - "operationId": "get_subPath_subid", - "parameters": [ - { - "name": "subid", - "in": "path", - "required": true, - "description": "Client subscription ID.", - "schema": { - "type": "string" - } - }, - { - "name": "format", - "in": "query", - "required": false, - "description": "Set to \"info\" to get the subscription status view-model as JSON instead of the links.", - "schema": { - "type": "string" - } - }, - { - "name": "subPath", - "in": "path", - "required": true, - "description": "", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/{jsonPath}{subid}": { - "get": { - "tags": [ - "Subscription Server" - ], - "summary": "Return subscription as a JSON array of proxy configs (one per enabled client). Only when JSON subscription is enabled in settings. Default path: /json/:subid.", - "operationId": "get_jsonPath_subid", - "parameters": [ - { - "name": "subid", - "in": "path", - "required": true, - "description": "Client subscription ID.", - "schema": { - "type": "string" - } - }, - { - "name": "jsonPath", - "in": "path", - "required": true, - "description": "", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/{clashPath}{subid}": { - "get": { - "tags": [ - "Subscription Server" - ], - "summary": "Return subscription as a Clash/Mihomo-compatible YAML config, including configured global Clash routing rules. Only when Clash subscription is enabled in settings. Default path: /clash/:subid.", - "operationId": "get_clashPath_subid", - "parameters": [ - { - "name": "subid", - "in": "path", - "required": true, - "description": "Client subscription ID.", - "schema": { - "type": "string" - } - }, - { - "name": "clashPath", - "in": "path", - "required": true, - "description": "", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "/ws": { - "get": { - "tags": [ - "WebSocket" - ], - "summary": "Upgrade an HTTP connection to a WebSocket. Requires an authenticated session cookie (Bearer token auth is not supported here). Returns 101 Switching Protocols on success. The server then pushes JSON messages described below.", - "operationId": "get_ws", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - } - } - } - } - } - } - }, - "→ type: status": { - "ws": { - "tags": [ - "WebSocket" - ], - "summary": "Server health snapshot pushed every 2 seconds. Contains CPU, memory, swap, disk, network IO, load, and Xray state — same shape as GET /panel/api/server/status.", - "operationId": "ws_type_status", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "type": "status", - "data": { - "cpu": 12.5, - "mem": { - "current": 2147483648, - "total": 8589934592 - }, - "xray": { - "state": "running" - } - } - } - } - } - } - } - } - }, - "→ type: xrayState": { - "ws": { - "tags": [ - "WebSocket" - ], - "summary": "Xray process state change. Fired when Xray starts, stops, or encounters an error.", - "operationId": "ws_type_xrayState", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "type": "xrayState", - "data": "running" - } - } - } - } - } - } - }, - "→ type: notification": { - "ws": { - "tags": [ - "WebSocket" - ], - "summary": "In-panel toast notification. Fired on Xray stop/restart, DB import, panel restart, etc.", - "operationId": "ws_type_notification", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "type": "notification", - "title": "Xray service restarted", - "body": "Xray has been restarted successfully", - "severity": "success" - } - } - } - } - } - } - }, - "→ type: invalidate": { - "ws": { - "tags": [ - "WebSocket" - ], - "summary": "Instructs the UI to re-fetch a resource. Fired when another admin session modifies data (e.g. toggling inbound enable).", - "operationId": "ws_type_invalidate", - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "msg": { - "type": "string" - }, - "obj": {} - } - }, - "example": { - "type": "invalidate", - "resource": "inbounds" - } - } - } - } - } - } - } - } -} diff --git a/frontend/scripts/build-openapi.mjs b/frontend/scripts/build-openapi.mjs deleted file mode 100644 index 91003b1..0000000 --- a/frontend/scripts/build-openapi.mjs +++ /dev/null @@ -1,246 +0,0 @@ -#!/usr/bin/env node -import { writeFileSync } from 'node:fs'; -import { join, dirname } from 'node:path'; -import { fileURLToPath, pathToFileURL } from 'node:url'; - -import { sections } from '../src/pages/api-docs/endpoints.ts'; -import { EXAMPLES } from '../src/generated/examples.ts'; -import { SCHEMAS } from '../src/generated/schemas.ts'; - -const __dirname = dirname(fileURLToPath(import.meta.url)); -const outPath = join(__dirname, '..', 'public', 'openapi.json'); - -const PANEL_VERSION = process.env.X_UI_VERSION || '3.x'; - -const SECURITY_SCHEMES = { - bearerAuth: { - type: 'http', - scheme: 'bearer', - description: 'API token from Settings → Security → API Token. Send as `Authorization: Bearer `.', - }, - cookieAuth: { - type: 'apiKey', - in: 'cookie', - name: '3x-ui', - description: 'Session cookie set by POST /login. Browser-only.', - }, -}; - -function ginPathToOpenApi(path) { - return path.replace(/:([A-Za-z_][A-Za-z0-9_]*)/g, '{$1}'); -} - -function extractPathParams(openApiPath) { - const params = []; - const re = /\{([A-Za-z_][A-Za-z0-9_]*)\}/g; - let m; - while ((m = re.exec(openApiPath)) !== null) params.push(m[1]); - return params; -} - -function mapType(t) { - const v = String(t || '').toLowerCase(); - if (v.endsWith('[]')) return 'array'; - if (v === 'number' || v === 'integer' || v === 'int') return 'integer'; - if (v === 'float' || v === 'double') return 'number'; - if (v === 'boolean' || v === 'bool') return 'boolean'; - if (v === 'array') return 'array'; - if (v === 'object') return 'object'; - return 'string'; -} - -function schemaFromType(t) { - const v = String(t || '').toLowerCase(); - if (v.endsWith('[]')) { - const itemType = v.slice(0, -2); - return { type: 'array', items: { type: mapType(itemType) } }; - } - return { type: mapType(v) }; -} - -function tryParseJson(raw) { - if (typeof raw !== 'string') return undefined; - try { - return JSON.parse(raw); - } catch { - return undefined; - } -} - -function paramToOpenApi(p) { - const out = { - name: p.name, - in: p.in, - required: p.in === 'path' ? true : !p.optional, - description: p.desc || '', - schema: schemaFromType(p.type), - }; - if (p.defaultValue !== undefined) out.schema.default = p.defaultValue; - return out; -} - -function buildOperation(ep, tag) { - const op = { - tags: [tag], - summary: ep.summary || '', - operationId: `${ep.method.toLowerCase()}_${ep.path.replace(/[^A-Za-z0-9]+/g, '_').replace(/^_|_$/g, '')}`, - }; - if (ep.description) op.description = ep.description; - if (ep.deprecated) op.deprecated = true; - - const params = []; - const bodyParams = []; - for (const p of ep.params || []) { - if (p.in === 'body') { - bodyParams.push(p); - } else if (p.in === 'path' || p.in === 'query' || p.in === 'header') { - params.push(paramToOpenApi(p)); - } - } - - const openApiPath = ginPathToOpenApi(ep.path); - const declared = new Set(params.filter((x) => x.in === 'path').map((x) => x.name)); - for (const name of extractPathParams(openApiPath)) { - if (declared.has(name)) continue; - params.push({ - name, - in: 'path', - required: true, - description: '', - schema: { type: 'string' }, - }); - } - - if (params.length > 0) op.parameters = params; - - if (ep.body || bodyParams.length > 0) { - const example = tryParseJson(ep.body); - const properties = {}; - const required = []; - for (const bp of bodyParams) { - properties[bp.name] = { - ...schemaFromType(bp.type), - description: bp.desc || '', - }; - if (!bp.optional) required.push(bp.name); - } - const schema = bodyParams.length > 0 - ? { type: 'object', properties, ...(required.length > 0 ? { required } : {}) } - : { type: 'object' }; - - op.requestBody = { - required: required.length > 0 || bodyParams.length === 0, - content: { - 'application/json': { - schema, - ...(example !== undefined ? { example } : {}), - }, - }, - }; - } - - const responses = {}; - let successExample = tryParseJson(ep.response); - let objSchema = {}; - if (ep.responseSchema) { - const obj = EXAMPLES[ep.responseSchema]; - if (obj === undefined) { - throw new Error(`${ep.method} ${ep.path}: responseSchema "${ep.responseSchema}" has no generated example`); - } - if (SCHEMAS[ep.responseSchema] === undefined) { - throw new Error(`${ep.method} ${ep.path}: responseSchema "${ep.responseSchema}" has no generated schema`); - } - const ref = { $ref: `#/components/schemas/${ep.responseSchema}` }; - objSchema = ep.responseSchemaArray ? { type: 'array', items: ref } : ref; - if (successExample === undefined) { - successExample = { success: true, obj: ep.responseSchemaArray ? [obj] : obj }; - } - } - responses['200'] = { - description: 'Successful response', - content: { - 'application/json': { - schema: { - type: 'object', - properties: { - success: { type: 'boolean' }, - msg: { type: 'string' }, - obj: objSchema, - }, - }, - ...(successExample !== undefined ? { example: successExample } : {}), - }, - }, - }; - - const errExample = tryParseJson(ep.errorResponse); - if (errExample !== undefined || ep.errorStatus) { - const code = String(ep.errorStatus || 400); - responses[code] = { - description: 'Error response', - content: { - 'application/json': { - schema: { - type: 'object', - properties: { - success: { type: 'boolean' }, - msg: { type: 'string' }, - }, - }, - ...(errExample !== undefined ? { example: errExample } : {}), - }, - }, - }; - } - - op.responses = responses; - return op; -} - -function buildSpec() { - const paths = {}; - for (const section of sections) { - const tag = section.title; - for (const ep of section.endpoints) { - const openApiPath = ginPathToOpenApi(ep.path); - if (!paths[openApiPath]) paths[openApiPath] = {}; - paths[openApiPath][ep.method.toLowerCase()] = buildOperation(ep, tag); - } - } - - const tags = sections.map((s) => ({ - name: s.title, - description: s.description || '', - })); - - return { - openapi: '3.0.3', - info: { - title: '3X-UI Panel API', - version: PANEL_VERSION, - description: - 'Programmatic interface to a 3X-UI panel. Authenticate either by logging in (cookie) or with an API token from Settings → Security → API Token (Bearer). All endpoints under /panel/api/* honour both modes — an API token is a full-admin credential, so treat it like the panel password.', - }, - servers: [ - { url: '/', description: 'Current panel (basePath aware)' }, - ], - components: { - securitySchemes: SECURITY_SCHEMES, - schemas: SCHEMAS, - }, - security: [{ bearerAuth: [] }, { cookieAuth: [] }], - tags, - paths, - }; -} - -const spec = buildSpec(); -writeFileSync(outPath, JSON.stringify(spec, null, 2) + '\n'); - -const pathCount = Object.keys(spec.paths).length; -let opCount = 0; -for (const ops of Object.values(spec.paths)) opCount += Object.keys(ops).length; -console.log(`[openapi] wrote ${outPath}`); -console.log(`[openapi] paths: ${pathCount}, operations: ${opCount}, tags: ${spec.tags.length}`); - -void pathToFileURL; diff --git a/frontend/src/api/queryKeys.ts b/frontend/src/api/queryKeys.ts index 313fcff..ef3ba98 100644 --- a/frontend/src/api/queryKeys.ts +++ b/frontend/src/api/queryKeys.ts @@ -36,7 +36,6 @@ export const keys = { onlinesByGuid: () => ['clients', 'onlinesByGuid'] as const, activeInbounds: () => ['clients', 'activeInbounds'] as const, lastOnline: () => ['clients', 'lastOnline'] as const, - groups: () => ['clients', 'groups'] as const, }, xray: { root: () => ['xray'] as const, diff --git a/frontend/src/hooks/useClients.ts b/frontend/src/hooks/useClients.ts index 3e087f4..9342eb9 100644 --- a/frontend/src/hooks/useClients.ts +++ b/frontend/src/hooks/useClients.ts @@ -162,7 +162,7 @@ async function fetchDefaults(): Promise> { } export interface UseClientsOptions { - // Callers that only need the mutations — the bulk modals, the groups page — + // Callers that only need the mutations — the bulk modals — // pass false. Mounting them used to start a second 5-second poll of the paged // list whose result they never read, which on a large panel means a full // summary aggregate every 5 seconds for nothing. @@ -328,22 +328,6 @@ export function useClients(options: UseClientsOptions = {}) { }, }); - const bulkAddToGroupMut = useMutation({ - mutationFn: (body: { emails: string[]; group: string }) => - HttpUtil.post('/panel/api/clients/groups/bulkAdd', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidateAll(); - }, - }); - - const bulkRemoveFromGroupMut = useMutation({ - mutationFn: (body: { emails: string[] }) => - HttpUtil.post('/panel/api/clients/groups/bulkRemove', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidateAll(); - }, - }); - const updateMut = useMutation({ mutationFn: ({ email, client }: { email: string; client: unknown }) => HttpUtil.post(`/panel/api/clients/update/${encodeURIComponent(email)}`, client, JSON_HEADERS), @@ -583,20 +567,6 @@ export function useClients(options: UseClientsOptions = {}) { }, [bulkSetEnableMut], ); - const bulkAddToGroup = useCallback( - (emails: string[], group: string) => { - if (!Array.isArray(emails) || emails.length === 0) return Promise.resolve(null); - return bulkAddToGroupMut.mutateAsync({ emails, group }); - }, - [bulkAddToGroupMut], - ); - const bulkRemoveFromGroup = useCallback( - (emails: string[]) => { - if (!Array.isArray(emails) || emails.length === 0) return Promise.resolve(null); - return bulkRemoveFromGroupMut.mutateAsync({ emails }); - }, - [bulkRemoveFromGroupMut], - ); const attach = useCallback( (email: string, inboundIds: number[]) => { if (!email) return Promise.resolve(null as unknown as Msg); @@ -807,8 +777,6 @@ export function useClients(options: UseClientsOptions = {}) { bulkAdjust, bulkEnable, bulkDisable, - bulkAddToGroup, - bulkRemoveFromGroup, attach, setExternalLinks, bulkAttach, diff --git a/frontend/src/hooks/usePageTitle.ts b/frontend/src/hooks/usePageTitle.ts index c6f1816..48011a0 100644 --- a/frontend/src/hooks/usePageTitle.ts +++ b/frontend/src/hooks/usePageTitle.ts @@ -6,14 +6,12 @@ const TITLE_KEYS: Record = { '/': 'menu.dashboard', '/inbounds': 'menu.inbounds', '/clients': 'menu.clients', - '/groups': 'menu.groups', '/nodes': 'menu.nodes', '/hosts': 'menu.hosts', '/settings': 'menu.settings', '/xray': 'menu.xray', '/outbound': 'menu.outbounds', '/routing': 'menu.routing', - '/api-docs': 'menu.apiDocs', }; export function usePageTitle() { diff --git a/frontend/src/layouts/AppSidebar.tsx b/frontend/src/layouts/AppSidebar.tsx index 57378b1..37bb182 100644 --- a/frontend/src/layouts/AppSidebar.tsx +++ b/frontend/src/layouts/AppSidebar.tsx @@ -214,14 +214,12 @@ export default function AppSidebar() { { key: '/', icon: 'dashboard', title: t('menu.dashboard') }, { key: '/inbounds', icon: 'inbound', title: t('menu.inbounds') }, { key: '/clients', icon: 'team', title: t('menu.clients') }, - { key: '/groups', icon: 'groups', title: t('menu.groups') }, { key: '/nodes', icon: 'cluster', title: t('menu.nodes') }, { key: '/hosts', icon: 'hosts', title: t('menu.hosts') }, { key: '/outbound', icon: 'outbound', title: t('menu.outbounds') }, { key: '/routing', icon: 'routing', title: t('menu.routing') }, { key: '/settings', icon: 'setting', title: t('menu.settings') }, { key: '/xray', icon: 'tool', title: t('menu.xray') }, - { key: '/api-docs', icon: 'apidocs', title: t('menu.apiDocs') }, { key: LOGOUT_KEY, icon: 'logout', title: t('logout') }, ], [t], diff --git a/frontend/src/pages/api-docs/ApiDocsPage.css b/frontend/src/pages/api-docs/ApiDocsPage.css deleted file mode 100644 index 1a6ba20..0000000 --- a/frontend/src/pages/api-docs/ApiDocsPage.css +++ /dev/null @@ -1,421 +0,0 @@ -.api-docs-page.is-dark { - --sw-bg: #1f2026; - --sw-bg-soft: #25272e; - --sw-bg-input: #15161a; - --sw-bg-code: #0d0e12; - --sw-border: rgba(255, 255, 255, 0.08); - --sw-border-strong: rgba(255, 255, 255, 0.15); - --sw-text: rgba(255, 255, 255, 0.88); - --sw-text-muted: rgba(255, 255, 255, 0.6); - --sw-text-dim: rgba(255, 255, 255, 0.45); - --sw-accent: #58a6ff; - color-scheme: dark; -} - -.api-docs-page.is-dark.is-ultra { - --sw-bg: #0a0a0d; - --sw-bg-soft: #131316; - --sw-bg-input: #050507; - --sw-bg-code: #000; - --sw-border: rgba(255, 255, 255, 0.06); - --sw-border-strong: rgba(255, 255, 255, 0.12); -} - -.api-docs-page .content-shell { - background: var(--bg-page); -} - -.api-docs-page .content-area { - padding: 16px; - max-width: 100%; -} - -@media (max-width: 768px) { - .api-docs-page .content-area { - padding: 8px; - padding-top: 56px; - } -} - -.api-docs-page .docs-wrapper { - background: var(--bg-card); - border-radius: 8px; - border: 1px solid var(--ant-color-border-secondary); - overflow: hidden; -} - -.api-docs-page .swagger-ui { - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; -} - -/* ────────────────────────────────────────────────────────────────── - Dark mode — Swagger UI does not ship a dark theme, so every visual - surface needs an explicit override. Method-color chips (GET / POST / - …) are left untouched because they carry meaning at a glance. - ────────────────────────────────────────────────────────────────── */ - -.api-docs-page.is-dark .swagger-ui, -.api-docs-page.is-dark .swagger-ui .info .title, -.api-docs-page.is-dark .swagger-ui .info .title small pre, -.api-docs-page.is-dark .swagger-ui .info p, -.api-docs-page.is-dark .swagger-ui .info li, -.api-docs-page.is-dark .swagger-ui .info table, -.api-docs-page.is-dark .swagger-ui .opblock-tag, -.api-docs-page.is-dark .swagger-ui .opblock-tag small, -.api-docs-page.is-dark .swagger-ui .opblock .opblock-summary-path, -.api-docs-page.is-dark .swagger-ui .opblock .opblock-summary-path__deprecated, -.api-docs-page.is-dark .swagger-ui .opblock .opblock-summary-description, -.api-docs-page.is-dark .swagger-ui .opblock-description-wrapper p, -.api-docs-page.is-dark .swagger-ui .opblock-external-docs-wrapper p, -.api-docs-page.is-dark .swagger-ui .opblock-title_normal p, -.api-docs-page.is-dark .swagger-ui table thead tr td, -.api-docs-page.is-dark .swagger-ui table thead tr th, -.api-docs-page.is-dark .swagger-ui table tbody tr td, -.api-docs-page.is-dark .swagger-ui .parameter__name, -.api-docs-page.is-dark .swagger-ui .parameter__type, -.api-docs-page.is-dark .swagger-ui .parameter__in, -.api-docs-page.is-dark .swagger-ui .parameter__extension, -.api-docs-page.is-dark .swagger-ui .response-col_status, -.api-docs-page.is-dark .swagger-ui .response-col_description, -.api-docs-page.is-dark .swagger-ui .response-col_links, -.api-docs-page.is-dark .swagger-ui .responses-inner h4, -.api-docs-page.is-dark .swagger-ui .responses-inner h5, -.api-docs-page.is-dark .swagger-ui label, -.api-docs-page.is-dark .swagger-ui .tab li, -.api-docs-page.is-dark .swagger-ui .tab li button, -.api-docs-page.is-dark .swagger-ui .markdown, -.api-docs-page.is-dark .swagger-ui .markdown p, -.api-docs-page.is-dark .swagger-ui .markdown li, -.api-docs-page.is-dark .swagger-ui .renderedmarkdown p, -.api-docs-page.is-dark .swagger-ui .renderedmarkdown li, -.api-docs-page.is-dark .swagger-ui .model-title, -.api-docs-page.is-dark .swagger-ui .model, -.api-docs-page.is-dark .swagger-ui .model-toggle:after, -.api-docs-page.is-dark .swagger-ui section.models h4, -.api-docs-page.is-dark .swagger-ui section.models h5, -.api-docs-page.is-dark .swagger-ui .auth-container h4, -.api-docs-page.is-dark .swagger-ui .auth-container h6, -.api-docs-page.is-dark .swagger-ui .scopes h2, -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux-header h3, -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux-content h4, -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux-content p, -.api-docs-page.is-dark .swagger-ui .servers-title { - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .opblock-tag small, -.api-docs-page.is-dark .swagger-ui .opblock-summary-description, -.api-docs-page.is-dark .swagger-ui .parameter__in, -.api-docs-page.is-dark .swagger-ui .parameter__type, -.api-docs-page.is-dark .swagger-ui .parameter__extension, -.api-docs-page.is-dark .swagger-ui .opblock-title_normal small, -.api-docs-page.is-dark .swagger-ui .servers > label, -.api-docs-page.is-dark .swagger-ui .servers > label span, -.api-docs-page.is-dark .swagger-ui .response-control-media-type__accept-message { - color: var(--sw-text-muted); -} - -.api-docs-page.is-dark .swagger-ui .opblock-tag { - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .opblock { - background: var(--sw-bg-soft); - border-color: var(--sw-border); - box-shadow: none; -} - -.api-docs-page.is-dark .swagger-ui .opblock .opblock-section-header { - background: rgba(255, 255, 255, 0.03); - box-shadow: inset 0 -1px 0 var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .opblock .opblock-section-header h4, -.api-docs-page.is-dark .swagger-ui .opblock .opblock-section-header label { - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .opblock .opblock-summary { - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .opblock-body pre.microlight, -.api-docs-page.is-dark .swagger-ui .highlight-code, -.api-docs-page.is-dark .swagger-ui .microlight, -.api-docs-page.is-dark .swagger-ui pre.example, -.api-docs-page.is-dark .swagger-ui code { - background: var(--sw-bg-code); - color: rgba(255, 255, 255, 0.92); -} - -.api-docs-page.is-dark .swagger-ui .highlight-code .copy-to-clipboard { - background: rgba(255, 255, 255, 0.06); -} - -.api-docs-page.is-dark .swagger-ui input[type='text'], -.api-docs-page.is-dark .swagger-ui input[type='password'], -.api-docs-page.is-dark .swagger-ui input[type='search'], -.api-docs-page.is-dark .swagger-ui input[type='email'], -.api-docs-page.is-dark .swagger-ui input[type='file'], -.api-docs-page.is-dark .swagger-ui textarea { - background: var(--sw-bg-input); - color: var(--sw-text); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui select { - background-color: var(--sw-bg-input); - background-image: url("data:image/svg+xml;charset=utf-8,"); - background-position: right 10px center; - background-repeat: no-repeat; - background-size: 20px; - color: var(--sw-text); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui select option { - background-color: var(--sw-bg-input); - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui textarea { - font-family: ui-monospace, SFMono-Regular, Menlo, monospace; -} - -.api-docs-page.is-dark .swagger-ui input::placeholder, -.api-docs-page.is-dark .swagger-ui textarea::placeholder { - color: var(--sw-text-dim); -} - -.api-docs-page.is-dark .swagger-ui .scheme-container { - background: var(--sw-bg-soft); - box-shadow: inset 0 -1px 0 var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .auth-wrapper .authorize { - color: var(--sw-text); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui .auth-wrapper .authorize svg { - fill: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .model-box, -.api-docs-page.is-dark .swagger-ui section.models { - background: var(--sw-bg-soft); - border-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui section.models.is-open h4 { - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui section.models .model-container { - background: rgba(255, 255, 255, 0.02); - border-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui section.models .model-container:hover { - background: rgba(255, 255, 255, 0.04); -} - -.api-docs-page.is-dark .swagger-ui .prop-type, -.api-docs-page.is-dark .swagger-ui .prop-format { - color: var(--sw-accent); -} - -.api-docs-page.is-dark .swagger-ui .property.primitive { - color: var(--sw-text-muted); -} - -.api-docs-page.is-dark .swagger-ui .opblock-title_normal h4 { - color: var(--sw-text); - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui table.parameters, -.api-docs-page.is-dark .swagger-ui table.responses-table, -.api-docs-page.is-dark .swagger-ui table thead tr { - border-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui table tbody tr td { - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui table thead tr { - border-bottom-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui .response-col_status { - font-weight: 600; -} - -.api-docs-page.is-dark .swagger-ui .btn { - background: rgba(255, 255, 255, 0.06); - color: var(--sw-text); - border-color: var(--sw-border-strong); - box-shadow: none; -} - -.api-docs-page.is-dark .swagger-ui .btn:hover { - background: rgba(255, 255, 255, 0.1); -} - -.api-docs-page.is-dark .swagger-ui .btn.execute { - background: var(--sw-accent); - color: #0d1117; - border-color: var(--sw-accent); -} - -.api-docs-page.is-dark .swagger-ui .btn.execute:hover { - background: #79b9ff; -} - -.api-docs-page.is-dark .swagger-ui .btn.authorize { - color: #52c41a; - border-color: rgba(82, 196, 26, 0.4); - background: rgba(82, 196, 26, 0.08); -} - -.api-docs-page.is-dark .swagger-ui .btn.authorize svg { - fill: #52c41a; -} - -.api-docs-page.is-dark .swagger-ui .authorization__btn svg, -.api-docs-page.is-dark .swagger-ui .expand-operation svg, -.api-docs-page.is-dark .swagger-ui .opblock-control-arrow svg { - fill: var(--sw-text); - opacity: 1; -} - -.api-docs-page.is-dark .swagger-ui .authorization__btn .locked, -.api-docs-page.is-dark .swagger-ui .authorization__btn .unlocked { - opacity: 1; -} - -.api-docs-page.is-dark .swagger-ui .btn.cancel { - color: #ff7875; - border-color: rgba(255, 120, 117, 0.4); - background: rgba(255, 120, 117, 0.08); -} - -.api-docs-page.is-dark .swagger-ui .btn.btn-clear, -.api-docs-page.is-dark .swagger-ui .btn-clear, -.api-docs-page.is-dark .swagger-ui .try-out__btn { - color: var(--sw-text); - background: rgba(255, 255, 255, 0.06); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui .btn.btn-clear:hover, -.api-docs-page.is-dark .swagger-ui .btn-clear:hover, -.api-docs-page.is-dark .swagger-ui .try-out__btn:hover { - background: rgba(255, 255, 255, 0.1); -} - -.api-docs-page.is-dark .swagger-ui .filter .operation-filter-input { - background: var(--sw-bg-input); - border-color: var(--sw-border-strong); - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux { - background: var(--sw-bg); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux-header { - border-bottom-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .dialog-ux .modal-ux-content { - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .arrow, -.api-docs-page.is-dark .swagger-ui svg.arrow { - fill: var(--sw-text-muted); -} - -.api-docs-page.is-dark .swagger-ui .opblock-summary-control:focus { - outline-color: var(--sw-accent); -} - -.api-docs-page.is-dark .swagger-ui a, -.api-docs-page.is-dark .swagger-ui .info a, -.api-docs-page.is-dark .swagger-ui .info hgroup.main a, -.api-docs-page.is-dark .swagger-ui .info .base-url, -.api-docs-page.is-dark .swagger-ui .info__contact a, -.api-docs-page.is-dark .swagger-ui .info__license a, -.api-docs-page.is-dark .swagger-ui .info__tos a { - color: var(--sw-accent); -} - -.api-docs-page.is-dark .swagger-ui a:hover { - color: #79b9ff; -} - -.api-docs-page.is-dark .swagger-ui .info .title small { - background: rgba(255, 255, 255, 0.08); - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .info .title small pre { - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .response-control-media-type--accept-controller select { - border-color: rgba(82, 196, 26, 0.5); -} - -.api-docs-page.is-dark .swagger-ui .loading-container .loading:before { - border-color: var(--sw-accent) transparent transparent; -} - -.api-docs-page.is-dark .swagger-ui .json-schema-form-item input, -.api-docs-page.is-dark .swagger-ui .json-schema-form-item select { - background: var(--sw-bg-input); - color: var(--sw-text); - border-color: var(--sw-border-strong); -} - -.api-docs-page.is-dark .swagger-ui .topbar { - background: var(--sw-bg); -} - -.api-docs-page.is-dark .swagger-ui .information-container { - background: transparent; -} - -.api-docs-page.is-dark .swagger-ui .opblock-summary-method { - text-shadow: none; -} - -.api-docs-page.is-dark .swagger-ui .auth-btn-wrapper { - border-top-color: var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .servers .computed-url, -.api-docs-page.is-dark .swagger-ui .computed-url { - background: var(--sw-bg-code); - color: var(--sw-text); - border: 1px solid var(--sw-border); -} - -.api-docs-page.is-dark .swagger-ui .computed-url code, -.api-docs-page.is-dark .swagger-ui .servers .computed-url code { - background: transparent; - color: var(--sw-text); -} - -.api-docs-page.is-dark .swagger-ui .errors-wrapper { - background: rgba(255, 77, 79, 0.08); - border-color: rgba(255, 77, 79, 0.3); -} - -.api-docs-page.is-dark .swagger-ui .errors-wrapper .errors h4, -.api-docs-page.is-dark .swagger-ui .errors-wrapper .errors small { - color: var(--sw-text); -} diff --git a/frontend/src/pages/api-docs/ApiDocsPage.tsx b/frontend/src/pages/api-docs/ApiDocsPage.tsx deleted file mode 100644 index 960a0ca..0000000 --- a/frontend/src/pages/api-docs/ApiDocsPage.tsx +++ /dev/null @@ -1,46 +0,0 @@ -import { useMemo } from 'react'; -import { useTranslation } from 'react-i18next'; -import { ConfigProvider, Layout } from 'antd'; -import SwaggerUI from 'swagger-ui-react'; -import 'swagger-ui-react/swagger-ui.css'; - -import { useTheme } from '@/hooks/useTheme'; -import AppSidebar from '@/layouts/AppSidebar'; -import './ApiDocsPage.css'; - -const basePath = window.X_UI_BASE_PATH || ''; -const openApiUrl = `${basePath}panel/api/openapi.json`; - -export default function ApiDocsPage() { - const { isDark, isUltra, antdThemeConfig } = useTheme(); - const { t } = useTranslation(); - - const pageClass = useMemo(() => { - const classes = ['api-docs-page']; - if (isDark) classes.push('is-dark'); - if (isUltra) classes.push('is-ultra'); - return classes.join(' '); - }, [isDark, isUltra]); - - return ( - - - - - - -
- -
- - - - - ); -} diff --git a/frontend/src/pages/api-docs/endpoints.ts b/frontend/src/pages/api-docs/endpoints.ts deleted file mode 100644 index 09b5d0b..0000000 --- a/frontend/src/pages/api-docs/endpoints.ts +++ /dev/null @@ -1,2349 +0,0 @@ -export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'WS'; -export type ParamLocation = - | 'path' - | 'query' - | 'header' - | 'body' - | 'body (form)' - | 'body (json)' - | 'body (multipart)'; -export type ParamType = - | 'string' - | 'integer' - | 'integer[]' - | 'number' - | 'boolean' - | 'object' - | 'object[]' - | 'array' - | 'file'; - -export interface EndpointParam { - name: string; - in: ParamLocation; - type: ParamType; - desc?: string; - optional?: boolean; - defaultValue?: string | number | boolean; -} - -export interface Endpoint { - method: HttpMethod; - path: string; - summary: string; - description?: string; - deprecated?: boolean; - params?: EndpointParam[]; - body?: string; - response?: string; - errorResponse?: string; - errorStatus?: number; - responseSchema?: string; - responseSchemaArray?: boolean; -} - -export interface SubscriptionHeader { - name: string; - desc: string; -} - -export interface Section { - id: string; - title: string; - description?: string; - subHeader?: SubscriptionHeader[]; - endpoints: Endpoint[]; -} - -export const sections: readonly Section[] = [ - { - id: 'authentication', - title: 'Authentication', - description: - 'Two authentication modes are supported. UI sessions use a cookie set by the login endpoint. Programmatic clients (bots, scripts, remote panels) authenticate with a Bearer token taken from Settings → Security → API Token. Both work for every endpoint under /panel/api/*.', - endpoints: [ - { - method: 'POST', - path: '/login', - summary: - 'Authenticate with username + password and receive a session cookie. Required before any cookie-based API call.', - params: [ - { name: 'username', in: 'body', type: 'string', desc: 'Panel admin username.' }, - { name: 'password', in: 'body', type: 'string', desc: 'Panel admin password.' }, - { - name: 'twoFactorCode', - in: 'body', - type: 'string', - desc: 'OTP code when 2FA is enabled. Omit otherwise.', - }, - ], - body: '{\n "username": "admin",\n "password": "admin",\n "twoFactorCode": "123456"\n}', - response: '{\n "success": true,\n "msg": "Logged in successfully"\n}', - errorResponse: '{\n "success": false,\n "msg": "Wrong username or password"\n}', - }, - { - method: 'POST', - path: '/logout', - summary: 'Clear the session cookie. Requires the CSRF header for browser sessions.', - response: '{\n "success": true\n}', - }, - { - method: 'GET', - path: '/csrf-token', - summary: - 'Mint a CSRF token for the current session. The SPA replays it in the X-CSRF-Token header on unsafe requests. Bearer-token callers can skip this — the middleware short-circuits CSRF for authenticated API requests.', - response: '{\n "success": true,\n "obj": "csrf-token-string"\n}', - }, - { - method: 'POST', - path: '/getTwoFactorEnable', - summary: - 'Returns whether 2FA is enabled on the panel — used by the login page to decide whether to show the OTP field.', - response: '{\n "success": true,\n "obj": false\n}', - }, - ], - }, - - { - id: 'inbounds', - title: 'Inbounds', - description: - 'Manage inbound configurations and their clients. All endpoints live under /panel/api/inbounds and require a logged-in session or Bearer token. Link-generating endpoints honour forwarded headers only when the request comes from a configured trusted proxy.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/inbounds/list', - summary: - 'List every inbound owned by the authenticated user, including each inbound’s clientStats traffic counters. settings, streamSettings, and sniffing are returned as nested JSON objects (no escaped strings); legacy callers that send them back as JSON-encoded strings are still accepted on write.', - responseSchema: 'Inbound', - responseSchemaArray: true, - }, - { - method: 'GET', - path: '/panel/api/inbounds/list/slim', - summary: - 'Same shape as /list but with settings.clients[] stripped down to {email, enable, comment} and ClientStats not enriched with UUID/SubId. Use this for list pages; fetch /get/:id when you need the full per-client payload (uuid, password, flow, ...).', - response: - '{\n "success": true,\n "obj": [\n {\n "id": 1,\n "remark": "VLESS-443",\n "settings": {\n "clients": [\n { "email": "alice", "enable": true }\n ],\n "decryption": "none"\n },\n "clientStats": []\n }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/inbounds/options', - summary: - 'Lightweight picker projection of the authenticated user’s inbounds. Returns id, remark, tag, protocol, port, a server-computed tlsFlowCapable flag (true for VLESS on TCP with tls or reality, or on XHTTP with VLESS encryption / vlessenc enabled), and ssMethod (the Shadowsocks cipher, empty for non-Shadowsocks inbounds — used by the client UI to generate a valid Shadowsocks 2022 PSK). Use this for dropdowns and attach pickers — it skips settings, streamSettings, and clientStats so the payload stays small even on panels with thousands of clients.', - responseSchema: 'InboundOption', - responseSchemaArray: true, - }, - { - method: 'GET', - path: '/panel/api/inbounds/allLinks', - summary: - 'Return every protocol URL (vless://, vmess://, trojan://, ss://, hysteria://, mtproto) across all inbounds and all of their clients. Links are rendered through the subscription engine, so the configured remark template (name-only display part) is applied per client — the same output the client info/QR pages use. Protocols without a URL form (socks, http, mixed, wireguard, dokodemo, tunnel) contribute nothing. Used by the panel’s "Export all inbound links" action.', - response: - '{\n "success": true,\n "obj": [\n "vless://uuid@host:443?security=reality&...#Germany-alice",\n "vmess://eyJ2IjoyLC..."\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/inbounds/get/:id', - summary: 'Fetch a single inbound by numeric ID.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - }, - { - method: 'POST', - path: '/panel/api/inbounds/add', - summary: - 'Create a new inbound. Send the full inbound payload (protocol, port, settings, streamSettings, sniffing, remark, expiryTime, total, enable). settings, streamSettings, and sniffing may be sent as nested JSON objects (preferred) or as JSON-encoded strings (legacy).', - body: '{\n "enable": true,\n "remark": "VLESS-443",\n "listen": "",\n "port": 443,\n "protocol": "vless",\n "expiryTime": 0,\n "total": 0,\n "settings": {\n "clients": [{ "id": "...", "email": "user1" }],\n "decryption": "none",\n "fallbacks": []\n },\n "streamSettings": {\n "network": "tcp",\n "security": "reality",\n "realitySettings": { "show": false, "dest": "..." }\n },\n "sniffing": {\n "enabled": true,\n "destOverride": ["http", "tls"]\n }\n}', - errorResponse: '{\n "success": false,\n "msg": "Port 443 is already in use"\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/del/:id', - summary: 'Delete an inbound by ID. Also removes its associated client stats rows.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - }, - { - method: 'POST', - path: '/panel/api/inbounds/bulkDel', - summary: - 'Delete many inbounds in one call. Processes the list sequentially; failures are reported per id and the rest still proceed. Restarts xray at most once.', - body: '{\n "ids": [1, 2, 3]\n}', - response: - '{\n "success": true,\n "obj": {\n "deleted": 2,\n "skipped": [\n { "id": 3, "reason": "..." }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/update/:id', - summary: - 'Replace an inbound’s configuration. Body shape mirrors /add. Heavy on inbounds with thousands of clients — prefer /setEnable for enable-only flips.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - }, - { - method: 'POST', - path: '/panel/api/inbounds/setEnable/:id', - summary: - 'Toggle only the enable flag without serialising the whole settings JSON. Recommended for UI switches on large inbounds.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - body: '{\n "enable": false\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/:id/subSortIndex', - summary: - 'Set only the subscription sort order. Reads the stored inbound, so a reorder cannot carry a stale client list over a concurrent edit.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - body: '{\n "subSortIndex": 2\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/:id/resetTraffic', - summary: - 'Zero out upload + download counters for a single inbound. Does not touch per-client counters.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - }, - { - method: 'POST', - path: '/panel/api/inbounds/:id/delAllClients', - summary: - 'Remove every client attached to a single inbound while keeping the inbound itself. Collects emails from settings.clients[] and feeds them into the optimized bulk-delete path (runtime user removal + traffic-row cleanup + SyncInbound). Destructive and cannot be undone.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }], - response: '{\n "success": true,\n "obj": {\n "deleted": 12\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/resetAllTraffics', - summary: - 'Reset upload + download counters on every inbound. Destructive — accounting history is lost.', - }, - { - method: 'POST', - path: '/panel/api/inbounds/import', - summary: - 'Bulk-import an inbound from a JSON blob (e.g. one exported via the UI). The body uses form encoding with a single "data" field.', - params: [ - { - name: 'data', - in: 'body (form)', - type: 'string', - desc: 'JSON-encoded inbound payload.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/inbounds/pushClientTraffics', - summary: - "Receive a master panel's aggregated per-client usage, keyed by the master's GUID. Stored in a side table used only for the UI display overlay and local quota enforcement — never folded into the local counters that masters poll, so delta accounting stays intact. Called panel-to-panel by the node traffic sync job.", - params: [ - { - name: 'masterGuid', - in: 'body (json)', - type: 'string', - desc: 'Stable GUID of the pushing master panel.', - }, - { - name: 'traffics', - in: 'body (json)', - type: 'object[]', - desc: 'Client traffic rows; only email/up/down are read.', - }, - ], - body: '{\n "masterGuid": "9f6c2d-…",\n "traffics": [\n { "email": "alice", "up": 1048576, "down": 2097152 }\n ]\n}', - response: '{\n "success": true\n}', - }, - { - method: 'GET', - path: '/panel/api/inbounds/:id/fallbacks', - summary: - "List the fallback rules attached to a master VLESS/Trojan TCP-TLS inbound. Each rule links one child inbound (the dest) to optional SNI/ALPN/path/dest/xver match criteria. When dest is empty the child inbound's listen+port is used.", - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Master inbound ID.' }], - response: - '{\n "success": true,\n "obj": [\n {\n "id": 1,\n "masterId": 10,\n "childId": 11,\n "name": "",\n "alpn": "",\n "path": "/vlws",\n "dest": "",\n "xver": 2,\n "sortOrder": 0\n }\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/inbounds/:id/fallbacks', - summary: - 'Replace the entire fallback list for a master inbound. Body is JSON. Triggers an Xray restart.', - params: [ - { name: 'id', in: 'path', type: 'number', desc: 'Master inbound ID.' }, - { - name: 'fallbacks', - in: 'body (json)', - type: 'object[]', - desc: 'Array of {childId, name, alpn, path, dest, xver, sortOrder} entries. Leave dest empty to auto-resolve from the child inbound\'s listen+port; set it (e.g. "8443", "127.0.0.1:8443", "/dev/shm/x.sock") to override.', - }, - ], - body: '{\n "fallbacks": [\n { "childId": 11, "path": "/vlws", "xver": 2 },\n { "childId": 12, "alpn": "h2", "dest": "8443" }\n ]\n}', - response: '{\n "success": true,\n "msg": "Inbound updated"\n}', - }, - ], - }, - - { - id: 'server', - title: 'Server', - description: - 'System status, log retrieval, certificate generators, Xray binary management, and backup/restore. All under /panel/api/server.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/openapi.json', - summary: - 'Serve this API description as an OpenAPI 3 document — the same file that powers the API Docs page. Requires a session or Bearer token like the rest of /panel/api. Useful for generating clients or importing into API tooling.', - }, - { - method: 'GET', - path: '/panel/api/server/status', - summary: - 'Real-time machine snapshot: CPU, memory, swap, disk, network IO, load averages, open connections, Xray state. Cached and refreshed every 2 seconds in the background.', - response: - '{\n "success": true,\n "obj": {\n "cpu": 12.5,\n "mem": { "current": 2147483648, "total": 8589934592 },\n "swap": { "current": 0, "total": 4294967296 },\n "disk": { "current": 53687091200, "total": 268435456000 },\n "netIO": { "up": 1073741824, "down": 2147483648 },\n "xray": { "state": "running", "version": "v25.10.31" },\n "tcpCount": 42,\n "load": { "load1": 0.5, "load5": 0.3, "load15": 0.2 }\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/fail2banStatus', - summary: - 'Reports whether per-client IP limits can be enforced on this host. The panel uses it to gate the "IP Limit" field, since enforcement depends on Fail2ban being installed.', - response: - '{\n "success": true,\n "obj": {\n "enabled": true,\n "installed": true,\n "usable": true,\n "windows": false\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/cpuHistory/:bucket', - summary: - 'Legacy: aggregated CPU history. Use /history/cpu/:bucket instead — same data with a uniform {t, v} shape.', - params: [ - { - name: 'bucket', - in: 'path', - type: 'number', - desc: 'Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.', - }, - ], - }, - { - method: 'GET', - path: '/panel/api/server/history/:metric/:bucket', - summary: - 'Aggregated time-series for one metric. Returns an array of {t, v} samples covering the last ~6 hours.', - params: [ - { - name: 'metric', - in: 'path', - type: 'string', - desc: 'cpu | mem | netUp | netDown | online | load1 | load5 | load15.', - }, - { - name: 'bucket', - in: 'path', - type: 'number', - desc: 'Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.', - }, - ], - response: - '{\n "success": true,\n "obj": [\n { "t": 1700000000, "v": 12.5 },\n { "t": 1700000002, "v": 13.1 }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/server/xrayMetricsState', - summary: - 'Xray runtime metrics state — whether the xray config has a `metrics` block, which expvar keys are flowing, and the current snapshot values for each. Returns an empty state when metrics are not configured.', - }, - { - method: 'GET', - path: '/panel/api/server/xrayMetricsHistory/:metric/:bucket', - summary: - 'Time-series history for one Xray runtime metric over the last ~6 hours. Same {t, v} shape as /history/:metric/:bucket.', - params: [ - { - name: 'metric', - in: 'path', - type: 'string', - desc: 'xrAlloc | xrSys | xrHeapObjects | xrNumGC | xrPauseNs.', - }, - { - name: 'bucket', - in: 'path', - type: 'number', - desc: 'Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.', - }, - ], - }, - { - method: 'GET', - path: '/panel/api/server/xrayObservatory', - summary: - 'Latest snapshot from the Xray observatory — per-outbound latency, health status, and last-probe time. Only populated when the Xray config has an observatory configured.', - }, - { - method: 'GET', - path: '/panel/api/server/xrayObservatoryHistory/:tag/:bucket', - summary: - 'Time-series of observatory probe results for one outbound tag. Same {t, v} shape as the other history endpoints.', - params: [ - { - name: 'tag', - in: 'path', - type: 'string', - desc: 'Outbound tag from the observatory config.', - }, - { - name: 'bucket', - in: 'path', - type: 'number', - desc: 'Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.', - }, - ], - }, - { - method: 'GET', - path: '/panel/api/server/getPanelUpdateInfo', - summary: 'Check whether a newer 3x-ui release is available on GitHub.', - }, - { - method: 'GET', - path: '/panel/api/server/getUpdateStatus', - summary: - 'Report the outcome of the most recently launched panel self-update (see POST updatePanel). Compare the returned runId against the one updatePanel returned to tell this run apart from a stale result.', - responseSchema: 'PanelUpdateStatus', - }, - { - method: 'GET', - path: '/panel/api/server/getConfigJson', - summary: 'Return the assembled Xray config that\u2019s currently running on this host.', - response: - '{\n "success": true,\n "obj": {\n "log": { "loglevel": "warning" },\n "inbounds": [...],\n "outbounds": [...],\n "routing": { "rules": [...] }\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getDb', - summary: - 'Stream a full database backup as an attachment: the SQLite .db file on SQLite panels, or a pg_dump custom-format archive (.dump) on PostgreSQL panels. Use as a manual backup.', - }, - { - method: 'GET', - path: '/panel/api/server/getMigration', - summary: - 'Stream a cross-engine migration file as an attachment: a .dump (SQL text) on SQLite, or a .db SQLite database built from the live data on PostgreSQL.', - }, - { - method: 'GET', - path: '/panel/api/server/getNewUUID', - summary: 'Generate a fresh UUID v4. Convenience helper for client IDs.', - response: '{\n "success": true,\n "obj": "550e8400-e29b-41d4-a716-446655440000"\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getWebCertFiles', - summary: - 'Return this panel\'s own web TLS certificate and key file paths. The central panel calls it on a node (via the node API token) so "Set Cert from Panel" fills a node-assigned inbound with paths that exist on the node.', - response: - '{\n "success": true,\n "obj": {\n "webCertFile": "/root/cert/example.com/fullchain.pem",\n "webKeyFile": "/root/cert/example.com/privkey.pem"\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/descendants', - summary: - 'Read-only summaries (guid, parentGuid, name, address, status, versions) of the nodes this panel manages. A parent panel calls it on a node (via the node API token) to surface transitive sub-nodes in a chained topology. Counts are computed by the parent, not returned here.', - response: - '{\n "success": true,\n "obj": [\n {\n "guid": "c3d4-...",\n "parentGuid": "a1b2-...",\n "name": "Node3",\n "address": "10.0.0.3",\n "status": "online"\n }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getNewX25519Cert', - summary: 'Generate a new X25519 keypair for Reality.', - response: - '{\n "success": true,\n "obj": {\n "privateKey": "uN9qLfV3zH8w...",\n "publicKey": "5v8xPqR2sM7k..."\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getNewmldsa65', - summary: - 'Generate a new ML-DSA-65 keypair (post-quantum signature). Returns {privateKey, publicKey, seed}.', - response: - '{\n "success": true,\n "obj": {\n "privateKey": "mdsa65priv...",\n "publicKey": "mdsa65pub...",\n "seed": "random-seed..."\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getNewmlkem768', - summary: - 'Generate a new ML-KEM-768 keypair (post-quantum KEM). Returns {clientKey, serverKey}.', - response: - '{\n "success": true,\n "obj": {\n "clientKey": "mlkem768-client...",\n "serverKey": "mlkem768-server..."\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/server/getNewVlessEnc', - summary: - 'Generate VLESS encryption auth options. Returns an auths array each with id, label, encryption, and decryption fields.', - response: - '{\n "success": true,\n "obj": {\n "auths": [\n { "id": 0, "label": "Auth #0", "encryption": "aes-256-gcm", "decryption": "" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/server/stopXrayService', - summary: 'Stop the Xray binary. All proxies go offline immediately.', - errorResponse: '{\n "success": false,\n "msg": "Xray is not running"\n}', - }, - { - method: 'POST', - path: '/panel/api/server/restartXrayService', - summary: - 'Reload Xray with the current config. Typically required after structural inbound or routing changes.', - errorResponse: '{\n "success": false,\n "msg": "Xray config is invalid: ..."\n}', - }, - { - method: 'POST', - path: '/panel/api/server/updatePanel', - summary: 'Self-update the panel to the latest version. The server restarts on success.', - response: '{\n "success": true,\n "obj": {\n "runId": "1735689600123456789"\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/server/setUpdateChannel', - summary: - 'Toggle the panel update channel between stable and the rolling per-commit dev release. Only effective on dev builds.', - params: [ - { - name: 'dev', - in: 'body (form)', - type: 'boolean', - desc: 'true = dev channel, false = stable.', - }, - ], - body: 'dev=true', - }, - { - method: 'POST', - path: '/panel/api/server/logs/:count', - summary: 'Return the last N lines of the panel\u2019s own log.', - params: [ - { name: 'count', in: 'path', type: 'number', desc: 'Number of trailing log lines.' }, - ], - body: '{\n "level": "info",\n "syslog": false\n}', - response: - '{\n "success": true,\n "obj": "2025/01/01 12:00:00 [INFO] Server started\\n2025/01/01 12:00:01 [INFO] Xray is running"\n}', - }, - { - method: 'POST', - path: '/panel/api/server/xraylogs/:count', - summary: 'Return the last N lines of the Xray process log.', - params: [ - { name: 'count', in: 'path', type: 'number', desc: 'Number of trailing log lines.' }, - { - name: 'filter', - in: 'body (form)', - type: 'string', - desc: 'Keyword filter — only lines containing this string.', - }, - { - name: 'showDirect', - in: 'body (form)', - type: 'string', - desc: '"true" to include direct (freedom) traffic lines.', - }, - { - name: 'showBlocked', - in: 'body (form)', - type: 'string', - desc: '"true" to include blocked (blackhole) traffic lines.', - }, - { - name: 'showProxy', - in: 'body (form)', - type: 'string', - desc: '"true" to include proxy traffic lines.', - }, - ], - body: 'filter=error&showDirect=false&showBlocked=true&showProxy=true', - response: - '{\n "success": true,\n "obj": "2025/01/01 12:00:00 rejected vless proxy example.com reason: no valid user\\n2025/01/01 12:00:01 direct freedom ok"\n}', - }, - { - method: 'POST', - path: '/panel/api/server/amneziawglogs/:count', - summary: - 'Return live AmneziaWG peer activity (handshake, endpoint, transfer) plus the panel’s own AmneziaWG event lines.', - params: [ - { - name: 'count', - in: 'path', - type: 'number', - desc: 'Maximum peer rows and event lines to return.', - }, - { - name: 'filter', - in: 'body (form)', - type: 'string', - desc: 'Keyword filter — only rows/lines containing this string.', - }, - ], - body: 'filter=awg1', - responseSchema: 'AmneziaWGLogs', - }, - { - method: 'POST', - path: '/panel/api/server/importDB', - summary: - 'Restore the panel DB from an uploaded backup (multipart form, field name "db"). SQLite panels accept a SQLite database (.db) or a SQLite migration dump (.dump); PostgreSQL panels accept a pg_dump archive (.dump), a SQLite database (.db), or a SQLite migration dump. The panel restarts after restore. Destructive.', - params: [ - { - name: 'db', - in: 'body (multipart)', - type: 'file', - desc: 'Database backup or migration file to upload.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/server/getNewEchCert', - summary: - 'Generate a new ECH (Encrypted Client Hello) keypair and config list for the given SNI.', - params: [ - { - name: 'sni', - in: 'body (form)', - type: 'string', - desc: 'Server Name Indication to generate the ECH config for.', - }, - ], - body: 'sni=example.com', - response: - '{\n "success": true,\n "obj": {\n "echKeySet": "...",\n "echServerKeys": [...],\n "echConfigList": "..."\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/server/getCertHash', - summary: - 'Compute the hex SHA-256 of a certificate (DER) for pinning (pinnedPeerCertSha256). Provide either a server file path or inline PEM/DER content.', - params: [ - { - name: 'certFile', - in: 'body (form)', - type: 'string', - desc: 'Path to a certificate file on the server. Takes precedence over certContent.', - }, - { - name: 'certContent', - in: 'body (form)', - type: 'string', - desc: 'Inline PEM (or DER) certificate content, used when certFile is empty.', - }, - ], - body: 'certFile=/root/cert.crt', - response: '{\n "success": true,\n "obj": [\n "e8e2d3..."\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/server/getRemoteCertHash', - summary: - 'Run `xray tls ping` against a remote server and return its live leaf-certificate SHA-256 hash(es) for pinning (pinnedPeerCertSha256).', - params: [ - { - name: 'server', - in: 'body (form)', - type: 'string', - desc: 'Remote server as domain or domain:port (default port 443), e.g. cloudflare-dns.com.', - }, - ], - body: 'server=cloudflare-dns.com', - response: '{\n "success": true,\n "obj": [\n "e8e2d3..."\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/server/scanRealityTarget', - summary: - 'Run a live TLS 1.3 probe against a candidate REALITY target and return a feasibility verdict (TLS 1.3 + h2 + X25519 + trusted certificate) plus the certificate SAN DNS names. A target on a private/loopback address is reported with privateTarget=true and probed only when allowPrivate is set.', - params: [ - { - name: 'target', - in: 'body (form)', - type: 'string', - desc: 'Candidate target as host or host:port (default port 443), e.g. www.cloudflare.com:443.', - }, - { - name: 'sni', - in: 'body (form)', - type: 'string', - optional: true, - desc: 'SNI the handshake sends and the certificate is verified against (the inbound serverNames). Defaults to the target host, which a fronting proxy answers with its default certificate.', - }, - { - name: 'xver', - in: 'body (form)', - type: 'number', - optional: true, - desc: 'PROXY protocol version the target expects (matches the inbound xver). 0 = none.', - }, - { - name: 'allowPrivate', - in: 'body (form)', - type: 'boolean', - optional: true, - desc: 'Probe a private/internal/loopback target (LAN, Docker service name). Default false (SSRF guard blocks it and the response sets privateTarget=true).', - }, - ], - body: 'target=www.cloudflare.com:443', - responseSchema: 'RealityScanResult', - }, - { - method: 'POST', - path: '/panel/api/server/scanRealityTargets', - summary: - 'Probe/discover REALITY targets and return each verdict ranked by feasibility then latency. Each comma-separated token may be a domain (validated with SNI), a bare IP, or a CIDR range (discovered without SNI by reading the certificate domain). When empty, a built-in seed list is probed.', - params: [ - { - name: 'targets', - in: 'body (form)', - type: 'string', - optional: true, - desc: 'Optional comma-separated tokens: domain[:port], IP[:port], or CIDR (e.g. 104.16.0.0/24). When omitted, a built-in seed list is probed.', - }, - ], - body: 'targets=104.16.0.0/24,www.apple.com:443', - responseSchema: 'RealityScanResult', - responseSchemaArray: true, - }, - { - method: 'GET', - path: '/panel/api/server/clientIps', - summary: - 'Fetch the fully aggregated inbound_client_ips database table. Used by nodes to sync recently active IPs across the cluster.', - responseSchema: 'InboundClientIps', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/server/clientIps', - summary: - 'Submit a list of recently active IP timestamps. The panel merges them with the existing database to maintain a unified global IP-limit view.', - params: [ - { - name: 'ips', - in: 'body (json)', - type: 'object[]', - desc: 'Array of InboundClientIps to merge.', - }, - ], - }, - ], - }, - - { - id: 'clients', - title: 'Clients', - description: - 'Manage clients as first-class entities that can be attached to one or more inbounds. A single client row drives the settings.clients entry in every inbound it belongs to. Endpoints live under /panel/api/clients.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/clients/list', - summary: - 'List every client with its attached inbound IDs and traffic record. The reverse field, if set, is returned as a nested JSON object (legacy JSON-encoded-string form is still accepted on write).', - response: - '{\n "success": true,\n "obj": [\n {\n "id": 1,\n "email": "alice@example.com",\n "subId": "abcd1234",\n "uuid": "...",\n "totalGB": 53687091200,\n "expiryTime": 1735689600000,\n "enable": true,\n "reverse": null,\n "inboundIds": [3, 5],\n "traffic": { "up": 1024, "down": 4096, "enable": true }\n }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/list/paged', - summary: - 'Filter, sort, and paginate clients on the server. Each item is a slim row (no uuid/password/auth/flow/security/reverse/tgId) so the clients page can ship 25-ish rows in a few KB instead of the full table. The response also includes a summary computed across the full DB row set so dashboard counters stay stable as the user paginates or filters: the *Count fields are exact, while the email arrays beside them stop at 200 entries so the payload does not grow with the panel. Page size capped at 200; fetch /get/:email to obtain the full per-client payload for an edit/info modal.', - params: [ - { - name: 'page', - in: 'query', - type: 'number', - desc: '1-indexed page number. Defaults to 1.', - }, - { - name: 'pageSize', - in: 'query', - type: 'number', - desc: 'Rows per page. Defaults to 25, capped at 200.', - }, - { - name: 'search', - in: 'query', - type: 'string', - desc: 'Case-insensitive substring match on email / subId / comment.', - }, - { - name: 'filter', - in: 'query', - type: 'string', - desc: 'Status bucket: online | active | deactive | depleted | expiring.', - }, - { - name: 'protocol', - in: 'query', - type: 'string', - desc: 'Match clients attached to at least one inbound of this protocol (vless, vmess, trojan, shadowsocks, ...).', - }, - { - name: 'sort', - in: 'query', - type: 'string', - desc: 'Sort key: enable | email | inboundIds | traffic | remaining | expiryTime.', - }, - { name: 'order', in: 'query', type: 'string', desc: 'ascend or descend.' }, - ], - response: - '{\n "success": true,\n "obj": {\n "items": [\n {\n "email": "alice@example.com",\n "subId": "abcd1234",\n "enable": true,\n "totalGB": 53687091200,\n "expiryTime": 1735689600000,\n "limitIp": 0,\n "limitHwid": 0,\n "reset": 0,\n "inboundIds": [3, 5],\n "traffic": { "up": 1024, "down": 4096, "enable": true },\n "createdAt": 1735000000000,\n "updatedAt": 1735100000000\n }\n ],\n "total": 2000,\n "filtered": 47,\n "page": 1,\n "pageSize": 25,\n "summary": {\n "total": 2000,\n "active": 1850,\n "onlineCount": 1,\n "depletedCount": 0,\n "expiringCount": 0,\n "deactiveCount": 150,\n "online": ["alice@example.com"],\n "depleted": [],\n "expiring": [],\n "deactive": ["bob@example.com"]\n }\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/get/:email', - summary: - 'Fetch one client by email, including the inbound IDs and external config IDs it is attached to.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - ], - response: - '{\n "success": true,\n "obj": {\n "client": { "id": 1, "email": "alice@example.com", ... },\n "inboundIds": [3, 5],\n "externalLinks": [\n { "id": 11, "kind": "link", "value": "vless://...", "remark": "DE", "enable": true, "expiryTime": 0 },\n { "id": 12, "kind": "subscription", "value": "https://provider.example/sub/abc", "remark": "Provider", "enable": false, "expiryTime": 1767225600000, "namePrefix": "[zjh] ", "lastFetchAt": 1767220000000, "lastFetchError": "" }\n ]\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/get/tgId/:tgId', - summary: - 'Fetch clients by Telegram user ID. Returns an array since multiple clients can share the same Telegram ID.', - params: [ - { name: 'tgId', in: 'path', type: 'integer', desc: 'Telegram user ID (numeric).' }, - ], - response: - '{\n "success": true,\n "obj": [\n {\n "client": { "id": 1, "email": "alice@example.com", ... },\n "inboundIds": [3, 5],\n "externalLinks": [],\n "usedTraffic": 1048576\n }\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/add', - summary: - 'Create a new client and attach it to one or more inbounds in a single call. Body is JSON. Per-protocol secrets are generated server-side when omitted, so callers can send only the universal fields.', - description: - 'Fields the server fills in when they are omitted — a valid value sent by the caller is never overwritten. Re-adding an email that already exists, with its stored `subId`, reuses the stored `id`, `password`, `auth` and `secret` instead of minting new ones, so the identity stays in sync across its inbounds.\n\n- **VLESS / VMess** — `id`, a fresh UUID\n- **Trojan** — `password`\n- **Shadowsocks** — `password`. On a `2022-blake3-*` inbound a supplied password that does not base64-decode to the key length of the cipher (16 or 32 bytes) is replaced by a generated key and the call still succeeds, so read the client back if you did not let the server pick. Legacy ciphers keep any non-empty password\n- **Hysteria** — `auth`\n- **mtproto** — `secret`, a FakeTLS secret derived from the fronting domain of the inbound, or from `www.cloudflare.com` when it has none\n- **WireGuard** — `privateKey` and `publicKey` when both are blank, or `publicKey` alone when only a `privateKey` was sent, plus `allowedIPs`: one free `/32` taken from the /24 the existing peers of that inbound already sit in, or from `10.0.0.0/24` when it has none\n\nAccepted on the same body but never generated: `preSharedKey` and `keepAlive` (WireGuard), `adTag` (mtproto).\n\nWireGuard is the only one of these that can fail. Allocation widens the search to the containing /16 before giving up with `wireguard: no free address available in `, and an `allowedIPs` supplied by the caller is validated instead of allocated: `wireguard: allowedIPs entry already used by another client:
` when a different client of that same inbound already holds it. The check is per inbound, so the same address on two different inbounds is accepted. The same validation runs on POST /panel/api/clients/{email}/attach, where a client that already carries an address brings it along.', - params: [ - { - name: 'client', - in: 'body (json)', - type: 'object', - desc: 'Client fields: email, subId, id (uuid), password, auth, flow, totalGB, expiryTime, limitIp, limitHwid, tgId (numeric Telegram user ID, 0 = none), comment, enable. Protocol-specific: secret and adTag (mtproto), privateKey, publicKey, preSharedKey, allowedIPs and keepAlive (WireGuard).', - }, - { - name: 'inboundIds', - in: 'body (json)', - type: 'integer[]', - desc: 'Inbound IDs to attach the client to. At least one required.', - }, - ], - body: '{\n "client": {\n "email": "alice@example.com",\n "totalGB": 53687091200,\n "expiryTime": 1735689600000,\n "tgId": 0,\n "limitIp": 0,\n "limitHwid": 0,\n "enable": true\n },\n "inboundIds": [3, 5]\n}', - response: '{\n "success": true,\n "msg": "Client added"\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/update/:email', - summary: - 'Update an existing client by email. Changes propagate to every attached inbound. Body is the JSON client payload — supply the full set of fields you want to keep (the server replaces the row, it does not patch).', - params: [ - { - name: 'email', - in: 'path', - type: 'string', - desc: 'Current client email (unique identifier).', - }, - ], - body: '{\n "email": "alice@example.com",\n "totalGB": 107374182400,\n "expiryTime": 1767225600000,\n "limitHwid": 2,\n "tgId": 123456789,\n "enable": true\n}', - response: '{\n "success": true,\n "msg": "Client updated"\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/del/:email', - summary: - 'Delete a client by email. Removes it from every attached inbound and drops its traffic record unless keepTraffic=1 is passed.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - { - name: 'keepTraffic', - in: 'query', - type: 'integer', - desc: 'Pass 1 to retain the xray_client_traffic row after deletion.', - }, - ], - response: '{\n "success": true,\n "msg": "Client deleted"\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/:email/attach', - summary: 'Attach an existing client to one or more additional inbounds. Body is JSON.', - description: - 'A WireGuard client brings its stored `allowedIPs` into the new inbound instead of being given a fresh address, so the call fails with `wireguard: allowedIPs entry already used by another client:
` when a different client of the target inbound already holds it. Free the address on that inbound first — see POST /panel/api/clients/add for the full rule.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - { - name: 'inboundIds', - in: 'body (json)', - type: 'integer[]', - desc: 'Inbound IDs to attach.', - }, - ], - body: '{\n "inboundIds": [7, 9]\n}', - response: '{\n "success": true\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/:email/detach', - summary: 'Detach a client from one or more inbounds without deleting the client.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - { - name: 'inboundIds', - in: 'body (json)', - type: 'integer[]', - desc: 'Inbound IDs to detach.', - }, - ], - body: '{\n "inboundIds": [5]\n}', - response: '{\n "success": true\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/:email/externalLinks', - summary: - "Replace a client's external links and external subscriptions. Sends the full set; the server replaces all rows. Disabled rows stay saved for editing but are not emitted in generated subscriptions.", - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - { - name: 'externalLinks', - in: 'body', - type: 'object[]', - desc: 'Full replacement list; the server replaces all rows. Each row supports { kind, value, remark, enable, expiryTime, namePrefix }. kind=link: value must be a supported share link such as vless://, vmess://, trojan://, ss://, hysteria2://, or wireguard://, and remark overrides the exported node name. kind=subscription: value must be an http(s) subscription URL, and namePrefix is prepended to fetched node names. Omit enable to default true; enable=false or an expired expiryTime keeps the row saved but excludes it from generated subscriptions. expiryTime is a unix millisecond timestamp where 0 means never expire; a negative value is rejected. Rows are matched by kind+value across saves, so id is ignored on write. lastFetchAt and lastFetchError are read-only status fields returned by GET.', - }, - ], - body: '{\n "externalLinks": [\n { "kind": "link", "value": "vless://uuid@host:443?...#srv", "remark": "DE", "enable": true, "expiryTime": 0 },\n { "kind": "subscription", "value": "https://provider.example/sub/abc", "remark": "Provider", "enable": false, "expiryTime": 1767225600000, "namePrefix": "[zjh] " }\n ]\n}', - response: '{\n "success": true\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/resetAllTraffics', - summary: - 'Reset the up/down counters for every client globally. Quotas and expiry are not affected. Triggers an Xray restart if any counter actually moved.', - response: '{\n "success": true\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/delDepleted', - summary: - 'Delete every client whose traffic quota is exhausted (used >= total, when reset is disabled) or whose expiry has passed. Returns the deleted count and triggers an Xray restart when any client was on a running inbound.', - response: '{\n "success": true,\n "obj": {\n "deleted": 0\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/delOrphans', - summary: - 'Delete every client that is not attached to any inbound, along with its traffic record, IP log, HWID devices, and external links. Useful for clearing clients left unattached after their inbounds were removed. Returns the deleted count. Cannot be undone.', - response: '{\n "success": true,\n "obj": {\n "deleted": 0\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/export', - summary: - 'Return every client as a {client, inboundIds} array — the same shape /bulkCreate and /import accept — so the payload round-trips straight back through /import. Clients with no inbound attachment are included with an empty inboundIds list. The UI shows this in a CodeMirror viewer (copy / download); programmatic callers get the array in obj.', - response: - '{\n "success": true,\n "obj": [\n {\n "client": {\n "email": "alice@example.com",\n "id": "...",\n "totalGB": 53687091200,\n "expiryTime": 0,\n "limitHwid": 2,\n "enable": true,\n "subId": "..."\n },\n "inboundIds": [7, 9]\n }\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/import', - summary: - 'Import clients from a JSON body { "data": "" }, where data is a string-encoded array produced by /export ([{client, inboundIds}]). Items with inboundIds are created and attached to those inbounds; items with an empty inboundIds list are restored as unattached client records. Existing emails are never overwritten — they are returned in skipped. Triggers a single Xray restart at the end if any target inbound was running.', - body: '{\n "data": "[{\\"client\\":{\\"email\\":\\"alice@example.com\\",\\"enable\\":true},\\"inboundIds\\":[7]}]"\n}', - response: - '{\n "success": true,\n "obj": {\n "created": 2,\n "skipped": [\n { "email": "alice@example.com", "reason": "email already in use: alice@example.com" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkAdjust', - summary: - 'Shift expiry and/or traffic quota for many clients in one call. addDays/addBytes may be negative. Clients with unlimited expiry (expiryTime=0) or unlimited traffic (totalGB=0) are skipped for the corresponding field — bulk extend never converts unlimited to limited. A client that was auto-disabled solely because it was depleted (expired or over quota) is automatically re-enabled — locally and on its node — when the adjustment lifts it out of depletion; a manually-disabled or still-depleted client is left disabled. The optional flow directive sets the XTLS flow on every client: "none" clears it, "xtls-rprx-vision"/"xtls-rprx-vision-udp443" set it where the inbound supports it (omit or "" to leave it unchanged). Returns the adjusted count and per-email skip reasons.', - body: '{\n "emails": ["alice", "bob"],\n "addDays": 30,\n "addBytes": 53687091200,\n "flow": "xtls-rprx-vision"\n}', - response: - '{\n "success": true,\n "obj": {\n "adjusted": 2,\n "skipped": [\n { "email": "carol", "reason": "unlimited expiry" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkEnable', - summary: - 'Enable many clients in one call. Emails are grouped by inbound and applied with a single read-modify-write per inbound; the running Xray (local or remote node) is updated to add each user. Note that enabling a client whose quota is exhausted or whose expiry has passed only flips the flag — the traffic loop will disable it again on the next tick. Returns the changed count and per-email skip reasons.', - body: '{\n "emails": ["alice", "bob"]\n}', - response: - '{\n "success": true,\n "obj": {\n "changed": 2,\n "skipped": [\n { "email": "carol", "reason": "client not found" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkDisable', - summary: - 'Disable many clients in one call. Emails are grouped by inbound and applied with a single read-modify-write per inbound; the running Xray (local or remote node) is updated to remove each user. Returns the changed count and per-email skip reasons.', - body: '{\n "emails": ["alice", "bob"]\n}', - response: - '{\n "success": true,\n "obj": {\n "changed": 2,\n "skipped": [\n { "email": "carol", "reason": "client not found" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkDel', - summary: - 'Delete many clients in one call. The server processes the list sequentially so each delete sees the committed state of the previous one — avoids the race the per-email fan-out had on the panel side. Pass keepTraffic=true to retain the xray_client_traffic rows after deletion.', - body: '{\n "emails": ["alice", "bob"],\n "keepTraffic": false\n}', - response: - '{\n "success": true,\n "obj": {\n "deleted": 2,\n "skipped": [\n { "email": "carol", "reason": "client not found" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkCreate', - summary: - 'Create many clients in one call. Body is a JSON array of {client, inboundIds} payloads — the same shape /add accepts. Items are processed sequentially; per-email skip reasons are returned for items that fail (e.g., duplicate email). Triggers a single Xray restart at the end if any inbound was running.', - body: '[\n {\n "client": {\n "email": "alice@example.com",\n "totalGB": 53687091200,\n "expiryTime": 0,\n "limitHwid": 2,\n "enable": true\n },\n "inboundIds": [7]\n },\n {\n "client": {\n "email": "bob@example.com",\n "totalGB": 53687091200,\n "expiryTime": 0,\n "limitHwid": 0,\n "enable": true\n },\n "inboundIds": [7, 9]\n }\n]', - response: - '{\n "success": true,\n "obj": {\n "created": 2,\n "skipped": [\n { "email": "alice@example.com", "reason": "email already in use" }\n ]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/bulkAdd', - summary: - "Add many clients to a group in one call. Updates clients.group_name and patches the matching client entry inside every owning inbound's settings JSON in a single transaction. If the group name does not yet exist (in client_groups or as a derived label), it is auto-created as a persistent group. To clear the group label, use /groups/bulkRemove instead.", - body: '{\n "emails": ["alice", "bob"],\n "group": "customer-a"\n}', - response: '{\n "success": true,\n "obj": {\n "affected": 2\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/bulkRemove', - summary: - "Clear the group label on many clients in one call. Inverse of /groups/bulkAdd. Clients themselves are kept — only the group label is cleared from clients.group_name and from each owning inbound's settings JSON. Groups become empty if all their members are removed.", - body: '{\n "emails": ["alice", "bob"]\n}', - response: '{\n "success": true,\n "obj": {\n "affected": 2\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkAttach', - summary: - 'Attach many existing clients to many inbounds in one call. Each client keeps its identity (email/UUID/password/subId) and a shared traffic row; all clients are added to a target inbound in a single AddInboundClient call. Clients already present on a target are reported under skipped. Returns per-email attached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.', - params: [ - { - name: 'emails', - in: 'body (json)', - type: 'array', - desc: 'Emails of existing clients to attach.', - }, - { - name: 'inboundIds', - in: 'body (json)', - type: 'integer[]', - desc: 'Target inbound IDs to attach every client to.', - }, - ], - body: '{\n "emails": ["alice", "bob"],\n "inboundIds": [7, 9]\n}', - response: - '{\n "success": true,\n "obj": {\n "attached": ["alice", "bob"],\n "skipped": ["bob"],\n "errors": []\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkDetach', - summary: - "Mirror of bulkAttach: detach many existing clients from many inbounds in one call. For each email, intersects the client's current inbounds with the requested set and detaches from those only; (email, inbound) pairs where the client is not currently attached are silently no-ops. Emails not attached to any of the requested inbounds are reported under skipped. Client records are kept even if they become orphaned — use bulkDel for full removal. Returns per-email detached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.", - params: [ - { - name: 'emails', - in: 'body (json)', - type: 'array', - desc: 'Emails of existing clients to detach.', - }, - { - name: 'inboundIds', - in: 'body (json)', - type: 'integer[]', - desc: 'Inbound IDs to detach the clients from.', - }, - ], - body: '{\n "emails": ["alice", "bob"],\n "inboundIds": [7, 9]\n}', - response: - '{\n "success": true,\n "obj": {\n "detached": ["alice", "bob"],\n "skipped": [],\n "errors": []\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/bulkResetTraffic', - summary: - 'Zero up/down counters for many clients in one call. Loops the single-reset path so each client is re-enabled across its attached inbounds and pushed to Xray/remote nodes. Returns the count of successfully reset clients.', - body: '{\n "emails": ["alice", "bob"]\n}', - response: '{\n "success": true,\n "obj": {\n "affected": 2\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/groups', - summary: - 'List all client groups with their member counts. Merges persisted groups (rows in client_groups, including empty placeholders) with the distinct group_name values currently set on clients. Sorted alphabetically (case-insensitive).', - response: - '{\n "success": true,\n "obj": [\n { "name": "customer-a", "clientCount": 5 },\n { "name": "internal", "clientCount": 0 }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/groups/:name/emails', - summary: - 'Return just the email list of clients that currently belong to the given group. Useful for fanning a single bulk action over an entire group without round-tripping the full client list.', - params: [{ name: 'name', in: 'path', type: 'string', desc: 'Group name (URL-encoded).' }], - response: '{\n "success": true,\n "obj": ["alice", "bob", "carol"]\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/create', - summary: - 'Create a new empty (placeholder) group. The group becomes selectable in client forms and the filter drawer even before any client is added to it. Errors if a group with the same name already exists.', - body: '{\n "name": "customer-a"\n}', - response: '{\n "success": true,\n "obj": {\n "name": "customer-a"\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/rename', - summary: - "Rename a group. The new name is applied to the client_groups row AND propagated to every matching client (both clients.group_name and the client entry inside every owning inbound's settings JSON) in a single transaction. Returns the number of clients whose label was updated.", - body: '{\n "oldName": "customer-a",\n "newName": "tier-1"\n}', - response: '{\n "success": true,\n "obj": {\n "affected": 5\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/delete', - summary: - 'Remove a group. Deletes the client_groups row and clears the group label from every matching client (both clients.group_name and the inbound settings JSON). The clients themselves are NOT deleted — use /bulkDel after filtering by group for that. Returns the count of clients whose label was cleared.', - body: '{\n "name": "customer-a"\n}', - response: '{\n "success": true,\n "obj": {\n "affected": 5\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/groups/resetTraffic', - summary: - "Reset only the group-level traffic counter shown on the groups page. Snapshots the current up/down sum of the group's members as a baseline so the group total reads zero, while leaving each client's own counters (and their quotas) untouched. No Xray restart is triggered. Creates the client_groups row if the group exists only as a derived label.", - body: '{\n "name": "customer-a"\n}', - response: '{\n "success": true,\n "obj": {\n "name": "customer-a"\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/resetTraffic/:email', - summary: - 'Zero out a single client’s up/down counters. Re-enables the client across every attached inbound and pushes the change to Xray (or the remote node) so depleted users can connect again immediately.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - }, - { - method: 'POST', - path: '/panel/api/clients/updateTraffic/:email', - summary: - 'Manually adjust a client’s upload + download counters. Useful for migrations from external accounting systems.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - body: '{\n "upload": 1073741824,\n "download": 5368709120\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/ips/:email', - summary: - 'List source IPs that have connected with the given client’s credentials. Returns an array of "ip (timestamp)" strings.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - }, - { - method: 'POST', - path: '/panel/api/clients/clearIps/:email', - summary: 'Reset the recorded IP list for a client.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - }, - { - method: 'POST', - path: '/panel/api/clients/hwids/:email', - summary: 'List registered HWID devices for a client. Hashes are not exposed.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - response: - '{\n "success": true,\n "obj": [\n {\n "id": 1,\n "firstSeen": 1735000000000,\n "lastSeen": 1735100000000,\n "userAgent": "Happ/1.0",\n "deviceOs": "android",\n "osVersion": "15",\n "deviceModel": "Pixel 9"\n }\n ]\n}', - }, - { - method: 'DELETE', - path: '/panel/api/clients/hwids/:email', - summary: - 'Clear all registered HWID devices for a client so new devices can register again.', - params: [{ name: 'email', in: 'path', type: 'string', desc: 'Client email.' }], - }, - { - method: 'DELETE', - path: '/panel/api/clients/hwids/:email/:id', - summary: - 'Remove a single registered HWID device by its id, freeing one slot under the HWID limit.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email.' }, - { name: 'id', in: 'path', type: 'number', desc: 'Device id, from the list endpoint.' }, - ], - }, - { - method: 'POST', - path: '/panel/api/clients/onlines', - summary: - 'List the emails of currently connected clients (last seen within the heartbeat window), deduped across every node.', - response: '{\n "success": true,\n "obj": ["user1", "user2"]\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/onlinesByGuid', - summary: - 'Online client emails grouped by the panelGuid of the node that physically hosts each client. The local panel uses its own GUID; each node (at any depth in a chain) uses its GUID. Lets the inbounds page attribute online status to the real node instead of the intermediate one it syncs through.', - response: - '{\n "success": true,\n "obj": {\n "a1b2-...": ["user1"],\n "c3d4-...": ["user1", "user2"]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/clientIpsByGuid', - summary: - 'Per-client source IPs grouped by the panelGuid of the node that observed them. Lets the central panel attribute and enforce per-client IP limits using the real visitor IPs each node sees, instead of the address of the intermediate panel it syncs through.', - response: - '{\n "success": true,\n "obj": {\n "a1b2-...": {\n "user1": [\n { "ip": "1.2.3.4", "timestamp": 1700000000 }\n ]\n }\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/activeInbounds', - summary: - "Inbound tags that carried traffic within the heartbeat window, grouped by the hosting node's panelGuid. Pairs with onlinesByGuid so the inbounds page only marks a multi-inbound client online on the inbounds it actually used. Nodes that do not report per-inbound activity are absent.", - response: - '{\n "success": true,\n "obj": {\n "a1b2-...": ["in-443-tcp", "in-8443-tcp"]\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/clients/lastOnline', - summary: 'Map of client email → last-seen unix timestamp.', - response: - '{\n "success": true,\n "obj": {\n "user1": 1700000000,\n "user2": 1699999000\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/traffic/:email', - summary: 'Traffic counters for a client identified by email.', - params: [ - { - name: 'email', - in: 'path', - type: 'string', - desc: 'Client email (unique across the panel).', - }, - ], - responseSchema: 'ClientTraffic', - }, - { - method: 'GET', - path: '/panel/api/clients/subLinks/:subId', - summary: - 'Return every protocol URL (vless://, vmess://, trojan://, ss://, hysteria://, hy2://) for clients matching the subscription ID. Same result set as /sub/, but as a JSON array — no base64. When an inbound has streamSettings.externalProxy set, one URL is emitted per external proxy. Empty array when the subId has no enabled clients.', - params: [ - { - name: 'subId', - in: 'path', - type: 'string', - desc: "Subscription ID, taken from the client's subId field.", - }, - ], - response: - '{\n "success": true,\n "obj": [\n "vless://uuid@host:443?security=reality&...#user1",\n "vmess://eyJ2IjoyLC..."\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/clients/links/:email', - summary: - 'Return every URL for one client across all attached inbounds — the same strings the Copy URL button copies in the panel UI. Supported protocols: vmess, vless, trojan, shadowsocks, hysteria. If streamSettings.externalProxy is set, returns one URL per external proxy. Protocols without a URL form (socks, http, mixed, wireguard, dokodemo, tunnel) contribute nothing.', - params: [ - { name: 'email', in: 'path', type: 'string', desc: 'Client email (unique identifier).' }, - ], - response: - '{\n "success": true,\n "obj": [\n "vless://uuid@host:443?...#user1"\n ]\n}', - }, - ], - }, - - { - id: 'nodes', - title: 'Nodes', - description: - 'Manage remote 3x-ui panels acting as nodes for a central panel. All endpoints under /panel/api/nodes.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/nodes/list', - summary: - 'List every configured node with its connection details, health, and last heartbeat patch.', - responseSchema: 'NodeView', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/nodes/mtls/ca', - summary: - "This panel's node-auth CA certificate (public, PEM) to paste into a node's mTLS trust setting. Lazily mints the CA and the master client cert on first call. Pair with setting tlsVerifyMode=mtls on the node.", - response: - '{\n "success": true,\n "obj": {\n "caCert": "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/mtls/trustCA', - summary: - "Set the CA certificate this panel trusts for incoming node-API client certificates (this panel acting as a node). Paste the managing panel's CA (from nodes/mtls/ca). An empty caCert disables it. A non-empty value must be a PEM certificate. Applied on the next panel restart.", - body: '{\n "caCert": "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/mtls/reloadClient', - summary: - 'Validate the stored master mTLS client credential and invalidate cached transports. Each transport closes its old idle pool and rebuilds with the rotated certificate before its next request.', - }, - { - method: 'GET', - path: '/panel/api/nodes/get/:id', - summary: 'Fetch a single node by ID.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - responseSchema: 'NodeView', - }, - { - method: 'GET', - path: '/panel/api/nodes/webCert/:id', - summary: - 'Fetch a node\'s own web TLS certificate/key file paths (proxied to the node). Used by the inbound form\'s "Set Cert from Panel" so a node-assigned inbound gets paths that exist on the node, not the central panel.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - response: - '{\n "success": true,\n "obj": {\n "webCertFile": "/root/cert/example.com/fullchain.pem",\n "webKeyFile": "/root/cert/example.com/privkey.pem"\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/add', - summary: - 'Register a new remote node. Provide its URL, write-only apiToken, and optional remark / allowPrivateAddress flag. Responses expose hasApiToken only.', - body: '{\n "name": "de-fra-1",\n "remark": "",\n "scheme": "https",\n "address": "node1.example.com",\n "port": 2053,\n "basePath": "/",\n "apiToken": "abcdef...",\n "clearApiToken": false,\n "enable": true,\n "allowPrivateAddress": false\n}', - responseSchema: 'NodeView', - }, - { - method: 'POST', - path: '/panel/api/nodes/update/:id', - summary: - 'Replace a node\u2019s connection details. apiToken is write-only: omit it or send an empty string to keep the stored token; set clearApiToken=true to clear it.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - body: '{\n "name": "de-fra-1",\n "remark": "",\n "scheme": "https",\n "address": "node1.example.com",\n "port": 2053,\n "basePath": "/",\n "apiToken": "",\n "clearApiToken": false,\n "enable": true,\n "allowPrivateAddress": false\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/del/:id', - summary: 'Delete a node. Inbounds bound to it are not auto-migrated.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - }, - { - method: 'POST', - path: '/panel/api/nodes/setEnable/:id', - summary: 'Pause or resume traffic sync with this node.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - body: '{\n "enable": true\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/test', - summary: - 'Probe a node without saving it. Uses the body as connection details and returns the same heartbeat snapshot a registered node would have.', - body: '{\n "scheme": "https",\n "address": "node1.example.com",\n "port": 2053,\n "basePath": "/",\n "apiToken": "abcdef..."\n}', - responseSchema: 'ProbeResultUI', - }, - { - method: 'POST', - path: '/panel/api/nodes/certFingerprint', - summary: - "Connect to the node over HTTPS without verifying its certificate and return the leaf certificate's SHA-256 (base64). Used by the Add/Edit Node dialog to fetch and pin a self-signed certificate. Uses the same body as /test.", - body: '{\n "scheme": "https",\n "address": "node1.example.com",\n "port": 2053,\n "basePath": "/"\n}', - response: '{\n "success": true,\n "obj": "k3b1...base64-sha256...="\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/inbounds', - summary: - 'Use unsaved node connection details to list the remote inbounds available for selective import.', - body: '{\n "name": "de-fra-1",\n "scheme": "https",\n "address": "node1.example.com",\n "port": 2053,\n "basePath": "/",\n "apiToken": "abcdef..."\n}', - response: - '{\n "success": true,\n "obj": [\n { "tag": "inbound-443", "remark": "VLESS", "protocol": "vless", "port": 443 }\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/nodes/probe/:id', - summary: 'Probe an existing node, updating its cached health state.', - params: [{ name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }], - }, - { - method: 'POST', - path: '/panel/api/nodes/updatePanel', - summary: - 'Trigger the official panel self-updater on each given node (downloads the latest release and restarts). Only enabled, online nodes are updated; offline/disabled ones are reported as skipped. Set "dev": true to move the nodes to the rolling per-commit dev channel instead of the latest stable release. Returns a per-node result list.', - body: '{\n "ids": [1, 2, 3],\n "dev": false\n}', - response: - '{\n "success": true,\n "obj": [\n { "id": 1, "name": "de-1", "ok": true },\n { "id": 2, "name": "fr-1", "ok": false, "error": "node is offline" }\n ]\n}', - }, - { - method: 'GET', - path: '/panel/api/nodes/history/:id/:metric/:bucket', - summary: - 'Aggregated metric history for a node — same shape as /server/history, scoped to one node.', - params: [ - { name: 'id', in: 'path', type: 'number', desc: 'Node ID.' }, - { name: 'metric', in: 'path', type: 'string', desc: 'cpu | mem.' }, - { - name: 'bucket', - in: 'path', - type: 'number', - desc: 'Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.', - }, - ], - }, - ], - }, - - { - id: 'hosts', - title: 'Hosts', - description: - 'Per-inbound override endpoints. Each enabled host renders one extra subscription link/proxy with its own address/port/TLS, superseding the legacy externalProxy array. All endpoints under /panel/api/hosts.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/hosts/list', - summary: - 'List every host across all inbounds, grouped by inbound then ordered by sort order.', - responseSchema: 'HostGroup', - responseSchemaArray: true, - }, - { - method: 'GET', - path: '/panel/api/hosts/get/:groupId', - summary: 'Fetch a single host group by Group ID.', - params: [{ name: 'groupId', in: 'path', type: 'string', desc: 'Host Group ID.' }], - responseSchema: 'HostGroup', - }, - { - method: 'GET', - path: '/panel/api/hosts/byInbound/:inboundId', - summary: "Fetch one inbound's hosts, grouped by host group.", - params: [{ name: 'inboundId', in: 'path', type: 'number', desc: 'Inbound ID.' }], - responseSchema: 'HostGroup', - responseSchemaArray: true, - }, - { - method: 'GET', - path: '/panel/api/hosts/tags', - summary: 'Distinct, sorted set of tags used across all hosts.', - response: '{\n "success": true,\n "obj": ["CDN", "EU", "FAST"]\n}', - }, - { - method: 'POST', - path: '/panel/api/hosts/add', - summary: 'Create a host group on inbounds.', - body: '{\n "inboundIds": [1],\n "remark": "cdn-front",\n "hosts": ["cdn.example.com"],\n "port": 8443,\n "security": "same",\n "tags": ["CDN"]\n}', - responseSchema: 'Host', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/hosts/update/:groupId', - summary: 'Replace a host group’s content.', - params: [{ name: 'groupId', in: 'path', type: 'string', desc: 'Host Group ID.' }], - body: '{\n "inboundIds": [1],\n "remark": "cdn-front",\n "hosts": ["cdn.example.com"],\n "port": 8443,\n "security": "same",\n "tags": ["CDN"]\n}', - responseSchema: 'Host', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/hosts/del/:groupId', - summary: 'Delete a host group.', - params: [{ name: 'groupId', in: 'path', type: 'string', desc: 'Host Group ID.' }], - }, - { - method: 'POST', - path: '/panel/api/hosts/setEnable/:groupId', - summary: 'Enable or disable a host group.', - params: [{ name: 'groupId', in: 'path', type: 'string', desc: 'Host Group ID.' }], - body: '{\n "enable": true\n}', - }, - { - method: 'POST', - path: '/panel/api/hosts/reorder', - summary: 'Set host group sort order by the position of each groupId in the array.', - body: '{\n "ids": ["abc-123", "def-456"]\n}', - }, - { - method: 'POST', - path: '/panel/api/hosts/bulk/add', - summary: 'Add a host group to inbounds (same as /add).', - body: '{\n "inboundIds": [1, 2],\n "hosts": ["cdn.example.com", "cdn2.example.com:443"],\n "remark": "Cloudflare CDN",\n "port": 0,\n "security": "same",\n "isDisabled": false\n}', - responseSchema: 'Host', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/hosts/bulk/setEnable', - summary: 'Enable or disable many host groups in one call.', - body: '{\n "ids": ["abc-123", "def-456"],\n "enable": false\n}', - }, - { - method: 'POST', - path: '/panel/api/hosts/bulk/del', - summary: 'Delete many host groups in one call.', - body: '{\n "ids": ["abc-123", "def-456"]\n}', - }, - ], - }, - - { - id: 'backup', - title: 'Backup', - description: 'Operations that interact with the configured Telegram bot.', - endpoints: [ - { - method: 'POST', - path: '/panel/api/backuptotgbot', - summary: - 'Send a fresh DB backup to every Telegram chat configured as an admin recipient. No body, no params.', - }, - ], - }, - - { - id: 'settings', - title: 'Settings', - description: - 'Panel configuration and user credentials. All endpoints live under /panel/api/setting and require a logged-in session or Bearer token.', - endpoints: [ - { - method: 'POST', - path: '/panel/api/setting/all', - summary: - 'Return every panel setting: web server, Telegram bot, subscription, security, LDAP. The full JSON blob that the Settings page edits.', - response: - '{\n "success": true,\n "obj": {\n "webPort": 2053,\n "webCertFile": "",\n "webKeyFile": "",\n "webBasePath": "/",\n "subPort": 10882,\n "subPath": "/sub/",\n "subClashAutoDetect": false,\n "subClashUserAgentRegex": "",\n "subJsonEnable": false,\n "subJsonAutoDetect": false,\n "subJsonAlwaysArray": false,\n "subJsonUserAgentRegex": "",\n "subJsonPath": "/json/",\n "subJsonURI": "https://sub.example.com/json/",\n "subClashEnable": true,\n "subClashPath": "/clash/",\n "subClashURI": "https://sub.example.com/clash/",\n "tgBotEnable": false,\n "tgBotToken": "",\n ...\n }\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/defaultSettings', - summary: - 'Return the computed default settings based on the request host. Useful to preview what a fresh install would use.', - }, - { - method: 'POST', - path: '/panel/api/setting/factoryDefaults', - summary: - 'Return the shipped (factory) default value per browser-safe setting key, so clients can tell a stored value apart from the default it would fall back to. Per-install material (secret, panelGuid, mTLS keys) and credential fields are never included.', - }, - { - method: 'POST', - path: '/panel/api/setting/update', - summary: - 'Persist every setting at once. The body mirrors the shape returned by /all. Invalid values (bad ports, missing cert pairs, etc.) are rejected before write.', - body: '{\n "webPort": 2053,\n "webBasePath": "/",\n "subPort": 10882,\n "subPath": "/sub/",\n "subClashAutoDetect": false,\n "subClashUserAgentRegex": "",\n "subJsonEnable": false,\n "subJsonAutoDetect": false,\n "subJsonAlwaysArray": false,\n "subJsonUserAgentRegex": "",\n "subJsonPath": "/json/",\n "subJsonURI": "https://sub.example.com/json/",\n "subClashEnable": true,\n "subClashPath": "/clash/",\n "subClashURI": "https://sub.example.com/clash/",\n "tgBotEnable": false,\n ...\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/validateRegex', - summary: - 'Validate any regular expression with the backend Go RE2 compiler without saving it.', - body: '{\n "regex": "(?m)^general-purpose$"\n}', - response: '{\n "success": true,\n "msg": ""\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/updateUser', - summary: - 'Change the panel admin username and password. Requires the current credentials for verification. The session is refreshed with the new values on success.', - params: [ - { name: 'oldUsername', in: 'body', type: 'string', desc: 'Current admin username.' }, - { name: 'oldPassword', in: 'body', type: 'string', desc: 'Current admin password.' }, - { name: 'newUsername', in: 'body', type: 'string', desc: 'Desired new username.' }, - { name: 'newPassword', in: 'body', type: 'string', desc: 'Desired new password.' }, - ], - body: '{\n "oldUsername": "admin",\n "oldPassword": "admin",\n "newUsername": "newadmin",\n "newPassword": "newpass"\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/restartPanel', - summary: - 'Restart the entire 3x-ui process after a 3-second grace period. The connection drops immediately; the panel comes back online ~5-10 seconds later.', - }, - { - method: 'POST', - path: '/panel/api/setting/testSmtp', - summary: - 'Test SMTP connection with stage-by-stage reporting (connect, auth, send). Returns structured result with stage and message.', - response: - '{\n "success": true,\n "stage": "send",\n "msg": "Test email sent successfully"\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/testTgBot', - summary: 'Test Telegram bot connection by sending a test message to the configured chat.', - response: '{\n "success": true,\n "msg": "Test message sent to Telegram"\n}', - }, - { - method: 'GET', - path: '/panel/api/setting/getDefaultJsonConfig', - summary: - 'Return the built-in default Xray JSON config template that ships with this panel version.', - }, - ], - }, - - { - id: 'api-tokens', - title: 'API Tokens', - description: - 'Manage scoped Bearer tokens for programmatic auth. Tokens grant admin, monitor, or node-sync access, may expire, and are stored as SHA-256 hashes. The plaintext is returned only once at creation.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/setting/apiTokens', - summary: - 'List every API token, enabled or not. The token value is never returned — only metadata.', - response: - '{\n "success": true,\n "obj": [\n {\n "id": 1,\n "name": "default",\n "enabled": true,\n "createdAt": 1736000000\n }\n ]\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/apiTokens/create', - summary: - 'Mint a scoped API token. The server-generated plaintext is returned only once and stored as a hash.', - params: [ - { - name: 'name', - in: 'body', - type: 'string', - desc: 'Human-readable label, e.g. "central-panel-a".', - }, - { - name: 'scope', - in: 'body', - type: 'string', - desc: 'admin (default), monitor, or node-sync.', - }, - { - name: 'expiresAt', - in: 'body', - type: 'number', - desc: 'Future Unix milliseconds, or 0 for no expiry.', - }, - ], - body: '{\n "name": "central-panel-a",\n "scope": "node-sync",\n "expiresAt": 1798761600000\n}', - responseSchema: 'ApiTokenView', - errorResponse: - '{\n "success": false,\n "msg": "a token with that name already exists"\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/apiTokens/delete/:id', - summary: - 'Permanently delete a token. Any caller using it stops authenticating immediately.', - params: [ - { name: 'id', in: 'path', type: 'number', desc: 'Token row ID.' }, - { - name: 'expectedScope', - in: 'body', - type: 'string', - desc: 'Stored scope expected by the operator.', - }, - ], - body: '{\n "expectedScope": "node-sync"\n}', - response: '{\n "success": true\n}', - }, - { - method: 'POST', - path: '/panel/api/setting/apiTokens/setEnabled/:id', - summary: - 'Toggle a token enabled/disabled without deleting it. Disabled tokens are rejected by checkAPIAuth on the next request.', - params: [ - { name: 'id', in: 'path', type: 'number', desc: 'Token row ID.' }, - { name: 'enabled', in: 'body', type: 'boolean', desc: 'New enabled state.' }, - { - name: 'expectedScope', - in: 'body', - type: 'string', - desc: 'Stored scope expected by the operator.', - }, - ], - body: '{\n "enabled": false,\n "expectedScope": "node-sync"\n}', - response: '{\n "success": true\n}', - }, - ], - }, - - { - id: 'xray-settings', - title: 'Xray Settings', - description: - 'Xray configuration template, outbound management, Warp/Nord/PIA integration, and config testing. All endpoints under /panel/api/xray.', - endpoints: [ - { - method: 'POST', - path: '/panel/api/xray/', - summary: - 'Return the Xray config template (JSON string), available inbound tags, client reverse tags, and the configured outbound test URL in one response.', - response: - '{\n "success": true,\n "obj": {\n "xraySetting": "{...raw xray config...}",\n "inboundTags": "[\\"in-443-tcp\\"]",\n "clientReverseTags": "[]",\n "outboundTestUrl": "https://www.google.com/generate_204"\n }\n}', - }, - { - method: 'GET', - path: '/panel/api/xray/getDefaultJsonConfig', - summary: - 'Return the built-in default Xray config shipped with the panel (identical to /panel/api/setting/getDefaultJsonConfig).', - }, - { - method: 'GET', - path: '/panel/api/xray/getOutboundsTraffic', - summary: - 'Return traffic statistics for every outbound. Each outbound shows up/down/total counters.', - }, - { - method: 'GET', - path: '/panel/api/xray/getXrayResult', - summary: - 'Return the most recent Xray process stdout/stderr output. Useful to check for startup errors or runtime warnings.', - }, - { - method: 'POST', - path: '/panel/api/xray/update', - summary: - 'Save the Xray JSON config template and optionally the outbound test URL. Both are sent as form fields.', - params: [ - { - name: 'xraySetting', - in: 'body (form)', - type: 'string', - desc: 'Full Xray JSON config template.', - }, - { - name: 'outboundTestUrl', - in: 'body (form)', - type: 'string', - desc: 'URL used for outbound reachability tests. Defaults to https://www.google.com/generate_204.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/warp/:action', - summary: 'Manage Cloudflare Warp integration. The action parameter selects the operation.', - params: [ - { - name: 'action', - in: 'path', - type: 'string', - desc: 'data — return Warp stats (quota, remaining). del — delete Warp data. config — return current Warp config. reg — register a new Warp endpoint (sends privateKey, publicKey). license — set a Warp+ license key (sends license).', - }, - { - name: 'privateKey', - in: 'body (form)', - type: 'string', - desc: 'Required when action=reg.', - }, - { - name: 'publicKey', - in: 'body (form)', - type: 'string', - desc: 'Required when action=reg.', - }, - { - name: 'license', - in: 'body (form)', - type: 'string', - desc: 'Required when action=license.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/nord/:action', - summary: 'Manage NordVPN integration. The action parameter selects the operation.', - params: [ - { - name: 'action', - in: 'path', - type: 'string', - desc: 'countries — list available countries. servers — list servers in a country (sends countryId). reg — get NordVPN credentials (sends token). setKey — store NordVPN API key (sends key). data — return current NordVPN connection data. del — delete NordVPN data.', - }, - { - name: 'countryId', - in: 'body (form)', - type: 'string', - desc: 'Required when action=servers.', - }, - { name: 'token', in: 'body (form)', type: 'string', desc: 'Required when action=reg.' }, - { name: 'key', in: 'body (form)', type: 'string', desc: 'Required when action=setKey.' }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/pia/:action', - summary: 'Manage PIA WireGuard integration. The action parameter selects the operation.', - params: [ - { - name: 'action', - in: 'path', - type: 'string', - desc: 'countries — list available countries from the signed PIA server list. servers — list regions and WireGuard servers in a country (sends countryCode). reg — sign in with a PIA username and password (sends username, password). data — return the signed-in account hint. del — delete stored PIA credentials. addKey — register a WireGuard key with the selected server (sends hostname) and return fields to build the outbound.', - }, - { - name: 'username', - in: 'body (form)', - type: 'string', - desc: 'Required when action=reg.', - }, - { - name: 'password', - in: 'body (form)', - type: 'string', - desc: 'Required when action=reg.', - }, - { - name: 'countryCode', - in: 'body (form)', - type: 'string', - desc: 'Required when action=servers.', - }, - { - name: 'hostname', - in: 'body (form)', - type: 'string', - desc: 'Required when action=addKey.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/resetOutboundsTraffic', - summary: 'Reset traffic counters for a specific outbound by tag.', - params: [ - { - name: 'tag', - in: 'body (form)', - type: 'string', - desc: 'Outbound tag to reset (e.g. "proxy", "direct").', - }, - ], - body: 'tag=proxy', - }, - { - method: 'POST', - path: '/panel/api/xray/testOutbound', - summary: - 'Test an outbound configuration. Sends the outbound JSON (required), optionally all outbounds (to resolve sockopt.dialerProxy dependencies), and a mode flag.', - params: [ - { - name: 'outbound', - in: 'body (form)', - type: 'string', - desc: 'JSON-encoded single outbound to test (required).', - }, - { - name: 'allOutbounds', - in: 'body (form)', - type: 'string', - desc: 'JSON array of all outbounds — used to resolve dialerProxy chains.', - }, - { - name: 'mode', - in: 'body (form)', - type: 'string', - desc: '"tcp" for a fast dial-only probe (parallel-safe), "real" for a real-delay probe whose delay is the full request time including tunnel establishment. Default/empty uses a full HTTP probe reporting the warm per-request round-trip. Both HTTP variants run through a temp xray instance.', - }, - ], - body: 'outbound={"protocol":"freedom","settings":{}}&mode=tcp', - }, - { - method: 'POST', - path: '/panel/api/xray/testOutbounds', - summary: - 'Test a batch of outbounds (max 50) through one shared temp xray instance. Returns an array of results in input order, each with the outbound tag, delay, HTTP status and a connect/TLS/TTFB timing breakdown.', - params: [ - { - name: 'outbounds', - in: 'body (form)', - type: 'string', - desc: 'JSON array of outbound configs to test (required).', - }, - { - name: 'allOutbounds', - in: 'body (form)', - type: 'string', - desc: 'JSON array of all outbounds — used to resolve dialerProxy chains.', - }, - { - name: 'mode', - in: 'body (form)', - type: 'string', - desc: '"tcp" for fast dial-only probes (UDP-transport outbounds are still probed over HTTP), "real" for real-delay probes whose delay is the full request time including tunnel establishment. Default/empty routes an HTTP request through each outbound and reports the warm per-request round-trip.', - }, - ], - body: 'outbounds=[{"tag":"direct","protocol":"freedom","settings":{}}]&mode=http', - }, - { - method: 'POST', - path: '/panel/api/xray/balancerStatus', - summary: - 'Live state of routing balancers in the running core (RoutingService.GetBalancerInfo): current override and the targets the strategy prefers. Returns a map keyed by balancer tag.', - params: [ - { - name: 'tags', - in: 'body (form)', - type: 'string', - desc: 'Comma-separated balancer tags to query (e.g. "b1,b2").', - }, - ], - body: 'tags=b1,b2', - }, - { - method: 'POST', - path: '/panel/api/xray/balancerOverride', - summary: - 'Force a balancer in the running core to always pick one outbound (RoutingService.OverrideBalancerTarget). Applied live without a restart; cleared automatically when Xray restarts.', - params: [ - { name: 'tag', in: 'body (form)', type: 'string', desc: 'Balancer tag (required).' }, - { - name: 'target', - in: 'body (form)', - type: 'string', - desc: 'Outbound tag to force. Empty clears the override and returns control to the strategy.', - }, - ], - body: 'tag=b1&target=proxy', - }, - { - method: 'POST', - path: '/panel/api/xray/routeTest', - summary: - 'Ask the running core which outbound its router would pick for a synthetic connection (RoutingService.TestRoute). No traffic is sent.', - params: [ - { - name: 'domain', - in: 'body (form)', - type: 'string', - desc: 'Target domain. Either domain or ip is required.', - }, - { - name: 'ip', - in: 'body (form)', - type: 'string', - desc: 'Target IP. Either domain or ip is required.', - }, - { name: 'port', in: 'body (form)', type: 'number', desc: 'Target port (optional).' }, - { name: 'network', in: 'body (form)', type: 'string', desc: '"tcp" (default) or "udp".' }, - { - name: 'inboundTag', - in: 'body (form)', - type: 'string', - desc: 'Simulate arrival on this inbound (optional).', - }, - { - name: 'protocol', - in: 'body (form)', - type: 'string', - desc: 'Sniffed protocol such as http, tls, bittorrent (optional).', - }, - { - name: 'email', - in: 'body (form)', - type: 'string', - desc: 'User attribution for user-based rules (optional).', - }, - ], - body: 'domain=example.com&port=443&network=tcp', - }, - { - method: 'GET', - path: '/panel/api/xray/geodata/files', - summary: - 'List the geo databases (.dat files) in the Xray asset folder, with the layout detected from their contents, size, modification time and category count. A database that fails to parse is still listed, with the reason in "error".', - }, - { - method: 'GET', - path: '/panel/api/xray/geodata/categories', - summary: - 'One page of a database\'s categories, each with its entry count and the attributes its domains carry (e.g. "ads", "cn").', - params: [ - { - name: 'file', - in: 'query', - type: 'string', - desc: 'Database file name inside the asset folder, e.g. geosite.dat (required).', - }, - { - name: 'q', - in: 'query', - type: 'string', - optional: true, - desc: 'Case-insensitive substring filter on the category code.', - }, - { - name: 'offset', - in: 'query', - type: 'integer', - optional: true, - desc: 'Rows to skip. Defaults to 0.', - }, - { - name: 'limit', - in: 'query', - type: 'integer', - optional: true, - desc: 'Rows to return, capped at 500. Omit it to return every category — the index is small and the panel filters it client-side.', - }, - ], - }, - { - method: 'GET', - path: '/panel/api/xray/geodata/entries', - summary: - 'One page of the rules inside a category — domain rules typed as domain/full/keyword/regexp for geosite databases, CIDRs for geoip ones.', - params: [ - { - name: 'file', - in: 'query', - type: 'string', - desc: 'Database file name inside the asset folder (required).', - }, - { - name: 'code', - in: 'query', - type: 'string', - desc: 'Category code, case-insensitive, e.g. google (required).', - }, - { - name: 'q', - in: 'query', - type: 'string', - optional: true, - desc: 'Case-insensitive substring filter on the rule value.', - }, - { - name: 'offset', - in: 'query', - type: 'integer', - optional: true, - desc: 'Rows to skip. Defaults to 0.', - }, - { - name: 'limit', - in: 'query', - type: 'integer', - optional: true, - desc: 'Rows to return, capped at 500. Defaults to the cap.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/geodata/validate', - summary: - 'Check routing tokens against the databases on disk and return only the ones that do not resolve. Plain domains and CIDRs are ignored. Each issue carries a reason: syntax, fileMissing or categoryMissing.', - params: [ - { - name: 'tokens', - in: 'body (form)', - type: 'string', - desc: 'Comma-separated routing tokens, e.g. "geosite:google,geosite:blabla". Max 500 per request.', - }, - { - name: 'kind', - in: 'body (form)', - type: 'string', - desc: '"ip" to parse the tokens as IP rules (geoip:, ext-ip:, leading !). Anything else parses them as domain rules (geosite:, ext-site:).', - }, - ], - body: 'kind=domain&tokens=geosite:google,geosite:blabla', - }, - { - method: 'GET', - path: '/panel/api/xray/outbound-subs', - summary: - 'List all outbound subscriptions (remote URLs that supply additional outbounds), newest first.', - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs', - summary: - 'Create an outbound subscription. The URL is fetched, parsed into outbounds with stable tags, and merged additively into the running Xray config.', - params: [ - { name: 'remark', in: 'body (form)', type: 'string', desc: 'Optional display label.' }, - { - name: 'url', - in: 'body (form)', - type: 'string', - desc: 'Subscription URL (required). Must be a public http(s) address; private/internal targets are blocked unless allowPrivate is true.', - }, - { - name: 'tagPrefix', - in: 'body (form)', - type: 'string', - desc: 'Prefix for generated outbound tags. Defaults to "sub-".', - }, - { - name: 'updateInterval', - in: 'body (form)', - type: 'integer', - desc: 'Seconds between auto-refreshes. Default 600.', - }, - { - name: 'enabled', - in: 'body (form)', - type: 'boolean', - desc: 'Whether the subscription is active. Default true.', - }, - { - name: 'allowPrivate', - in: 'body (form)', - type: 'boolean', - desc: 'Allow the URL to point at a private/internal/loopback address (localhost/LAN). Default false (SSRF guard blocks private targets).', - }, - { - name: 'prepend', - in: 'body (form)', - type: 'boolean', - desc: "Place this subscription's outbounds before the manual template outbounds (so one can become the default). Default false.", - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs/:id', - summary: - 'Update an existing outbound subscription by id. Accepts the same form fields as create.', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Subscription id.' }], - }, - { - method: 'DELETE', - path: '/panel/api/xray/outbound-subs/:id', - summary: 'Delete an outbound subscription by id.', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Subscription id.' }], - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs/:id/del', - summary: - 'Delete an outbound subscription by id (POST alias of DELETE for clients that cannot send DELETE).', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Subscription id.' }], - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs/:id/refresh', - summary: - 'Force an immediate re-fetch of the subscription and return the parsed outbounds. Signals Xray to reload.', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Subscription id.' }], - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs/:id/move', - summary: - 'Reorder a subscription one step up or down in priority (controls its position in the merged outbounds).', - params: [ - { name: 'id', in: 'path', type: 'integer', desc: 'Subscription id.' }, - { - name: 'dir', - in: 'body (form)', - type: 'string', - desc: '"up" to raise priority, anything else to lower it.', - }, - ], - }, - { - method: 'POST', - path: '/panel/api/xray/outbound-subs/parse', - summary: - 'Preview a subscription URL: fetch and parse it into outbounds without persisting anything.', - params: [ - { - name: 'url', - in: 'body (form)', - type: 'string', - desc: 'Subscription URL to preview (required).', - }, - ], - }, - ], - }, - - { - id: 'sub-balancers', - title: 'Subscription Balancers', - description: - 'Client-side balancers for the JSON subscription: each enabled balancer is emitted as one extra config document whose members are the proxy outbounds of the selected inbounds (routing.balancers + burstObservatory). Managed in Settings → Sub Balancers.', - endpoints: [ - { - method: 'GET', - path: '/panel/api/sub-balancers', - summary: 'List all subscription balancers in sort order (sort_order asc, id asc).', - responseSchema: 'SubBalancer', - responseSchemaArray: true, - }, - { - method: 'POST', - path: '/panel/api/sub-balancers', - summary: - 'Create a subscription balancer. It appears in the JSON subscription of every client that sits on at least one selected inbound.', - params: [ - { - name: 'remark', - in: 'body (form)', - type: 'string', - desc: 'Display label, used as the config remarks (required).', - }, - { - name: 'strategy', - in: 'body (form)', - type: 'string', - desc: 'Balancer strategy: "leastLoad", "leastPing", "roundRobin" or "random" (xray routing balancer strategies). Default "random".', - }, - { - name: 'inboundIds', - in: 'body (form)', - type: 'integer[]', - desc: 'Repeated form keys selecting the member inbounds, e.g. inboundIds=1&inboundIds=3 (required, at least one).', - }, - { - name: 'sortOrder', - in: 'body (form)', - type: 'integer', - desc: '1-based position in the subscription list, interleaved with the inbounds subSortIndex. Default 1.', - }, - { - name: 'enabled', - in: 'body (form)', - type: 'boolean', - desc: 'Whether the balancer is emitted. Default true.', - }, - ], - responseSchema: 'SubBalancer', - }, - { - method: 'POST', - path: '/panel/api/sub-balancers/:id', - summary: - 'Update a balancer by id. Accepts the same form fields as create (full-row update, including the enabled toggle).', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Balancer id.' }], - responseSchema: 'SubBalancer', - }, - { - method: 'DELETE', - path: '/panel/api/sub-balancers/:id', - summary: 'Delete a balancer by id.', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Balancer id.' }], - responseSchema: 'SubBalancer', - }, - { - method: 'POST', - path: '/panel/api/sub-balancers/:id/del', - summary: - 'Delete a balancer by id (POST alias of DELETE for clients that cannot send DELETE).', - params: [{ name: 'id', in: 'path', type: 'integer', desc: 'Balancer id.' }], - responseSchema: 'SubBalancer', - }, - ], - }, - - { - id: 'subscription', - title: 'Subscription Server', - description: - 'A separate HTTP/HTTPS server that serves proxy subscription links (standard, JSON, and Clash) to clients. The server listens on its own port (default 10882) and is configured in Settings → Subscription. Paths are configurable; defaults are shown below. All subscription endpoints set response headers for client apps to read traffic/expiry info.', - subHeader: [ - { - name: 'Subscription-Userinfo', - desc: 'Traffic and expiry: upload=N; download=N; total=N; expire=TS', - }, - { name: 'Profile-Title', desc: 'Base64-encoded subscription display name' }, - { name: 'Profile-Web-Page-Url', desc: 'Link to the subscription info page' }, - { name: 'Support-Url', desc: 'Support contact URL configured in settings' }, - { - name: 'Profile-Update-Interval', - desc: 'Suggested polling interval in minutes (e.g. 10)', - }, - { name: 'Announce', desc: 'Base64-encoded announcement string' }, - { - name: 'Routing-Enable', - desc: 'true or false — whether routing rules are included', - }, - { - name: 'Routing', - desc: 'Global routing rules for client apps that support them (e.g. Happ)', - }, - ], - endpoints: [ - { - method: 'GET', - path: '/{subPath}:subid', - summary: - 'Return base64-encoded subscription links for all enabled clients matching the subscription ID. When the request has an Accept: text/html header or ?html=1, renders a styled info page instead. With ?format=info, returns the page view-model as JSON (traffic, expiry, online status; no links) for live polling. Default path: /sub/:subid.', - params: [ - { name: 'subid', in: 'path', type: 'string', desc: 'Client subscription ID.' }, - { - name: 'format', - in: 'query', - type: 'string', - optional: true, - desc: 'Set to "info" to get the subscription status view-model as JSON instead of the links.', - }, - ], - }, - { - method: 'GET', - path: '/{jsonPath}:subid', - summary: - 'Return subscription as a JSON array of proxy configs (one per enabled client). Only when JSON subscription is enabled in settings. Default path: /json/:subid.', - params: [{ name: 'subid', in: 'path', type: 'string', desc: 'Client subscription ID.' }], - }, - { - method: 'GET', - path: '/{clashPath}:subid', - summary: - 'Return subscription as a Clash/Mihomo-compatible YAML config, including configured global Clash routing rules. Only when Clash subscription is enabled in settings. Default path: /clash/:subid.', - params: [{ name: 'subid', in: 'path', type: 'string', desc: 'Client subscription ID.' }], - }, - ], - }, - - { - id: 'websocket', - title: 'WebSocket', - description: - 'Real-time status updates via WebSocket. Connect once at ws:///ws to receive a stream of JSON messages without polling. Requires an authenticated session cookie (Bearer token auth is not supported). Each message has a type field that identifies the payload shape.', - endpoints: [ - { - method: 'GET', - path: '/ws', - summary: - 'Upgrade an HTTP connection to a WebSocket. Requires an authenticated session cookie (Bearer token auth is not supported here). Returns 101 Switching Protocols on success. The server then pushes JSON messages described below.', - }, - { - method: 'WS', - path: '→ type: status', - summary: - 'Server health snapshot pushed every 2 seconds. Contains CPU, memory, swap, disk, network IO, load, and Xray state — same shape as GET /panel/api/server/status.', - response: - '{\n "type": "status",\n "data": { "cpu": 12.5, "mem": { "current": 2147483648, "total": 8589934592 }, "xray": { "state": "running" } }\n}', - }, - { - method: 'WS', - path: '→ type: xrayState', - summary: - 'Xray process state change. Fired when Xray starts, stops, or encounters an error.', - response: '{\n "type": "xrayState",\n "data": "running"\n}', - }, - { - method: 'WS', - path: '→ type: notification', - summary: - 'In-panel toast notification. Fired on Xray stop/restart, DB import, panel restart, etc.', - response: - '{\n "type": "notification",\n "title": "Xray service restarted",\n "body": "Xray has been restarted successfully",\n "severity": "success"\n}', - }, - { - method: 'WS', - path: '→ type: invalidate', - summary: - 'Instructs the UI to re-fetch a resource. Fired when another admin session modifies data (e.g. toggling inbound enable).', - response: '{\n "type": "invalidate",\n "resource": "inbounds"\n}', - }, - ], - }, -]; diff --git a/frontend/src/pages/clients/BulkAddToGroupModal.tsx b/frontend/src/pages/clients/BulkAddToGroupModal.tsx deleted file mode 100644 index e36cd2e..0000000 --- a/frontend/src/pages/clients/BulkAddToGroupModal.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import { useEffect, useState } from 'react'; -import { useTranslation } from 'react-i18next'; -import { AutoComplete, Form, Modal, message } from 'antd'; -import { FormProvider, useForm, useWatch } from 'react-hook-form'; - -import { FormField } from '@/components/form/rhf'; - -type GroupFormValues = { group: string }; - -const EMPTY: GroupFormValues = { group: '' }; - -interface BulkAddToGroupModalProps { - open: boolean; - count: number; - groups: string[]; - onOpenChange: (open: boolean) => void; - onSubmit: (group: string) => Promise<{ affected?: number } | null>; -} - -export default function BulkAddToGroupModal({ - open, - count, - groups, - onOpenChange, - onSubmit, -}: BulkAddToGroupModalProps) { - const { t } = useTranslation(); - const [messageApi, messageContextHolder] = message.useMessage(); - const [submitting, setSubmitting] = useState(false); - const methods = useForm({ defaultValues: EMPTY }); - const group = useWatch({ control: methods.control, name: 'group' }); - - useEffect(() => { - if (open) methods.reset(EMPTY); - }, [open, methods]); - - async function submit() { - const next = (methods.getValues().group ?? '').trim(); - if (!next) return; - setSubmitting(true); - try { - const result = await onSubmit(next); - if (result) { - const affected = result.affected ?? 0; - messageApi.success( - t('pages.clients.addToGroupSuccessToast', { count: affected, group: next }), - ); - onOpenChange(false); - } - } finally { - setSubmitting(false); - } - } - - return ( - <> - {messageContextHolder} - onOpenChange(false)} - onOk={submit} - destroyOnHidden - > - -
- v ?? '' }} - > - ({ value: g }))} - allowClear - autoFocus - /> - -
- - - - ); -} diff --git a/frontend/src/pages/clients/ClientsPage.tsx b/frontend/src/pages/clients/ClientsPage.tsx index 8293c61..95c7126 100644 --- a/frontend/src/pages/clients/ClientsPage.tsx +++ b/frontend/src/pages/clients/ClientsPage.tsx @@ -43,7 +43,6 @@ import { SearchOutlined, SortAscendingOutlined, StopOutlined, - TagsOutlined, TeamOutlined, UploadOutlined, UsergroupAddOutlined, @@ -83,7 +82,6 @@ const ClientBulkAddModal = lazy(() => import('./ClientBulkAddModal')); const ClientBulkAdjustModal = lazy(() => import('./ClientBulkAdjustModal')); const FilterDrawer = lazy(() => import('./FilterDrawer')); const SubLinksModal = lazy(() => import('./SubLinksModal')); -const BulkAddToGroupModal = lazy(() => import('./BulkAddToGroupModal')); const BulkAttachInboundsModal = lazy(() => import('./BulkAttachInboundsModal')); const BulkDetachInboundsModal = lazy(() => import('./BulkDetachInboundsModal')); const TextModal = lazy(() => import('@/components/feedback/TextModal')); @@ -97,45 +95,6 @@ const FILTER_STATE_KEY = 'clientsFilterState'; const DISABLED_PAGE_SIZE = 200; const DEFAULT_TABLE_PAGE_SIZE = 25; -function UngroupIcon() { - return ( - - - - ); -} - // The server sends exact counters but caps the email arrays behind them, so a // panel with thousands of depleted clients neither ships nor renders them all. // The trailing chip reports what the popover left out. @@ -314,8 +273,6 @@ export default function ClientsPage() { bulkAdjust, bulkEnable, bulkDisable, - bulkAddToGroup, - bulkRemoveFromGroup, attach, setExternalLinks, bulkAttach, @@ -363,7 +320,6 @@ export default function ClientsPage() { const [bulkAddOpen, setBulkAddOpen] = useState(false); const [bulkAdjustOpen, setBulkAdjustOpen] = useState(false); const [subLinksOpen, setSubLinksOpen] = useState(false); - const [bulkGroupOpen, setBulkGroupOpen] = useState(false); const [bulkAttachOpen, setBulkAttachOpen] = useState(false); const [bulkDetachOpen, setBulkDetachOpen] = useState(false); const [selectedRowKeys, setSelectedRowKeys] = useState([]); @@ -846,27 +802,6 @@ export default function ClientsPage() { }); } - function onBulkUngroup() { - const emails = [...selectedRowKeys]; - if (emails.length === 0) return; - modal.confirm({ - title: t('pages.clients.ungroupConfirmTitle', { count: emails.length }), - content: t('pages.clients.ungroupConfirmContent'), - okText: t('confirm'), - okType: 'danger', - cancelText: t('cancel'), - onOk: async () => { - const msg = await bulkRemoveFromGroup(emails); - if (msg?.success) { - setSelectedRowKeys([]); - const affected = - (msg.obj as { affected?: number } | undefined)?.affected ?? emails.length; - messageApi.success(t('pages.clients.ungroupSuccessToast', { count: affected })); - } - }, - }); - } - function onBulkSetEnable(enable: boolean) { const emails = [...selectedRowKeys]; if (emails.length === 0) return; @@ -1382,19 +1317,6 @@ export default function ClientsPage() { danger: true, onClick: () => setBulkDetachOpen(true), }, - { - key: 'addToGroup', - icon: , - label: t('pages.clients.addToGroup'), - onClick: () => setBulkGroupOpen(true), - }, - { - key: 'ungroup', - icon: , - label: t('pages.clients.ungroup'), - danger: true, - onClick: onBulkUngroup, - }, { type: 'divider' as const }, { key: 'enable', @@ -1912,22 +1834,6 @@ export default function ClientsPage() { onOpenChange={setSubLinksOpen} /> - - { - const msg = await bulkAddToGroup([...selectedRowKeys], group); - if (msg?.success) { - setSelectedRowKeys([]); - return (msg.obj as { affected?: number } | undefined) ?? { affected: 0 }; - } - return null; - }} - /> - void; - onSubmit: (emails: string[]) => Promise<{ affected?: number } | null>; -} - -interface ClientRow { - email: string; - comment: string; - enable: boolean; - currentGroup: string; -} - -export default function GroupAddClientsModal({ - open, - groupName, - candidates, - onClose, - onSubmit, -}: GroupAddClientsModalProps) { - const { t } = useTranslation(); - const [messageApi, messageContextHolder] = message.useMessage(); - const [saving, setSaving] = useState(false); - const [selectedEmails, setSelectedEmails] = useState([]); - const [search, setSearch] = useState(''); - - const rows = useMemo( - () => - (candidates || []) - .map((c) => ({ - email: (c.email || '').trim(), - comment: (c.comment || '').trim(), - enable: c.enable !== false, - currentGroup: (c.group || '').trim(), - })) - .filter((r) => r.email), - [candidates], - ); - - // React resets this during render rather than in an effect so the modal's - // first open frame already shows cleared fields. - const [wasOpen, setWasOpen] = useState(false); - if (open !== wasOpen) { - setWasOpen(open); - if (open) { - setSelectedEmails([]); - setSearch(''); - } - } - - const filteredRows = useMemo(() => { - const q = search.trim().toLowerCase(); - if (!q) return rows; - return rows.filter( - (r) => - r.email.toLowerCase().includes(q) || - r.comment.toLowerCase().includes(q) || - r.currentGroup.toLowerCase().includes(q), - ); - }, [rows, search]); - - const columns: ColumnsType = useMemo( - () => [ - { title: t('pages.inbounds.email'), dataIndex: 'email', key: 'email', ellipsis: true }, - { title: t('comment'), dataIndex: 'comment', key: 'comment', ellipsis: true }, - { - title: t('pages.clients.group'), - dataIndex: 'currentGroup', - key: 'currentGroup', - width: 140, - ellipsis: true, - render: (g: string) => - g ? ( - {g} - ) : ( - — - ), - }, - { - title: t('enable'), - dataIndex: 'enable', - key: 'enable', - width: 90, - render: (enabled: boolean) => - enabled ? ( - {t('enable')} - ) : ( - {t('pages.inbounds.attachClientsStatusDisabled')} - ), - }, - ], - [t], - ); - - async function submit() { - if (!groupName || selectedEmails.length === 0) return; - setSaving(true); - try { - const result = await onSubmit(selectedEmails); - if (!result) return; - const affected = result.affected ?? selectedEmails.length; - messageApi.success(t('pages.groups.addToGroupResult', { count: affected, name: groupName })); - onClose(); - } finally { - setSaving(false); - } - } - - return ( - - {messageContextHolder} - - {t('pages.groups.addToGroupDesc')} - - - - - setSearch(e.target.value)} - placeholder={t('pages.inbounds.attachClientsSearchPlaceholder')} - style={{ maxWidth: 320 }} - /> - - {t('pages.inbounds.attachClientsSelectedCount', { - selected: selectedEmails.length, - total: rows.length, - })} - - - {rows.length === 0 ? ( - - ) : ( - - size="small" - rowKey="email" - columns={columns} - dataSource={filteredRows} - pagination={false} - scroll={{ y: 320 }} - rowSelection={{ - selectedRowKeys: selectedEmails, - onChange: (keys) => setSelectedEmails(keys as string[]), - preserveSelectedRowKeys: true, - }} - /> - )} - - - ); -} diff --git a/frontend/src/pages/groups/GroupRemoveClientsModal.tsx b/frontend/src/pages/groups/GroupRemoveClientsModal.tsx deleted file mode 100644 index 4c63c82..0000000 --- a/frontend/src/pages/groups/GroupRemoveClientsModal.tsx +++ /dev/null @@ -1,150 +0,0 @@ -import { useMemo, useState } from 'react'; -import { useTranslation } from 'react-i18next'; -import { Input, Modal, Space, Table, Tag, Typography, message } from 'antd'; -import type { ColumnsType } from 'antd/es/table'; - -import type { ClientRecord } from '@/hooks/useClients'; - -interface GroupRemoveClientsModalProps { - open: boolean; - groupName: string | null; - members: ClientRecord[]; - onClose: () => void; - onSubmit: (emails: string[]) => Promise<{ affected?: number } | null>; -} - -interface ClientRow { - email: string; - comment: string; - enable: boolean; -} - -export default function GroupRemoveClientsModal({ - open, - groupName, - members, - onClose, - onSubmit, -}: GroupRemoveClientsModalProps) { - const { t } = useTranslation(); - const [messageApi, messageContextHolder] = message.useMessage(); - const [saving, setSaving] = useState(false); - const [selectedEmails, setSelectedEmails] = useState([]); - const [search, setSearch] = useState(''); - - const rows = useMemo( - () => - (members || []) - .map((c) => ({ - email: (c.email || '').trim(), - comment: (c.comment || '').trim(), - enable: c.enable !== false, - })) - .filter((r) => r.email), - [members], - ); - - // React resets this during render rather than in an effect so the modal's - // first open frame already shows cleared fields. - const [wasOpen, setWasOpen] = useState(false); - if (open !== wasOpen) { - setWasOpen(open); - if (open) { - setSelectedEmails([]); - setSearch(''); - } - } - - const filteredRows = useMemo(() => { - const q = search.trim().toLowerCase(); - if (!q) return rows; - return rows.filter( - (r) => r.email.toLowerCase().includes(q) || r.comment.toLowerCase().includes(q), - ); - }, [rows, search]); - - const columns: ColumnsType = useMemo( - () => [ - { title: t('pages.inbounds.email'), dataIndex: 'email', key: 'email', ellipsis: true }, - { title: t('comment'), dataIndex: 'comment', key: 'comment', ellipsis: true }, - { - title: t('enable'), - dataIndex: 'enable', - key: 'enable', - width: 90, - render: (enabled: boolean) => - enabled ? ( - {t('enable')} - ) : ( - {t('pages.inbounds.attachClientsStatusDisabled')} - ), - }, - ], - [t], - ); - - async function submit() { - if (!groupName || selectedEmails.length === 0) return; - setSaving(true); - try { - const result = await onSubmit(selectedEmails); - if (!result) return; - const affected = result.affected ?? selectedEmails.length; - messageApi.success( - t('pages.groups.removeFromGroupResult', { count: affected, name: groupName }), - ); - onClose(); - } finally { - setSaving(false); - } - } - - return ( - - {messageContextHolder} - - {t('pages.groups.removeFromGroupDesc')} - - - - - setSearch(e.target.value)} - placeholder={t('pages.inbounds.attachClientsSearchPlaceholder')} - style={{ maxWidth: 320 }} - /> - - {t('pages.inbounds.attachClientsSelectedCount', { - selected: selectedEmails.length, - total: rows.length, - })} - - - - size="small" - rowKey="email" - columns={columns} - dataSource={filteredRows} - pagination={false} - scroll={{ y: 280 }} - rowSelection={{ - selectedRowKeys: selectedEmails, - onChange: (keys) => setSelectedEmails(keys as string[]), - preserveSelectedRowKeys: true, - }} - /> - - - ); -} diff --git a/frontend/src/pages/groups/GroupsPage.tsx b/frontend/src/pages/groups/GroupsPage.tsx deleted file mode 100644 index 040985d..0000000 --- a/frontend/src/pages/groups/GroupsPage.tsx +++ /dev/null @@ -1,708 +0,0 @@ -import { lazy, useCallback, useEffect, useMemo, useState } from 'react'; -import { useTranslation } from 'react-i18next'; -import { - Button, - Card, - Col, - ConfigProvider, - Dropdown, - Form, - Input, - Layout, - Modal, - Result, - Row, - Space, - Spin, - Statistic, - Table, - Tag, - Tooltip, - message, -} from 'antd'; -import type { MenuProps, TableColumnsType } from 'antd'; -import { - ArrowDownOutlined, - ArrowUpOutlined, - ClockCircleOutlined, - DeleteOutlined, - EditOutlined, - LinkOutlined, - MoreOutlined, - PieChartOutlined, - PlusOutlined, - RetweetOutlined, - TagsOutlined, - TeamOutlined, - UsergroupAddOutlined, - UsergroupDeleteOutlined, -} from '@ant-design/icons'; -import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'; -import { z } from 'zod'; - -import { useTheme } from '@/hooks/useTheme'; -import { useMediaQuery } from '@/hooks/useMediaQuery'; -import { usePageTitle } from '@/hooks/usePageTitle'; -import { useClients } from '@/hooks/useClients'; -import { HttpUtil, SizeFormatter } from '@/utils'; -import { setMessageInstance } from '@/utils/messageBus'; -import AppSidebar from '@/layouts/AppSidebar'; -import { LazyMount } from '@/components/utility'; -import { keys } from '@/api/queryKeys'; -import { - ClientRecordSchema, - GroupSummaryListSchema, - type ClientRecord, - type GroupSummary, -} from '@/schemas/client'; -import { parseMsg } from '@/utils/zodValidate'; - -const ClientRecordListSchema = z - .array(ClientRecordSchema) - .nullable() - .transform((v) => v ?? []); - -const SubLinksModal = lazy(() => import('../clients/SubLinksModal')); -const ClientBulkAdjustModal = lazy(() => import('../clients/ClientBulkAdjustModal')); -const GroupAddClientsModal = lazy(() => import('./GroupAddClientsModal')); -const GroupRemoveClientsModal = lazy(() => import('./GroupRemoveClientsModal')); - -const JSON_HEADERS = { headers: { 'Content-Type': 'application/json' } } as const; - -async function fetchGroups(): Promise { - const msg = await HttpUtil.get('/panel/api/clients/groups', undefined, { silent: true }); - if (!msg?.success) throw new Error(msg?.msg || 'Failed to load groups'); - const validated = parseMsg(msg, GroupSummaryListSchema, 'clients/groups'); - return validated.obj ?? []; -} - -async function fetchEmailsForGroup(name: string): Promise { - const msg = await HttpUtil.get( - `/panel/api/clients/groups/${encodeURIComponent(name)}/emails`, - undefined, - { silent: true }, - ); - if (!msg?.success || !Array.isArray(msg.obj)) return []; - return msg.obj; -} - -export default function GroupsPage() { - usePageTitle(); - const { t } = useTranslation(); - const { isDark, isUltra, antdThemeConfig } = useTheme(); - const { isMobile } = useMediaQuery(); - const [modal, modalContextHolder] = Modal.useModal(); - const [messageApi, messageContextHolder] = message.useMessage(); - useEffect(() => { - setMessageInstance(messageApi); - }, [messageApi]); - const queryClient = useQueryClient(); - - const { subSettings, bulkAdjust, bulkAddToGroup, bulkRemoveFromGroup, bulkDelete } = useClients({ - list: false, - }); - - const groupsQuery = useQuery({ - queryKey: keys.clients.groups(), - queryFn: fetchGroups, - }); - const groups = useMemo(() => groupsQuery.data ?? [], [groupsQuery.data]); - const loading = groupsQuery.isFetching; - const fetched = groupsQuery.data !== undefined || groupsQuery.isError; - const fetchError = groupsQuery.error ? (groupsQuery.error as Error).message : ''; - - const invalidate = useCallback(() => { - queryClient.invalidateQueries({ queryKey: keys.clients.root() }); - }, [queryClient]); - - const createMut = useMutation({ - mutationFn: (body: { name: string }) => - HttpUtil.post('/panel/api/clients/groups/create', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidate(); - }, - }); - - const renameMut = useMutation({ - mutationFn: (body: { oldName: string; newName: string }) => - HttpUtil.post('/panel/api/clients/groups/rename', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidate(); - }, - }); - - const deleteMut = useMutation({ - mutationFn: (body: { name: string }) => - HttpUtil.post('/panel/api/clients/groups/delete', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidate(); - }, - }); - - const groupResetMut = useMutation({ - mutationFn: (body: { name: string }) => - HttpUtil.post('/panel/api/clients/groups/resetTraffic', body, JSON_HEADERS), - onSuccess: (msg) => { - if (msg?.success) invalidate(); - }, - }); - - const [createOpen, setCreateOpen] = useState(false); - const [createName, setCreateName] = useState(''); - - const [renameOpen, setRenameOpen] = useState(false); - const [renameTarget, setRenameTarget] = useState(null); - const [renameValue, setRenameValue] = useState(''); - - const [subLinksOpen, setSubLinksOpen] = useState(false); - const [adjustOpen, setAdjustOpen] = useState(false); - const [addClientsOpen, setAddClientsOpen] = useState(false); - const [removeClientsOpen, setRemoveClientsOpen] = useState(false); - const [groupEmails, setGroupEmails] = useState([]); - const [groupForAction, setGroupForAction] = useState(null); - - const allClientsQuery = useQuery({ - queryKey: keys.clients.all(), - queryFn: async () => { - const msg = await HttpUtil.get('/panel/api/clients/list', undefined, { silent: true }); - if (!msg?.success) throw new Error(msg?.msg || 'Failed to load clients'); - const validated = parseMsg(msg, ClientRecordListSchema, 'clients/list'); - return validated.obj ?? []; - }, - enabled: addClientsOpen || removeClientsOpen || subLinksOpen, - staleTime: 30_000, - }); - const allClients = allClientsQuery.data ?? []; - - const totalGroups = groups.length; - const totalClients = useMemo( - () => groups.reduce((acc, g) => acc + (g.clientCount || 0), 0), - [groups], - ); - const totalTraffic = useMemo( - () => groups.reduce((acc, g) => acc + (g.trafficUsed || 0), 0), - [groups], - ); - const totalUpload = useMemo(() => groups.reduce((acc, g) => acc + (g.up || 0), 0), [groups]); - const totalDownload = useMemo(() => groups.reduce((acc, g) => acc + (g.down || 0), 0), [groups]); - - function openCreate() { - setCreateName(''); - setCreateOpen(true); - } - - async function confirmCreate() { - const name = createName.trim(); - if (!name) return; - if (groups.some((g) => g.name.toLowerCase() === name.toLowerCase())) { - messageApi.error(t('pages.groups.renameCollision', { name })); - return; - } - const msg = await createMut.mutateAsync({ name }); - if (msg?.success) { - messageApi.success(t('pages.groups.createSuccess', { name })); - setCreateOpen(false); - } - } - - function openRename(g: GroupSummary) { - setRenameTarget(g); - setRenameValue(g.name); - setRenameOpen(true); - } - - async function confirmRename() { - if (!renameTarget) return; - const next = renameValue.trim(); - if (!next || next === renameTarget.name) { - setRenameOpen(false); - return; - } - if ( - groups.some( - (g) => g.name.toLowerCase() === next.toLowerCase() && g.name !== renameTarget.name, - ) - ) { - messageApi.error(t('pages.groups.renameCollision', { name: next })); - return; - } - const msg = await renameMut.mutateAsync({ oldName: renameTarget.name, newName: next }); - if (msg?.success) { - const affected = (msg.obj as { affected?: number } | undefined)?.affected ?? 0; - messageApi.success(t('pages.groups.renameSuccess', { count: affected })); - setRenameOpen(false); - } - } - - function onDelete(g: GroupSummary) { - modal.confirm({ - title: t('pages.groups.deleteConfirmTitle', { name: g.name }), - content: t('pages.groups.deleteConfirmContent', { count: g.clientCount }), - okText: t('delete'), - okType: 'danger', - cancelText: t('cancel'), - onOk: async () => { - const msg = await deleteMut.mutateAsync({ name: g.name }); - if (msg?.success) { - const affected = (msg.obj as { affected?: number } | undefined)?.affected ?? 0; - messageApi.success(t('pages.groups.deleteSuccess', { count: affected })); - } - }, - }); - } - - async function openSubLinksFor(g: GroupSummary) { - if (!g.clientCount) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - const emails = await fetchEmailsForGroup(g.name); - if (emails.length === 0) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - setGroupForAction(g); - setGroupEmails(emails); - setSubLinksOpen(true); - } - - async function openAdjustFor(g: GroupSummary) { - if (!g.clientCount) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - const emails = await fetchEmailsForGroup(g.name); - if (emails.length === 0) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - setGroupForAction(g); - setGroupEmails(emails); - setAdjustOpen(true); - } - - function openAddClientsFor(g: GroupSummary) { - setGroupForAction(g); - setAddClientsOpen(true); - } - - function openRemoveClientsFor(g: GroupSummary) { - if (!g.clientCount) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - setGroupForAction(g); - setRemoveClientsOpen(true); - } - - function onDeleteClients(g: GroupSummary) { - if (!g.clientCount) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - modal.confirm({ - title: t('pages.groups.deleteClientsConfirmTitle', { name: g.name }), - content: t('pages.groups.deleteClientsConfirmContent', { count: g.clientCount }), - okText: t('delete'), - okType: 'danger', - cancelText: t('cancel'), - onOk: async () => { - const emails = await fetchEmailsForGroup(g.name); - if (emails.length === 0) return; - const msg = await bulkDelete(emails); - if (msg?.success) { - const ok = msg.obj?.deleted ?? 0; - const skipped = msg.obj?.skipped ?? []; - const failed = skipped.length; - if (failed === 0) { - messageApi.success(t('pages.groups.deleteClientsSuccess', { count: ok })); - } else { - const firstError = skipped[0]?.reason ?? msg?.msg ?? ''; - messageApi.warning( - firstError - ? `${t('pages.groups.deleteClientsMixed', { ok, failed })} — ${firstError}` - : t('pages.groups.deleteClientsMixed', { ok, failed }), - ); - } - } - }, - }); - } - - function onResetTraffic(g: GroupSummary) { - if (!g.clientCount) { - messageApi.info(t('pages.groups.emptyForAction')); - return; - } - modal.confirm({ - title: t('pages.groups.resetConfirmTitle', { name: g.name }), - content: t('pages.groups.resetConfirmContent'), - okText: t('reset'), - okType: 'danger', - cancelText: t('cancel'), - onOk: async () => { - const msg = await groupResetMut.mutateAsync({ name: g.name }); - if (msg?.success) { - messageApi.success(t('pages.groups.resetSuccess', { name: g.name })); - } - }, - }); - } - - function rowActions(row: GroupSummary): MenuProps['items'] { - return [ - { - key: 'subLinks', - icon: , - label: t('pages.clients.subLinksSelected', { count: row.clientCount || 0 }), - disabled: !row.clientCount, - onClick: () => openSubLinksFor(row), - }, - { - key: 'adjust', - icon: , - label: t('pages.clients.adjustSelected', { count: row.clientCount || 0 }), - disabled: !row.clientCount, - onClick: () => openAdjustFor(row), - }, - { - key: 'reset', - icon: , - label: t('pages.groups.resetTraffic'), - disabled: !row.clientCount, - onClick: () => onResetTraffic(row), - }, - { - key: 'addClients', - icon: , - label: t('pages.groups.addToGroup'), - onClick: () => openAddClientsFor(row), - }, - { - key: 'rename', - icon: , - label: t('pages.groups.rename'), - onClick: () => openRename(row), - }, - { type: 'divider' }, - { - key: 'removeClients', - icon: , - label: t('pages.groups.removeFromGroup'), - danger: true, - disabled: !row.clientCount, - onClick: () => openRemoveClientsFor(row), - }, - { - key: 'deleteClients', - icon: , - label: t('pages.groups.deleteClients'), - danger: true, - disabled: !row.clientCount, - onClick: () => onDeleteClients(row), - }, - { - key: 'delete', - icon: , - label: t('pages.groups.deleteGroupOnly'), - danger: true, - onClick: () => onDelete(row), - }, - ]; - } - - const columns: TableColumnsType = [ - { - title: t('pages.clients.actions'), - key: 'actions', - width: 90, - render: (_v, row) => ( - - - - } - /> - ) : ( - - - - - - } - /> - - - } - /> - - - ( - - {SizeFormatter.sizeFormat(totalUpload)} - {' / '} - {SizeFormatter.sizeFormat(totalDownload)} - - )} - /> - - - } - /> - - - - - - - - - - } - > - - dataSource={groups} - columns={columns} - rowKey="name" - size="small" - pagination={false} - loading={loading} - locale={{ - emptyText: ( -
- -
{t('noData')}
-
- ), - }} - /> - - - - )} - - - - - setCreateOpen(false)} - onOk={confirmCreate} - destroyOnHidden - > -
- - setCreateName(e.target.value)} - onPressEnter={confirmCreate} - placeholder={t('pages.clients.groupPlaceholder')} - autoFocus - /> - -
- - - setRenameOpen(false)} - onOk={confirmRename} - destroyOnHidden - > -
- - setRenameValue(e.target.value)} - onPressEnter={confirmRename} - placeholder={t('pages.clients.groupPlaceholder')} - autoFocus - /> - -
- - - - - - - - { - const msg = await bulkAdjust(groupEmails, addDays, addBytes); - if (msg?.success) { - const obj = msg.obj ?? { adjusted: 0 }; - messageApi.success( - t('pages.groups.adjustSuccess', { - count: obj.adjusted ?? 0, - name: groupForAction?.name ?? '', - }), - ); - return obj; - } - return null; - }} - /> - - - - c.group !== groupForAction?.name)} - onClose={() => setAddClientsOpen(false)} - onSubmit={async (emails) => { - const msg = await bulkAddToGroup(emails, groupForAction?.name ?? ''); - if (msg?.success) { - return (msg.obj as { affected?: number } | undefined) ?? { affected: 0 }; - } - return null; - }} - /> - - - - c.group === groupForAction?.name)} - onClose={() => setRemoveClientsOpen(false)} - onSubmit={async (emails) => { - const msg = await bulkRemoveFromGroup(emails); - if (msg?.success) { - return (msg.obj as { affected?: number } | undefined) ?? { affected: 0 }; - } - return null; - }} - /> - - - - ); -} diff --git a/frontend/src/pages/inbounds/InboundsPage.tsx b/frontend/src/pages/inbounds/InboundsPage.tsx index 8f12aba..750b1e0 100644 --- a/frontend/src/pages/inbounds/InboundsPage.tsx +++ b/frontend/src/pages/inbounds/InboundsPage.tsx @@ -53,7 +53,6 @@ const QrCodeModal = lazy(() => import('./qr/QrCodeModal')); const AttachClientsModal = lazy(() => import('./clients/AttachClientsModal')); const AttachExistingClientsModal = lazy(() => import('./clients/AttachExistingClientsModal')); const DetachClientsModal = lazy(() => import('./clients/DetachClientsModal')); -const AddClientsToGroupModal = lazy(() => import('./clients/AddClientsToGroupModal')); type RowAction = | 'edit' @@ -68,7 +67,6 @@ type RowAction = | 'attachClients' | 'attachExisting' | 'detachClients' - | 'addToGroup' | 'clone'; type GeneralAction = 'import' | 'export' | 'subs' | 'resetInbounds'; @@ -165,9 +163,6 @@ export default function InboundsPage() { const [detachOpen, setDetachOpen] = useState(false); const [detachSource, setDetachSource] = useState(null); - const [groupOpen, setGroupOpen] = useState(false); - const [groupSource, setGroupSource] = useState(null); - const [cloneOpen, setCloneOpen] = useState(false); const [cloneSource, setCloneSource] = useState(null); @@ -622,7 +617,6 @@ export default function InboundsPage() { 'clipboard', 'clone', 'attachClients', - 'addToGroup', ]; let target = dbInbound; if (hydratingKeys.includes(key)) { @@ -672,10 +666,6 @@ export default function InboundsPage() { setDetachSource(target); setDetachOpen(true); break; - case 'addToGroup': - setGroupSource(target); - setGroupOpen(true); - break; case 'clone': confirmClone(target); break; @@ -848,14 +838,6 @@ export default function InboundsPage() { source={detachSource} /> - - setGroupOpen(false)} - onAdded={refresh} - source={groupSource} - /> - import('@/pages/clients/BulkAddToGroupModal')); - -interface AddClientsToGroupModalProps { - open: boolean; - source: DBInbound | null; - onClose: () => void; - onAdded?: () => void; -} - -function readClientEmails(settings: unknown): string[] { - const parsed = coerceInboundJsonField(settings) as { clients?: Array<{ email?: string }> }; - const clients = Array.isArray(parsed?.clients) ? parsed.clients : []; - return clients.map((c) => (c?.email || '').trim()).filter(Boolean); -} - -export default function AddClientsToGroupModal({ - open, - source, - onClose, - onAdded, -}: AddClientsToGroupModalProps) { - const [groups, setGroups] = useState([]); - - const emails = useMemo(() => (source ? readClientEmails(source.settings) : []), [source]); - - useEffect(() => { - if (!open) return; - let cancelled = false; - (async () => { - const msg = await HttpUtil.get('/panel/api/clients/groups', undefined, { silent: true }); - if (cancelled) return; - const list = Array.isArray(msg?.obj) ? (msg.obj as Array<{ name?: string }>) : []; - setGroups(list.map((g) => g?.name || '').filter(Boolean)); - })(); - return () => { - cancelled = true; - }; - }, [open]); - - return ( - { - if (!o) onClose(); - }} - onSubmit={async (group) => { - const msg = await HttpUtil.post( - '/panel/api/clients/groups/bulkAdd', - { emails, group }, - { headers: { 'Content-Type': 'application/json' } }, - ); - if (!msg?.success) return null; - onAdded?.(); - return (msg.obj as { affected?: number } | undefined) ?? { affected: 0 }; - }} - /> - ); -} diff --git a/frontend/src/pages/inbounds/list/RowActions.tsx b/frontend/src/pages/inbounds/list/RowActions.tsx index 4d0b93f..dfceb4f 100644 --- a/frontend/src/pages/inbounds/list/RowActions.tsx +++ b/frontend/src/pages/inbounds/list/RowActions.tsx @@ -10,7 +10,6 @@ import { BlockOutlined, DeleteOutlined, InfoCircleOutlined, - TagsOutlined, UsergroupAddOutlined, UsergroupDeleteOutlined, } from '@ant-design/icons'; @@ -91,11 +90,6 @@ export function buildRowActionsMenu({ icon: , label: t('pages.inbounds.detachClients'), }); - items.push({ - key: 'addToGroup', - icon: , - label: t('pages.inbounds.addClientsToGroup'), - }); items.push({ type: 'divider' }); items.push({ key: 'delAllClients', diff --git a/frontend/src/pages/index/IndexPage.css b/frontend/src/pages/index/IndexPage.css index 8eb56eb..598ee2a 100644 --- a/frontend/src/pages/index/IndexPage.css +++ b/frontend/src/pages/index/IndexPage.css @@ -38,53 +38,6 @@ flex-wrap: wrap; } -.ov-state { - display: inline-flex; - align-items: center; - gap: 8px; - padding: 4px 12px; - border: 1px solid var(--ov-line); - border-radius: 999px; - font-size: 13px; - color: var(--ant-color-text); -} - -.ov-state-dot { - position: relative; - width: 6px; - height: 6px; - border-radius: 50%; - background: currentColor; - flex: none; -} - -.ov-state[data-state='running'] .ov-state-dot::after { - content: ''; - position: absolute; - inset: -1px; - border-radius: 50%; - border: 1px solid currentColor; - animation: ovPulse 1.6s infinite ease-out; -} - -@keyframes ovPulse { - 0% { - transform: scale(0.9); - opacity: 0.5; - } - 100% { - transform: scale(2.4); - opacity: 0; - } -} - -@media (prefers-reduced-motion: reduce) { - .ov-state[data-state='running'] .ov-state-dot::after { - animation: none; - } -} - -.ov-state-version, .ov-panel-version { padding: 0; border: 0; @@ -95,8 +48,6 @@ transition: color 0.2s; } -.ov-state-version:hover, -.ov-state-version:focus-visible, .ov-panel-version:hover, .ov-panel-version:focus-visible { color: var(--ant-color-primary); @@ -112,11 +63,6 @@ margin-inline-end: 0; } -.ov-error-detail { - white-space: pre-wrap; - word-break: break-word; -} - .ov-bar-actions { margin-inline-start: auto; display: flex; diff --git a/frontend/src/pages/index/IndexPage.tsx b/frontend/src/pages/index/IndexPage.tsx index 536584c..61176ab 100644 --- a/frontend/src/pages/index/IndexPage.tsx +++ b/frontend/src/pages/index/IndexPage.tsx @@ -99,16 +99,6 @@ export default function IndexPage() { if (tip) setLoadingTip(tip); }, []); - const stopXray = useCallback(async () => { - await HttpUtil.post('/panel/api/server/stopXrayService'); - await refresh(); - }, [refresh]); - - const restartXray = useCallback(async () => { - await HttpUtil.post('/panel/api/server/restartXrayService'); - await refresh(); - }, [refresh]); - async function handleChannelChange(dev: boolean) { const res = await HttpUtil.post('/panel/api/server/setUpdateChannel', { dev }); if (!res?.success) return; @@ -198,8 +188,6 @@ export default function IndexPage() { panelVersion={displayVersion} latestVersion={panelUpdateInfo.latestVersion} updateAvailable={panelUpdateInfo.updateAvailable} - onStopXray={stopXray} - onRestartXray={restartXray} onOpenLogs={() => setLogsOpen(true)} onOpenXrayLogs={() => setXrayLogsOpen(true)} onOpenAmneziaWGLogs={() => setAmneziawgLogsOpen(true)} diff --git a/frontend/src/pages/index/OverviewActionBar.tsx b/frontend/src/pages/index/OverviewActionBar.tsx index b279ef1..d97e0f1 100644 --- a/frontend/src/pages/index/OverviewActionBar.tsx +++ b/frontend/src/pages/index/OverviewActionBar.tsx @@ -11,8 +11,6 @@ import { CloudServerOutlined, ControlOutlined, FileTextOutlined, - PoweroffOutlined, - ReloadOutlined, } from '@ant-design/icons'; import { formatPanelVersion } from '@/lib/panel-version'; @@ -25,8 +23,6 @@ interface OverviewActionBarProps { panelVersion: string; latestVersion: string; updateAvailable: boolean; - onStopXray: () => void; - onRestartXray: () => void; onOpenLogs: () => void; onOpenXrayLogs: () => void; onOpenAmneziaWGLogs: () => void; @@ -45,12 +41,6 @@ interface BarAction { primary?: boolean; } -const XRAY_STATE_KEYS: Record = { - running: 'pages.index.xrayStatusRunning', - stop: 'pages.index.xrayStatusStop', - error: 'pages.index.xrayStatusError', -}; - export default function OverviewActionBar({ status, isMobile, @@ -58,8 +48,6 @@ export default function OverviewActionBar({ panelVersion, latestVersion, updateAvailable, - onStopXray, - onRestartXray, onOpenLogs, onOpenXrayLogs, onOpenAmneziaWGLogs, @@ -70,26 +58,9 @@ export default function OverviewActionBar({ onOpenPanelUpdate, }: OverviewActionBarProps) { const { t } = useTranslation(); - const stateText = t(XRAY_STATE_KEYS[status.xray.state] ?? 'pages.index.xrayStatusUnknown'); - const hasVersion = !!status.xray.version && status.xray.version !== 'Unknown'; const size = isMobile ? ('small' as const) : ('middle' as const); const actionGroups: BarAction[][] = [ - [ - { - key: 'restart', - icon: , - text: t('pages.index.restartXray'), - onClick: onRestartXray, - primary: true, - }, - { - key: 'stop', - icon: , - text: t('pages.index.stopXray'), - onClick: onStopXray, - }, - ], [ { key: 'logs', icon: , text: t('pages.index.logs'), onClick: onOpenLogs }, ...(accessLogEnable @@ -141,24 +112,8 @@ export default function OverviewActionBar({ ], ]; - const statePill = ( - - - {`${t('pages.index.xrayStatus')} · ${stateText}`} - {hasVersion && {`v${status.xray.version}`}} - - ); - return (
- {status.xray.state === 'error' && status.xray.errorMsg ? ( - {status.xray.errorMsg}}> - {statePill} - - ) : ( - statePill - )} - {updateAvailable ? ( import('@/pages/index/IndexPage')); const InboundsPage = lazy(() => import('@/pages/inbounds/InboundsPage')); const ClientsPage = lazy(() => import('@/pages/clients/ClientsPage')); -const GroupsPage = lazy(() => import('@/pages/groups/GroupsPage')); const NodesPage = lazy(() => import('@/pages/nodes/NodesPage')); const HostsPage = lazy(() => import('@/pages/hosts/HostsPage')); const SettingsPage = lazy(() => import('@/pages/settings/SettingsPage')); const XrayPage = lazy(() => import('@/pages/xray/XrayPage')); -const ApiDocsPage = lazy(() => import('@/pages/api-docs/ApiDocsPage')); function withSuspense(node: React.ReactNode) { return ( @@ -43,14 +41,12 @@ const routes: RouteObject[] = [ { index: true, element: withSuspense() }, { path: 'inbounds', element: withSuspense() }, { path: 'clients', element: withSuspense() }, - { path: 'groups', element: withSuspense() }, { path: 'nodes', element: withSuspense() }, { path: 'hosts', element: withSuspense() }, { path: 'settings', element: withSuspense() }, { path: 'xray', element: withSuspense() }, { path: 'outbound', element: withSuspense() }, { path: 'routing', element: withSuspense() }, - { path: 'api-docs', element: withSuspense() }, ], }, ]; diff --git a/frontend/src/schemas/client.ts b/frontend/src/schemas/client.ts index c39014a..a3f91e8 100644 --- a/frontend/src/schemas/client.ts +++ b/frontend/src/schemas/client.ts @@ -259,28 +259,6 @@ export const ActiveInboundsByNodeSchema = z .nullable() .transform((v) => v ?? {}); -export const GroupSummarySchema = z.object({ - name: z.string(), - clientCount: z.number(), - trafficUsed: z - .number() - .nullable() - .transform((v) => v ?? 0), - up: z - .number() - .nullable() - .transform((v) => v ?? 0), - down: z - .number() - .nullable() - .transform((v) => v ?? 0), -}); - -export const GroupSummaryListSchema = z - .array(GroupSummarySchema) - .nullable() - .transform((v) => v ?? []); - export function hasForbiddenClientChars(value: string): boolean { if (value.includes('/') || value.includes('\\') || value.includes(' ')) return true; for (let i = 0; i < value.length; i++) { @@ -373,4 +351,3 @@ export type BulkDetachResult = z.infer; export type ClientBulkAddFormValues = z.infer; export type ClientBulkAdjustFormValues = z.infer; export type ClientFormValues = z.infer; -export type GroupSummary = z.infer; diff --git a/internal/web/translation/ar-EG.json b/internal/web/translation/ar-EG.json index 1cfb6ef..01c2702 100644 --- a/internal/web/translation/ar-EG.json +++ b/internal/web/translation/ar-EG.json @@ -95,13 +95,11 @@ "dashboard": "نظرة عامة", "inbounds": "الواردات", "clients": "العملاء", - "groups": "المجموعات", "nodes": "النودز", "settings": "إعدادات اللوحة", "xray": "إعدادات Xray", "routing": "التوجيه", "outbounds": "الصادرات", - "apiDocs": "توثيق API", "donate": "تبرع", "hosts": "المضيفات", "docs": "التوثيق", @@ -128,9 +126,6 @@ "swap": "التبديل", "storage": "تخزين", "memory": "الذاكرة", - "xrayStatus": "Xray", - "stopXray": "إيقاف", - "restartXray": "إعادة تشغيل", "updatePanel": "تحديث البانل", "panelUpdateDesc": "ده هيحدث 3X-UI لآخر إصدار وهيعيد تشغيل خدمة البانل.", "currentPanelVersion": "إصدار البانل الحالي", @@ -141,10 +136,6 @@ "currentCommit": "الكومِت الحالي", "latestCommit": "أحدث كومِت", "updateChannelChanged": "تم تغيير قناة التحديث", - "xrayStatusUnknown": "مش معروف", - "xrayStatusRunning": "شغالة", - "xrayStatusStop": "متوقفة", - "xrayStatusError": "خطأ", "systemHistoryTitle": "تاريخ النظام", "historyTitleCpu": "استخدام المعالج", "historyTitleMem": "استخدام الذاكرة", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "حذف جميع العملاء البالغ عددهم {count} من \"{remark}\"؟", "delAllClientsConfirmContent": "يزيل كل عميل من هذا الإدخال ويحذف سجلات حركة المرور الخاصة بهم. يتم الاحتفاظ بالإدخال نفسه. لا يمكن التراجع عن هذا.", "attachClients": "إرفاق عملاء بـ…", - "addClientsToGroup": "إضافة عملاء إلى مجموعة…", "attachClientsTitle": "إرفاق عملاء من «{remark}»", "attachClientsDesc": "يربط نفس {count} عميل (UUID/كلمة المرور وحركة المرور المشتركة) بالواردات المحددة. يبقون في هذا الوارد أيضاً.", "attachClientsTargets": "الواردات الهدف", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "يُعاد ضبط عدّاد الإرسال/الاستقبال لكل عميل إلى الصفر. لا تتأثر الحصص ومواعيد الانتهاء. لا يمكن التراجع.", "deleteConfirmTitle": "حذف العميل {email}؟", "deleteConfirmContent": "سيؤدي هذا إلى إزالة العميل من جميع الاتصالات الواردة المرتبطة وحذف سجل حركة مروره. لا يمكن التراجع.", - "adjustSelected": "تعديل ({count})", - "subLinksSelected": "روابط الاشتراك ({count})", - "addToGroupTitle": "إضافة {count} عميل إلى مجموعة", - "addToGroupTooltip": "اختر مجموعة موجودة أو أدخل اسماً جديداً. استخدم Ungroup لإزالة العملاء من مجموعتهم الحالية.", - "groupName": "اسم المجموعة", - "addToGroupSuccessToast": "تمت إضافة {count} عميل إلى {group}", - "ungroupSuccessToast": "تم مسح المجموعة من {count} عميل", - "ungroup": "إزالة من المجموعة", - "ungroupConfirmTitle": "إزالة {count} عميل من مجموعتهم؟", - "ungroupConfirmContent": "يمسح تسمية المجموعة من كل عميل محدد. يُحفظ العملاء (استخدم Delete للإزالة الكاملة).", - "addToGroup": "إضافة إلى مجموعة", "attach": "إرفاق", "adjust": "ضبط", "subLinks": "روابط الاشتراك", @@ -880,47 +859,6 @@ "renewOnDayDesc": "يتم التجديد في هذا اليوم من كل شهر ميلادي، عند منتصف الليل بتوقيت اللوحة، بدلاً من كل N يوم. إذا كان الشهر أقصر من اليوم المختار، يتم التجديد في آخر يوم منه. القيمة 0 تُبقي وضع الفاصل اليومي.", "renewsUsed": "التجديدات المستخدمة" }, - "groups": { - "name": "الاسم", - "clientCount": "العملاء", - "totalGroups": "إجمالي المجموعات", - "totalGroupedClients": "العملاء بمجموعة", - "trafficUsed": "حركة المرور المستخدمة", - "upload": "رفع", - "download": "تنزيل", - "totalTraffic": "إجمالي حركة المرور", - "totalUpDown": "إجمالي الرفع / التنزيل", - "addGroup": "إضافة مجموعة", - "createSuccess": "تم إنشاء المجموعة «{name}».", - "rename": "إعادة تسمية", - "renameTitle": "إعادة تسمية {name}", - "renameCollision": "مجموعة باسم «{name}» موجودة بالفعل.", - "renameSuccess": "تمت إعادة تسمية المجموعة على {count} عميل.", - "deleteConfirmTitle": "حذف المجموعة {name}؟", - "deleteConfirmContent": "يحذف المجموعة ويمسح تسميتها من {count} عميل. العملاء أنفسهم لا يُحذفون.", - "deleteSuccess": "تم مسح المجموعة من {count} عميل.", - "resetTraffic": "إعادة تعيين حركة المرور", - "resetConfirmTitle": "إعادة تعيين حركة المرور للمجموعة {name}؟", - "resetConfirmContent": "يعيد تعيين عداد حركة مرور المجموعة فقط؛ ولا تتأثر عدادات العملاء الفرديين.", - "resetSuccess": "تمت إعادة تعيين حركة مرور المجموعة {name}.", - "adjustSuccess": "تم ضبط {count} عميل في {name}.", - "emptyForAction": "هذه المجموعة فارغة.", - "deleteGroupOnly": "حذف المجموعة (مع الاحتفاظ بالعملاء)", - "deleteClients": "حذف عملاء المجموعة", - "deleteClientsConfirmTitle": "حذف جميع العملاء في {name}؟", - "deleteClientsConfirmContent": "يحذف {count} عميل نهائياً مع سجلات حركة المرور. تُمسح تسمية المجموعة أيضاً. لا يمكن التراجع.", - "deleteClientsSuccess": "تم حذف {count} عميل.", - "deleteClientsMixed": "{ok} حُذف، {failed} تم تخطيه", - "addToGroup": "إضافة عملاء…", - "addToGroupTitle": "إضافة عملاء إلى المجموعة «{name}»", - "addToGroupDesc": "اختر العملاء لإضافتهم إلى هذه المجموعة. يحتفظون بارتباطات الواردات الحالية؛ تتغير تسمية المجموعة فقط. لا تُعرض العملاء الذين هم في هذه المجموعة بالفعل.", - "addToGroupEmpty": "لا يوجد عملاء آخرون للإضافة.", - "addToGroupResult": "تمت إضافة {count} عميل إلى {name}.", - "removeFromGroup": "إزالة عملاء…", - "removeFromGroupTitle": "إزالة عملاء من المجموعة «{name}»", - "removeFromGroupDesc": "اختر الأعضاء لإزالتهم من هذه المجموعة. يُحفظ العملاء (استخدم «حذف عملاء المجموعة» للإزالة الكاملة).", - "removeFromGroupResult": "تمت إزالة {count} عميل من {name}." - }, "nodes": { "addNode": "إضافة نود", "editNode": "تحرير العقدة", diff --git a/internal/web/translation/en-US.json b/internal/web/translation/en-US.json index 037695e..2709e80 100644 --- a/internal/web/translation/en-US.json +++ b/internal/web/translation/en-US.json @@ -95,14 +95,12 @@ "dashboard": "Overview", "inbounds": "Inbounds", "clients": "Clients", - "groups": "Groups", "nodes": "Nodes", "hosts": "Hosts", "settings": "Panel Settings", "xray": "Xray Configs", "routing": "Routing", "outbounds": "Outbounds", - "apiDocs": "API Docs", "donate": "Donate", "docs": "Documentation", "openMenu": "Open menu", @@ -128,9 +126,6 @@ "swap": "Swap", "storage": "Storage", "memory": "RAM", - "xrayStatus": "Xray", - "stopXray": "Stop", - "restartXray": "Restart", "updatePanel": "Update Panel", "panelUpdateDesc": "This will update 3X-UI itself to the latest release and restart the panel service.", "currentPanelVersion": "Current panel version", @@ -141,10 +136,6 @@ "currentCommit": "Current commit", "latestCommit": "Latest commit", "updateChannelChanged": "Update channel changed", - "xrayStatusUnknown": "Unknown", - "xrayStatusRunning": "Running", - "xrayStatusStop": "Stopped", - "xrayStatusError": "Error", "systemHistoryTitle": "System History", "historyTitleCpu": "CPU Usage", "historyTitleMem": "Memory Usage", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Delete all {count} clients from \"{remark}\"?", "delAllClientsConfirmContent": "This removes every client from this inbound and drops their traffic records. The inbound itself is kept. This cannot be undone.", "attachClients": "Attach Clients To…", - "addClientsToGroup": "Add Clients To Group…", "attachClientsTitle": "Attach clients from \"{remark}\"", "attachClientsDesc": "Attaches the same {count} clients (same UUID/password and shared traffic) to the selected inbound(s). They stay on this inbound too.", "attachClientsTargets": "Target inbounds", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Every client's up/down counter drops to zero. Quotas and expiry are not affected. This cannot be undone.", "deleteConfirmTitle": "Delete client {email}?", "deleteConfirmContent": "This removes the client from every attached inbound and drops its traffic record. This cannot be undone.", - "adjustSelected": "Adjust ({count})", - "subLinksSelected": "Sub links ({count})", - "addToGroupTitle": "Add {count} client(s) to a group", - "addToGroupTooltip": "Pick an existing group or type a new name. Use the Ungroup action to remove clients from their current group.", - "groupName": "Group name", - "addToGroupSuccessToast": "Added {count} client(s) to {group}", - "ungroupSuccessToast": "Cleared group from {count} client(s)", - "ungroup": "Ungroup", - "ungroupConfirmTitle": "Remove {count} client(s) from their group?", - "ungroupConfirmContent": "Clears the group label on each selected client. Clients themselves are kept (use Delete to remove them entirely).", - "addToGroup": "Add to group", "attach": "Attach", "adjust": "Adjust", "subLinks": "Sub links", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Renew on this day of every calendar month, at midnight in the panel's time zone, instead of every N days. A month too short for the chosen day renews on its last day. 0 keeps the day-interval mode.", "renewsUsed": "Renewals used" }, - "groups": { - "name": "Name", - "clientCount": "Clients", - "totalGroups": "Total groups", - "totalGroupedClients": "Clients with a group", - "trafficUsed": "Traffic used", - "upload": "Upload", - "download": "Download", - "totalTraffic": "Total traffic", - "totalUpDown": "Total upload / download", - "addGroup": "Add Group", - "createSuccess": "Group \"{name}\" created.", - "rename": "Rename", - "renameTitle": "Rename {name}", - "renameCollision": "A group named \"{name}\" already exists.", - "renameSuccess": "Renamed group on {count} client(s).", - "deleteConfirmTitle": "Delete group {name}?", - "deleteConfirmContent": "This removes the group and clears its label from {count} client(s). The clients themselves are not deleted.", - "deleteSuccess": "Cleared group from {count} client(s).", - "resetTraffic": "Reset traffic", - "resetConfirmTitle": "Reset traffic for group {name}?", - "resetConfirmContent": "This resets only the group's traffic counter. Individual client counters are not affected.", - "resetSuccess": "Group {name} traffic reset.", - "adjustSuccess": "Adjusted {count} client(s) in {name}.", - "emptyForAction": "This group has no clients yet.", - "deleteGroupOnly": "Delete group (keep clients)", - "deleteClients": "Delete clients in group", - "deleteClientsConfirmTitle": "Delete all clients in {name}?", - "deleteClientsConfirmContent": "This permanently removes {count} client(s) along with their traffic records. The group label is cleared too. This cannot be undone.", - "deleteClientsSuccess": "Deleted {count} client(s).", - "deleteClientsMixed": "{ok} deleted, {failed} skipped", - "addToGroup": "Add clients…", - "addToGroupTitle": "Add clients to group \"{name}\"", - "addToGroupDesc": "Select clients to add to this group. They keep their existing inbound attachments; only the group label changes. Clients already in this group are not listed.", - "addToGroupEmpty": "No other clients available to add.", - "addToGroupResult": "Added {count} client(s) to {name}.", - "removeFromGroup": "Remove clients…", - "removeFromGroupTitle": "Remove clients from group \"{name}\"", - "removeFromGroupDesc": "Select members to remove from this group. Clients themselves are kept (use \"Delete clients in group\" to remove them entirely).", - "removeFromGroupResult": "Removed {count} client(s) from {name}." - }, "hosts": { "addHost": "Add Host", "editHost": "Edit Host", diff --git a/internal/web/translation/es-ES.json b/internal/web/translation/es-ES.json index eac15c6..b2d65cf 100644 --- a/internal/web/translation/es-ES.json +++ b/internal/web/translation/es-ES.json @@ -95,13 +95,11 @@ "dashboard": "Estado del Sistema", "inbounds": "Entradas", "clients": "Clientes", - "groups": "Grupos", "nodes": "Nodos", "settings": "Ajustes del panel", "xray": "Configuración Xray", "routing": "Enrutamiento", "outbounds": "Salidas", - "apiDocs": "Documentación de la API", "donate": "Donar", "hosts": "Hosts", "docs": "Documentación", @@ -128,9 +126,6 @@ "swap": "Swap", "storage": "Almacenamiento", "memory": "Memoria", - "xrayStatus": "Xray", - "stopXray": "Detener", - "restartXray": "Reiniciar", "updatePanel": "Actualizar panel", "panelUpdateDesc": "Esto actualizará 3X-UI a la última versión y reiniciará el servicio del panel.", "currentPanelVersion": "Versión actual del panel", @@ -141,10 +136,6 @@ "currentCommit": "Commit actual", "latestCommit": "Último commit", "updateChannelChanged": "Canal de actualización cambiado", - "xrayStatusUnknown": "Desconocido", - "xrayStatusRunning": "En ejecución", - "xrayStatusStop": "Detenido", - "xrayStatusError": "Error", "systemHistoryTitle": "Historial del Sistema", "historyTitleCpu": "Uso de CPU", "historyTitleMem": "Uso de Memoria", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "¿Eliminar los {count} clientes de \"{remark}\"?", "delAllClientsConfirmContent": "Elimina todos los clientes de este inbound y sus registros de tráfico. El inbound se mantiene. Esto no se puede deshacer.", "attachClients": "Asociar clientes a…", - "addClientsToGroup": "Añadir clientes al grupo…", "attachClientsTitle": "Asociar clientes desde «{remark}»", "attachClientsDesc": "Asocia los mismos {count} cliente(s) (mismo UUID/contraseña y tráfico compartido) a las entradas seleccionadas. Permanecen también en esta entrada.", "attachClientsTargets": "Entradas objetivo", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "El contador de subida/bajada de cada cliente vuelve a cero. Las cuotas y la expiración no se modifican. Esta acción no se puede deshacer.", "deleteConfirmTitle": "¿Eliminar al cliente {email}?", "deleteConfirmContent": "Esto elimina al cliente de cada inbound asociado y descarta su registro de tráfico. No se puede deshacer.", - "adjustSelected": "Ajustar ({count})", - "subLinksSelected": "Enlaces sub ({count})", - "addToGroupTitle": "Añadir {count} cliente(s) a un grupo", - "addToGroupTooltip": "Selecciona un grupo existente o escribe un nombre nuevo. Usa Ungroup para quitar clientes de su grupo actual.", - "groupName": "Nombre del grupo", - "addToGroupSuccessToast": "Se añadieron {count} cliente(s) a {group}", - "ungroupSuccessToast": "Grupo limpiado de {count} cliente(s)", - "ungroup": "Desagrupar", - "ungroupConfirmTitle": "¿Quitar {count} cliente(s) de su grupo?", - "ungroupConfirmContent": "Limpia la etiqueta de grupo en cada cliente seleccionado. Los clientes se conservan (usa Delete para eliminarlos por completo).", - "addToGroup": "Añadir al grupo", "attach": "Asociar", "adjust": "Ajustar", "subLinks": "Enlaces sub", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Renueva este día de cada mes natural, a medianoche en la zona horaria del panel, en lugar de cada N días. Si el mes es demasiado corto para el día elegido, renueva su último día. 0 mantiene el modo de intervalo en días.", "renewsUsed": "Renovaciones usadas" }, - "groups": { - "name": "Nombre", - "clientCount": "Clientes", - "totalGroups": "Total de grupos", - "totalGroupedClients": "Clientes con grupo", - "trafficUsed": "Tráfico usado", - "upload": "Subida", - "download": "Bajada", - "totalTraffic": "Tráfico total", - "totalUpDown": "Subida / bajada total", - "addGroup": "Añadir grupo", - "createSuccess": "Grupo «{name}» creado.", - "rename": "Renombrar", - "renameTitle": "Renombrar {name}", - "renameCollision": "Ya existe un grupo llamado «{name}».", - "renameSuccess": "Grupo renombrado en {count} cliente(s).", - "deleteConfirmTitle": "¿Eliminar el grupo {name}?", - "deleteConfirmContent": "Esto elimina el grupo y limpia su etiqueta de {count} cliente(s). Los clientes en sí no se eliminan.", - "deleteSuccess": "Grupo limpiado de {count} cliente(s).", - "resetTraffic": "Restablecer tráfico", - "resetConfirmTitle": "¿Restablecer tráfico del grupo {name}?", - "resetConfirmContent": "Esto restablece solo el contador de tráfico del grupo. Los contadores de cada cliente no se ven afectados.", - "resetSuccess": "Tráfico del grupo {name} restablecido.", - "adjustSuccess": "Ajustados {count} cliente(s) en {name}.", - "emptyForAction": "Este grupo aún no tiene clientes.", - "deleteGroupOnly": "Eliminar grupo (conservar clientes)", - "deleteClients": "Eliminar clientes del grupo", - "deleteClientsConfirmTitle": "¿Eliminar todos los clientes en {name}?", - "deleteClientsConfirmContent": "Esto elimina permanentemente {count} cliente(s) junto con sus registros de tráfico. La etiqueta de grupo también se limpia. Esto no se puede deshacer.", - "deleteClientsSuccess": "Eliminados {count} cliente(s).", - "deleteClientsMixed": "{ok} eliminados, {failed} omitidos", - "addToGroup": "Añadir clientes…", - "addToGroupTitle": "Añadir clientes al grupo «{name}»", - "addToGroupDesc": "Selecciona clientes para añadir a este grupo. Mantienen sus asociaciones de entrada existentes; solo cambia la etiqueta de grupo. Los clientes que ya están en este grupo no se muestran.", - "addToGroupEmpty": "No hay otros clientes disponibles para añadir.", - "addToGroupResult": "Añadidos {count} cliente(s) a {name}.", - "removeFromGroup": "Quitar clientes…", - "removeFromGroupTitle": "Quitar clientes del grupo «{name}»", - "removeFromGroupDesc": "Selecciona miembros para quitar de este grupo. Los clientes se conservan (usa «Eliminar clientes del grupo» para eliminarlos por completo).", - "removeFromGroupResult": "Quitados {count} cliente(s) de {name}." - }, "nodes": { "addNode": "Agregar nodo", "editNode": "Editar nodo", diff --git a/internal/web/translation/fa-IR.json b/internal/web/translation/fa-IR.json index d12e12f..443a64d 100644 --- a/internal/web/translation/fa-IR.json +++ b/internal/web/translation/fa-IR.json @@ -95,13 +95,11 @@ "dashboard": "نمای کلی", "inbounds": "ورودی‌ها", "clients": "کلاینت‌ها", - "groups": "گروه‌ها", "nodes": "نودها", "settings": "تنظیمات پنل", "xray": "پیکربندی Xray", "routing": "مسیریابی", "outbounds": "خروجی‌ها", - "apiDocs": "مستندات API", "donate": "حمایت مالی", "hosts": "میزبان‌ها", "docs": "مستندات", @@ -128,9 +126,6 @@ "swap": "سواپ", "storage": "ذخیره‌سازی", "memory": "حافظه", - "xrayStatus": "Xray", - "stopXray": "توقف", - "restartXray": "راه‌اندازی مجدد", "updatePanel": "به‌روزرسانی پنل", "panelUpdateDesc": "این عملیات 3X-UI را به آخرین نسخه به‌روزرسانی می‌کند و سرویس پنل را مجدداً راه‌اندازی می‌کند.", "currentPanelVersion": "نسخه فعلی پنل", @@ -141,10 +136,6 @@ "currentCommit": "کامیت فعلی", "latestCommit": "آخرین کامیت", "updateChannelChanged": "کانال به‌روزرسانی تغییر کرد", - "xrayStatusUnknown": "ناشناخته", - "xrayStatusRunning": "در حال اجرا", - "xrayStatusStop": "متوقف", - "xrayStatusError": "خطا", "systemHistoryTitle": "تاریخچه سیستم", "historyTitleCpu": "مصرف پردازنده", "historyTitleMem": "مصرف حافظه", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "حذف هر {count} کلاینت اینباند «{remark}»؟", "delAllClientsConfirmContent": "تمام کلاینت‌های این اینباند به همراه رکوردهای ترافیک‌شان حذف می‌شوند. خود اینباند باقی می‌ماند. این عمل غیرقابل بازگشت است.", "attachClients": "الصاق کاربران به…", - "addClientsToGroup": "افزودن کاربران به گروه…", "attachClientsTitle": "الصاق کاربران از «{remark}»", "attachClientsDesc": "همان {count} کاربر (با UUID/رمز یکسان و ترافیک مشترک) را به ورودی‌(های) انتخابی الصاق می‌کند. در این ورودی هم باقی می‌مانند.", "attachClientsTargets": "ورودی‌های مقصد", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "شمارنده ارسال/دریافت همه کلاینت‌ها به صفر می‌رسد. سهمیه و تاریخ انقضا تغییری نمی‌کند. این عمل غیرقابل بازگشت است.", "deleteConfirmTitle": "حذف کلاینت {email}؟", "deleteConfirmContent": "این کلاینت از تمام اینباندهای متصل حذف و سابقه ترافیک آن پاک می‌شود. این عمل غیرقابل بازگشت است.", - "adjustSelected": "تنظیم ({count})", - "subLinksSelected": "لینک‌های اشتراک ({count})", - "addToGroupTitle": "افزودن {count} کاربر به یک گروه", - "addToGroupTooltip": "یک گروه موجود را انتخاب کنید یا نام جدیدی تایپ کنید. برای حذف کاربران از گروه فعلی، از Ungroup استفاده کنید.", - "groupName": "نام گروه", - "addToGroupSuccessToast": "{count} کاربر به {group} اضافه شد", - "ungroupSuccessToast": "گروه از {count} کاربر پاک شد", - "ungroup": "خارج از گروه", - "ungroupConfirmTitle": "حذف {count} کاربر از گروهشان؟", - "ungroupConfirmContent": "برچسب گروه را روی هر کاربر انتخابی پاک می‌کند. کاربران حفظ می‌شوند (برای حذف کامل از Delete استفاده کنید).", - "addToGroup": "افزودن به گروه", "attach": "الصاق", "adjust": "تنظیم", "subLinks": "لینک‌های اشتراک", @@ -880,47 +859,6 @@ "renewOnDayDesc": "در این روز از هر ماه تقویمی، در نیمه‌شب به وقت پنل تمدید می‌شود، به جای هر N روز. اگر ماه کوتاه‌تر از روز انتخابی باشد، در آخرین روز آن ماه تمدید می‌شود. مقدار ۰ حالت بازهٔ روزانه را حفظ می‌کند.", "renewsUsed": "تمدیدهای استفاده‌شده" }, - "groups": { - "name": "نام", - "clientCount": "کاربران", - "totalGroups": "تعداد گروه‌ها", - "totalGroupedClients": "کاربران دارای گروه", - "trafficUsed": "ترافیک مصرف‌شده", - "upload": "آپلود", - "download": "دانلود", - "totalTraffic": "مجموع ترافیک", - "totalUpDown": "مجموع آپلود / دانلود", - "addGroup": "افزودن گروه", - "createSuccess": "گروه «{name}» ایجاد شد.", - "rename": "تغییر نام", - "renameTitle": "تغییر نام {name}", - "renameCollision": "گروهی به نام «{name}» از قبل وجود دارد.", - "renameSuccess": "گروه روی {count} کاربر تغییر نام داده شد.", - "deleteConfirmTitle": "حذف گروه {name}؟", - "deleteConfirmContent": "این عمل گروه را حذف می‌کند و برچسب آن را از {count} کاربر پاک می‌کند. خود کاربران حذف نمی‌شوند.", - "deleteSuccess": "گروه از {count} کاربر پاک شد.", - "resetTraffic": "بازنشانی ترافیک", - "resetConfirmTitle": "بازنشانی ترافیک گروه {name}؟", - "resetConfirmContent": "این فقط شمارنده‌ی ترافیک گروه را صفر می‌کند؛ شمارنده‌ی تک‌تک کاربران دست‌نخورده می‌ماند.", - "resetSuccess": "ترافیک گروه {name} صفر شد.", - "adjustSuccess": "{count} کاربر در {name} تنظیم شد.", - "emptyForAction": "این گروه هنوز کاربری ندارد.", - "deleteGroupOnly": "حذف گروه (نگه داشتن کاربران)", - "deleteClients": "حذف کاربران گروه", - "deleteClientsConfirmTitle": "حذف همه کاربران در {name}؟", - "deleteClientsConfirmContent": "این عمل {count} کاربر را به همراه رکورد ترافیک‌شان برای همیشه حذف می‌کند. برچسب گروه نیز پاک می‌شود. این عمل قابل بازگشت نیست.", - "deleteClientsSuccess": "{count} کاربر حذف شد.", - "deleteClientsMixed": "{ok} حذف شد، {failed} نادیده گرفته شد", - "addToGroup": "افزودن کاربران…", - "addToGroupTitle": "افزودن کاربران به گروه «{name}»", - "addToGroupDesc": "کاربرانی را برای افزودن به این گروه انتخاب کنید. الصاق‌های ورودی فعلی حفظ می‌شود؛ تنها برچسب گروه تغییر می‌کند. کاربرانی که از قبل در این گروه هستند نشان داده نمی‌شوند.", - "addToGroupEmpty": "کاربر دیگری برای افزودن در دسترس نیست.", - "addToGroupResult": "{count} کاربر به {name} اضافه شد.", - "removeFromGroup": "حذف کاربران…", - "removeFromGroupTitle": "حذف کاربران از گروه «{name}»", - "removeFromGroupDesc": "اعضایی را برای حذف از این گروه انتخاب کنید. خود کاربران حفظ می‌شوند (برای حذف کامل از «حذف کاربران گروه» استفاده کنید).", - "removeFromGroupResult": "{count} کاربر از {name} حذف شد." - }, "nodes": { "addNode": "افزودن نود", "editNode": "ویرایش نود", diff --git a/internal/web/translation/id-ID.json b/internal/web/translation/id-ID.json index a1a684a..82009c2 100644 --- a/internal/web/translation/id-ID.json +++ b/internal/web/translation/id-ID.json @@ -95,13 +95,11 @@ "dashboard": "Ikhtisar", "inbounds": "Inbound", "clients": "Klien", - "groups": "Grup", "nodes": "Node", "settings": "Pengaturan Panel", "xray": "Konfigurasi Xray", "routing": "Pengalihan", "outbounds": "Outbound", - "apiDocs": "Dokumentasi API", "donate": "Donasi", "hosts": "Host", "docs": "Dokumentasi", @@ -128,9 +126,6 @@ "swap": "Swap", "storage": "Penyimpanan", "memory": "Memori", - "xrayStatus": "Xray", - "stopXray": "Hentikan", - "restartXray": "Mulai ulang", "updatePanel": "Perbarui Panel", "panelUpdateDesc": "Ini akan memperbarui 3X-UI ke rilis terbaru dan me-restart layanan panel.", "currentPanelVersion": "Versi panel saat ini", @@ -141,10 +136,6 @@ "currentCommit": "Commit saat ini", "latestCommit": "Commit terbaru", "updateChannelChanged": "Kanal pembaruan diubah", - "xrayStatusUnknown": "Tidak diketahui", - "xrayStatusRunning": "Berjalan", - "xrayStatusStop": "Berhenti", - "xrayStatusError": "Error", "systemHistoryTitle": "Riwayat Sistem", "historyTitleCpu": "Penggunaan CPU", "historyTitleMem": "Penggunaan Memori", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Hapus semua {count} klien dari \"{remark}\"?", "delAllClientsConfirmContent": "Menghapus setiap klien dari inbound ini dan menghapus catatan trafiknya. Inbound itu sendiri dipertahankan. Tindakan ini tidak dapat dibatalkan.", "attachClients": "Lampirkan klien ke…", - "addClientsToGroup": "Tambah klien ke grup…", "attachClientsTitle": "Lampirkan klien dari «{remark}»", "attachClientsDesc": "Melampirkan {count} klien yang sama (UUID/kata sandi sama dan trafik bersama) ke inbound terpilih. Tetap ada di inbound ini juga.", "attachClientsTargets": "Inbound tujuan", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Penghitung kirim/terima setiap klien turun ke nol. Kuota dan kedaluwarsa tidak terpengaruh. Tidak dapat dibatalkan.", "deleteConfirmTitle": "Hapus klien {email}?", "deleteConfirmContent": "Tindakan ini menghapus klien dari setiap inbound terlampir dan menghapus catatan lalu lintasnya. Tidak dapat dibatalkan.", - "adjustSelected": "Sesuaikan ({count})", - "subLinksSelected": "Tautan sub ({count})", - "addToGroupTitle": "Tambahkan {count} klien ke grup", - "addToGroupTooltip": "Pilih grup yang ada atau ketik nama baru. Gunakan Ungroup untuk menghapus klien dari grup saat ini.", - "groupName": "Nama grup", - "addToGroupSuccessToast": "{count} klien ditambahkan ke {group}", - "ungroupSuccessToast": "Grup dihapus dari {count} klien", - "ungroup": "Lepaskan grup", - "ungroupConfirmTitle": "Hapus {count} klien dari grupnya?", - "ungroupConfirmContent": "Menghapus label grup dari setiap klien terpilih. Klien tetap dipertahankan (gunakan Delete untuk menghapus sepenuhnya).", - "addToGroup": "Tambahkan ke grup", "attach": "Lampirkan", "adjust": "Atur", "subLinks": "Tautan sub", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Perpanjang pada tanggal ini setiap bulan kalender, pada tengah malam menurut zona waktu panel, alih-alih setiap N hari. Bulan yang terlalu pendek untuk tanggal yang dipilih diperpanjang pada hari terakhirnya. 0 mempertahankan mode interval hari.", "renewsUsed": "Perpanjangan terpakai" }, - "groups": { - "name": "Nama", - "clientCount": "Klien", - "totalGroups": "Total grup", - "totalGroupedClients": "Klien dengan grup", - "trafficUsed": "Trafik terpakai", - "upload": "Unggah", - "download": "Unduh", - "totalTraffic": "Total trafik", - "totalUpDown": "Total unggah / unduh", - "addGroup": "Tambah grup", - "createSuccess": "Grup «{name}» dibuat.", - "rename": "Ubah nama", - "renameTitle": "Ubah nama {name}", - "renameCollision": "Grup bernama «{name}» sudah ada.", - "renameSuccess": "Grup diubah namanya pada {count} klien.", - "deleteConfirmTitle": "Hapus grup {name}?", - "deleteConfirmContent": "Ini menghapus grup dan label-nya dari {count} klien. Klien itu sendiri tidak dihapus.", - "deleteSuccess": "Grup dihapus dari {count} klien.", - "resetTraffic": "Reset trafik", - "resetConfirmTitle": "Reset trafik grup {name}?", - "resetConfirmContent": "Ini hanya mengatur ulang penghitung trafik grup. Penghitung tiap klien tidak terpengaruh.", - "resetSuccess": "Trafik grup {name} direset.", - "adjustSuccess": "{count} klien di {name} disesuaikan.", - "emptyForAction": "Grup ini belum memiliki klien.", - "deleteGroupOnly": "Hapus grup (pertahankan klien)", - "deleteClients": "Hapus klien di grup", - "deleteClientsConfirmTitle": "Hapus semua klien di {name}?", - "deleteClientsConfirmContent": "Ini akan menghapus {count} klien secara permanen beserta catatan trafiknya. Label grup juga dihapus. Tidak dapat dibatalkan.", - "deleteClientsSuccess": "{count} klien dihapus.", - "deleteClientsMixed": "{ok} dihapus, {failed} dilewati", - "addToGroup": "Tambah klien…", - "addToGroupTitle": "Tambah klien ke grup «{name}»", - "addToGroupDesc": "Pilih klien untuk ditambahkan ke grup ini. Lampiran inbound yang ada tetap dipertahankan; hanya label grup yang berubah. Klien yang sudah ada di grup ini tidak ditampilkan.", - "addToGroupEmpty": "Tidak ada klien lain untuk ditambahkan.", - "addToGroupResult": "{count} klien ditambahkan ke {name}.", - "removeFromGroup": "Hapus klien…", - "removeFromGroupTitle": "Hapus klien dari grup «{name}»", - "removeFromGroupDesc": "Pilih anggota untuk dihapus dari grup ini. Klien tetap dipertahankan (gunakan «Hapus klien di grup» untuk menghapus sepenuhnya).", - "removeFromGroupResult": "{count} klien dihapus dari {name}." - }, "nodes": { "addNode": "Tambah Node", "editNode": "Edit node", diff --git a/internal/web/translation/ja-JP.json b/internal/web/translation/ja-JP.json index 1fa1b47..8f30901 100644 --- a/internal/web/translation/ja-JP.json +++ b/internal/web/translation/ja-JP.json @@ -95,13 +95,11 @@ "dashboard": "ダッシュボード", "inbounds": "インバウンド", "clients": "クライアント", - "groups": "グループ", "nodes": "ノード", "settings": "パネル設定", "xray": "Xray 設定", "routing": "ルーティング", "outbounds": "アウトバウンド", - "apiDocs": "API ドキュメント", "donate": "寄付", "hosts": "ホスト", "docs": "ドキュメント", @@ -128,9 +126,6 @@ "swap": "スワップ", "storage": "ストレージ", "memory": "メモリ", - "xrayStatus": "Xray", - "stopXray": "停止", - "restartXray": "再起動", "updatePanel": "パネルを更新", "panelUpdateDesc": "これにより3X-UIが最新リリースに更新され、パネルサービスが再起動されます。", "currentPanelVersion": "現在のパネルバージョン", @@ -141,10 +136,6 @@ "currentCommit": "現在のコミット", "latestCommit": "最新のコミット", "updateChannelChanged": "更新チャンネルを変更しました", - "xrayStatusUnknown": "不明", - "xrayStatusRunning": "実行中", - "xrayStatusStop": "停止", - "xrayStatusError": "エラー", "systemHistoryTitle": "システム履歴", "historyTitleCpu": "CPU 使用率", "historyTitleMem": "メモリ使用率", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "「{remark}」から {count} 件のクライアントをすべて削除しますか？", "delAllClientsConfirmContent": "このインバウンドからすべてのクライアントを削除し、トラフィックレコードも破棄します。インバウンド自体は保持されます。この操作は取り消せません。", "attachClients": "クライアントをアタッチ…", - "addClientsToGroup": "クライアントをグループに追加…", "attachClientsTitle": "「{remark}」のクライアントをアタッチ", "attachClientsDesc": "同じ {count} クライアント(同じ UUID/パスワードと共有トラフィック)を選択したインバウンドにアタッチします。このインバウンドにも残ります。", "attachClientsTargets": "ターゲットインバウンド", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "すべてのクライアントの送受信カウンターがゼロにリセットされます。クォータと有効期限には影響しません。元に戻せません。", "deleteConfirmTitle": "クライアント {email} を削除しますか?", "deleteConfirmContent": "クライアントを関連付けされたすべてのインバウンドから削除し、トラフィック記録も破棄します。元に戻せません。", - "adjustSelected": "調整 ({count})", - "subLinksSelected": "サブリンク ({count})", - "addToGroupTitle": "{count} クライアントをグループに追加", - "addToGroupTooltip": "既存のグループを選ぶか新しい名前を入力してください。Ungroup で現在のグループから外せます。", - "groupName": "グループ名", - "addToGroupSuccessToast": "{count} クライアントを {group} に追加しました", - "ungroupSuccessToast": "{count} クライアントのグループをクリアしました", - "ungroup": "グループ解除", - "ungroupConfirmTitle": "{count} クライアントをグループから外しますか?", - "ungroupConfirmContent": "選択したクライアントのグループラベルをクリアします。クライアント自体は保持されます (完全に削除するには Delete を使用)。", - "addToGroup": "グループに追加", "attach": "アタッチ", "adjust": "調整", "subLinks": "サブリンク", @@ -880,47 +859,6 @@ "renewOnDayDesc": "毎月この日の深夜（パネルのタイムゾーン基準）に更新します。N 日ごとの更新の代わりになります。その日が存在しない月は月末に更新されます。0 で日数間隔モードのままになります。", "renewsUsed": "使用済み更新回数" }, - "groups": { - "name": "名前", - "clientCount": "クライアント", - "totalGroups": "グループ合計", - "totalGroupedClients": "グループのあるクライアント", - "trafficUsed": "使用済みトラフィック", - "upload": "アップロード", - "download": "ダウンロード", - "totalTraffic": "合計トラフィック", - "totalUpDown": "合計アップロード / ダウンロード", - "addGroup": "グループ追加", - "createSuccess": "グループ「{name}」を作成しました。", - "rename": "名前変更", - "renameTitle": "{name} の名前を変更", - "renameCollision": "「{name}」という名前のグループは既に存在します。", - "renameSuccess": "{count} クライアントのグループ名を変更しました。", - "deleteConfirmTitle": "グループ {name} を削除?", - "deleteConfirmContent": "これはグループを削除し、{count} クライアントのラベルをクリアします。クライアント自体は削除されません。", - "deleteSuccess": "{count} クライアントのグループをクリアしました。", - "resetTraffic": "トラフィックをリセット", - "resetConfirmTitle": "グループ {name} のトラフィックをリセット?", - "resetConfirmContent": "グループのトラフィックカウンターのみをリセットします。個々のクライアントのカウンターには影響しません。", - "resetSuccess": "グループ {name} のトラフィックをリセットしました。", - "adjustSuccess": "{name} 内の {count} クライアントを調整しました。", - "emptyForAction": "このグループにはまだクライアントがありません。", - "deleteGroupOnly": "グループ削除 (クライアントは保持)", - "deleteClients": "グループのクライアントを削除", - "deleteClientsConfirmTitle": "{name} 内のすべてのクライアントを削除?", - "deleteClientsConfirmContent": "これは {count} クライアントとそのトラフィック記録を永久に削除します。グループラベルもクリアされます。取り消せません。", - "deleteClientsSuccess": "{count} クライアントを削除しました。", - "deleteClientsMixed": "{ok} 削除、{failed} スキップ", - "addToGroup": "クライアントを追加…", - "addToGroupTitle": "グループ「{name}」にクライアントを追加", - "addToGroupDesc": "このグループに追加するクライアントを選択してください。既存のインバウンドアタッチは保持され、グループラベルのみ変更されます。すでにこのグループにいるクライアントは表示されません。", - "addToGroupEmpty": "追加可能な他のクライアントはありません。", - "addToGroupResult": "{count} クライアントを {name} に追加しました。", - "removeFromGroup": "クライアントを削除…", - "removeFromGroupTitle": "グループ「{name}」からクライアントを削除", - "removeFromGroupDesc": "このグループから外すメンバーを選択してください。クライアント自体は保持されます (完全に削除するには「グループのクライアントを削除」を使用)。", - "removeFromGroupResult": "{count} クライアントを {name} から外しました。" - }, "nodes": { "addNode": "ノードを追加", "editNode": "ノード編集", diff --git a/internal/web/translation/pt-BR.json b/internal/web/translation/pt-BR.json index 8f2595c..837b41b 100644 --- a/internal/web/translation/pt-BR.json +++ b/internal/web/translation/pt-BR.json @@ -95,13 +95,11 @@ "dashboard": "Visão Geral", "inbounds": "Entradas", "clients": "Clientes", - "groups": "Grupos", "nodes": "Nós", "settings": "Configurações do Painel", "xray": "Configurações Xray", "routing": "Roteamento", "outbounds": "Saídas", - "apiDocs": "Documentação da API", "donate": "Doar", "hosts": "Hosts", "docs": "Documentação", @@ -128,9 +126,6 @@ "swap": "Swap", "storage": "Armazenamento", "memory": "Memória", - "xrayStatus": "Xray", - "stopXray": "Parar", - "restartXray": "Reiniciar", "updatePanel": "Atualizar painel", "panelUpdateDesc": "Isso atualizará o 3X-UI para a versão mais recente e reiniciará o serviço do painel.", "currentPanelVersion": "Versão atual do painel", @@ -141,10 +136,6 @@ "currentCommit": "Commit atual", "latestCommit": "Último commit", "updateChannelChanged": "Canal de atualização alterado", - "xrayStatusUnknown": "Desconhecido", - "xrayStatusRunning": "Em execução", - "xrayStatusStop": "Parado", - "xrayStatusError": "Erro", "systemHistoryTitle": "Histórico do Sistema", "historyTitleCpu": "Uso da CPU", "historyTitleMem": "Uso de Memória", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Excluir todos os {count} clientes de \"{remark}\"?", "delAllClientsConfirmContent": "Remove todos os clientes deste inbound e descarta seus registros de tráfego. O inbound em si é mantido. Esta ação não pode ser desfeita.", "attachClients": "Associar clientes a…", - "addClientsToGroup": "Adicionar clientes ao grupo…", "attachClientsTitle": "Associar clientes de «{remark}»", "attachClientsDesc": "Associa os mesmos {count} cliente(s) (mesmo UUID/senha e tráfego compartilhado) à(s) entrada(s) selecionada(s). Permanecem nesta entrada também.", "attachClientsTargets": "Entradas de destino", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Os contadores de envio/recebimento de cada cliente vão a zero. Cota e expiração não são afetadas. Não é possível desfazer.", "deleteConfirmTitle": "Excluir o cliente {email}?", "deleteConfirmContent": "Isto remove o cliente de cada inbound associado e descarta o registro de tráfego. Não é possível desfazer.", - "adjustSelected": "Ajustar ({count})", - "subLinksSelected": "Links sub ({count})", - "addToGroupTitle": "Adicionar {count} cliente(s) a um grupo", - "addToGroupTooltip": "Escolha um grupo existente ou digite um novo nome. Use Ungroup para remover clientes do grupo atual.", - "groupName": "Nome do grupo", - "addToGroupSuccessToast": "{count} cliente(s) adicionado(s) a {group}", - "ungroupSuccessToast": "Grupo limpo de {count} cliente(s)", - "ungroup": "Desagrupar", - "ungroupConfirmTitle": "Remover {count} cliente(s) do grupo?", - "ungroupConfirmContent": "Limpa o rótulo de grupo de cada cliente selecionado. Os clientes em si são mantidos (use Delete para remover completamente).", - "addToGroup": "Adicionar ao grupo", "attach": "Associar", "adjust": "Ajustar", "subLinks": "Links de assinatura", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Renova neste dia de cada mês do calendário, à meia-noite no fuso horário do painel, em vez de a cada N dias. Se o mês for curto demais para o dia escolhido, renova no último dia dele. 0 mantém o modo de intervalo em dias.", "renewsUsed": "Renovações usadas" }, - "groups": { - "name": "Nome", - "clientCount": "Clientes", - "totalGroups": "Total de grupos", - "totalGroupedClients": "Clientes com grupo", - "trafficUsed": "Tráfego usado", - "upload": "Envio", - "download": "Recebimento", - "totalTraffic": "Tráfego total", - "totalUpDown": "Total de envio / recebimento", - "addGroup": "Adicionar grupo", - "createSuccess": "Grupo «{name}» criado.", - "rename": "Renomear", - "renameTitle": "Renomear {name}", - "renameCollision": "Já existe um grupo chamado «{name}».", - "renameSuccess": "Grupo renomeado em {count} cliente(s).", - "deleteConfirmTitle": "Excluir o grupo {name}?", - "deleteConfirmContent": "Isso remove o grupo e limpa seu rótulo de {count} cliente(s). Os clientes em si não são excluídos.", - "deleteSuccess": "Grupo limpo de {count} cliente(s).", - "resetTraffic": "Redefinir tráfego", - "resetConfirmTitle": "Redefinir tráfego do grupo {name}?", - "resetConfirmContent": "Isso redefine apenas o contador de tráfego do grupo. Os contadores de cada cliente não são afetados.", - "resetSuccess": "Tráfego do grupo {name} redefinido.", - "adjustSuccess": "Ajustados {count} cliente(s) em {name}.", - "emptyForAction": "Este grupo ainda não tem clientes.", - "deleteGroupOnly": "Excluir grupo (manter clientes)", - "deleteClients": "Excluir clientes do grupo", - "deleteClientsConfirmTitle": "Excluir todos os clientes em {name}?", - "deleteClientsConfirmContent": "Isso remove permanentemente {count} cliente(s) junto com seus registros de tráfego. O rótulo de grupo também é limpo. Isso não pode ser desfeito.", - "deleteClientsSuccess": "Excluídos {count} cliente(s).", - "deleteClientsMixed": "{ok} excluídos, {failed} ignorados", - "addToGroup": "Adicionar clientes…", - "addToGroupTitle": "Adicionar clientes ao grupo «{name}»", - "addToGroupDesc": "Selecione clientes para adicionar a este grupo. Mantêm suas associações de entrada atuais; apenas o rótulo de grupo muda. Clientes já neste grupo não são listados.", - "addToGroupEmpty": "Não há outros clientes disponíveis para adicionar.", - "addToGroupResult": "Adicionados {count} cliente(s) a {name}.", - "removeFromGroup": "Remover clientes…", - "removeFromGroupTitle": "Remover clientes do grupo «{name}»", - "removeFromGroupDesc": "Selecione membros para remover deste grupo. Os clientes em si são mantidos (use «Excluir clientes do grupo» para removê-los por completo).", - "removeFromGroupResult": "Removidos {count} cliente(s) de {name}." - }, "nodes": { "addNode": "Adicionar nó", "editNode": "Editar nó", diff --git a/internal/web/translation/ru-RU.json b/internal/web/translation/ru-RU.json index 2d4530e..20a499c 100644 --- a/internal/web/translation/ru-RU.json +++ b/internal/web/translation/ru-RU.json @@ -95,13 +95,11 @@ "dashboard": "Дашборд", "inbounds": "Входящие", "clients": "Клиенты", - "groups": "Группы", "nodes": "Узлы", "settings": "Настройки панели", "xray": "Конфигурации Xray", "routing": "Маршрутизация", "outbounds": "Исходящие", - "apiDocs": "Документация API", "donate": "Поддержать", "hosts": "Хосты", "docs": "Документация", @@ -128,9 +126,6 @@ "swap": "Подкачка", "storage": "Диск", "memory": "Память", - "xrayStatus": "Xray", - "stopXray": "Стоп", - "restartXray": "Перезапуск", "updatePanel": "Обновить панель", "panelUpdateDesc": "Это обновит 3X-UI до последнего релиза и перезапустит сервис панели.", "currentPanelVersion": "Текущая версия панели", @@ -141,10 +136,6 @@ "currentCommit": "Текущий коммит", "latestCommit": "Последний коммит", "updateChannelChanged": "Канал обновления изменён", - "xrayStatusUnknown": "Неизвестно", - "xrayStatusRunning": "Запущен", - "xrayStatusStop": "Остановлен", - "xrayStatusError": "Ошибка", "systemHistoryTitle": "История системы", "historyTitleCpu": "Загрузка ЦП", "historyTitleMem": "Использование памяти", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Удалить всех {count} клиентов из \"{remark}\"?", "delAllClientsConfirmContent": "Удаляет всех клиентов этого подключения и сбрасывает их записи трафика. Само подключение сохраняется. Это действие нельзя отменить.", "attachClients": "Привязать клиентов к…", - "addClientsToGroup": "Добавить клиентов в группу…", "attachClientsTitle": "Привязать клиентов из «{remark}»", "attachClientsDesc": "Привязывает тех же {count} клиент(ов) (с тем же UUID/паролем и общим трафиком) к выбранным входящим. Они остаются и на этом входящем.", "attachClientsTargets": "Целевые входящие", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Счётчики отправки/приёма всех клиентов сбрасываются в ноль. Квоты и срок действия не затрагиваются. Это действие нельзя отменить.", "deleteConfirmTitle": "Удалить клиента {email}?", "deleteConfirmContent": "Клиент будет удалён из всех привязанных входящих, а его запись трафика будет уничтожена. Это действие нельзя отменить.", - "adjustSelected": "Изменить ({count})", - "subLinksSelected": "Sub-ссылки ({count})", - "addToGroupTitle": "Добавить {count} клиент(ов) в группу", - "addToGroupTooltip": "Выберите существующую группу или введите новое имя. Используйте Ungroup, чтобы удалить клиентов из их текущей группы.", - "groupName": "Имя группы", - "addToGroupSuccessToast": "{count} клиент(ов) добавлено в {group}", - "ungroupSuccessToast": "Группа очищена у {count} клиент(ов)", - "ungroup": "Разгруппировать", - "ungroupConfirmTitle": "Удалить {count} клиент(ов) из их группы?", - "ungroupConfirmContent": "Очищает метку группы у каждого выбранного клиента. Сами клиенты сохраняются (используйте Delete для полного удаления).", - "addToGroup": "Добавить в группу", "attach": "Привязать", "adjust": "Корректировка", "subLinks": "Sub-ссылки", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Продлевать этого числа каждого месяца, в полночь по часовому поясу панели, вместо интервала в днях. Если в месяце такого числа нет, продление придётся на последний день. 0 — оставить режим интервала.", "renewsUsed": "Продлений израсходовано" }, - "groups": { - "name": "Имя", - "clientCount": "Клиенты", - "totalGroups": "Всего групп", - "totalGroupedClients": "Клиенты с группой", - "trafficUsed": "Использованный трафик", - "upload": "Отправлено", - "download": "Получено", - "totalTraffic": "Общий трафик", - "totalUpDown": "Всего отправлено / получено", - "addGroup": "Добавить группу", - "createSuccess": "Группа «{name}» создана.", - "rename": "Переименовать", - "renameTitle": "Переименовать {name}", - "renameCollision": "Группа с именем «{name}» уже существует.", - "renameSuccess": "Группа переименована для {count} клиент(ов).", - "deleteConfirmTitle": "Удалить группу {name}?", - "deleteConfirmContent": "Это удаляет группу и очищает её метку у {count} клиент(ов). Сами клиенты не удаляются.", - "deleteSuccess": "Группа очищена у {count} клиент(ов).", - "resetTraffic": "Сбросить трафик", - "resetConfirmTitle": "Сбросить трафик группы {name}?", - "resetConfirmContent": "Это сбросит только счётчик трафика группы. Счётчики отдельных клиентов не затрагиваются.", - "resetSuccess": "Трафик группы {name} сброшен.", - "adjustSuccess": "Скорректировано {count} клиент(ов) в {name}.", - "emptyForAction": "В этой группе пока нет клиентов.", - "deleteGroupOnly": "Удалить группу (сохранить клиентов)", - "deleteClients": "Удалить клиентов группы", - "deleteClientsConfirmTitle": "Удалить всех клиентов в {name}?", - "deleteClientsConfirmContent": "Это безвозвратно удаляет {count} клиент(ов) вместе с их записями трафика. Метка группы также очищается. Это нельзя отменить.", - "deleteClientsSuccess": "Удалено {count} клиент(ов).", - "deleteClientsMixed": "{ok} удалено, {failed} пропущено", - "addToGroup": "Добавить клиентов…", - "addToGroupTitle": "Добавить клиентов в группу «{name}»", - "addToGroupDesc": "Выберите клиентов для добавления в эту группу. Существующие привязки к входящим сохраняются; меняется только метка группы. Клиенты, уже входящие в эту группу, не показываются.", - "addToGroupEmpty": "Нет других клиентов для добавления.", - "addToGroupResult": "Добавлено {count} клиент(ов) в {name}.", - "removeFromGroup": "Удалить клиентов…", - "removeFromGroupTitle": "Удалить клиентов из группы «{name}»", - "removeFromGroupDesc": "Выберите участников для удаления из этой группы. Сами клиенты сохраняются (используйте «Удалить клиентов группы» для полного удаления).", - "removeFromGroupResult": "Удалено {count} клиент(ов) из {name}." - }, "nodes": { "addNode": "Добавить узел", "editNode": "Изменить узел", diff --git a/internal/web/translation/tr-TR.json b/internal/web/translation/tr-TR.json index c616dd5..3b8511d 100644 --- a/internal/web/translation/tr-TR.json +++ b/internal/web/translation/tr-TR.json @@ -95,13 +95,11 @@ "dashboard": "Genel Bakış", "inbounds": "Gelen Bağlantılar", "clients": "Kullanıcılar", - "groups": "Gruplar", "nodes": "Düğümler", "settings": "Panel Ayarları", "xray": "Xray Yapılandırmaları", "routing": "Yönlendirme", "outbounds": "Giden Bağlantılar", - "apiDocs": "API Belgeleri", "donate": "Bağış Yap", "hosts": "Host'lar", "docs": "Belgeler", @@ -128,9 +126,6 @@ "swap": "Takas", "storage": "Depolama", "memory": "RAM", - "xrayStatus": "Xray", - "stopXray": "Durdur", - "restartXray": "Yeniden Başlat", "updatePanel": "Paneli Güncelle", "panelUpdateDesc": "Bu işlem 3X-UI'yi en son sürüme güncelleyecek ve panel servisini yeniden başlatacaktır.", "currentPanelVersion": "Mevcut panel sürümü", @@ -141,10 +136,6 @@ "currentCommit": "Geçerli commit", "latestCommit": "Son commit", "updateChannelChanged": "Güncelleme kanalı değiştirildi", - "xrayStatusUnknown": "Bilinmiyor", - "xrayStatusRunning": "Çalışıyor", - "xrayStatusStop": "Durduruldu", - "xrayStatusError": "Hata", "systemHistoryTitle": "Sistem Geçmişi", "historyTitleCpu": "CPU Kullanımı", "historyTitleMem": "Bellek Kullanımı", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "\"{remark}\" içindeki {count} kullanıcının tamamı silinsin mi?", "delAllClientsConfirmContent": "Bu gelen bağlantıya ait tüm kullanıcıları ve trafik kayıtlarını siler. Gelen bağlantı silinmez. Bu işlem geri alınamaz.", "attachClients": "Kullanıcıları Şuna Bağla…", - "addClientsToGroup": "Kullanıcıları Gruba Ekle…", "attachClientsTitle": "\"{remark}\" gelen bağlantındaki kullanıcıları bağla", "attachClientsDesc": "Aynı {count} kullanıcıyı (aynı UUID/parola ve paylaşılan trafik) seçilen gelen bağlantılarna bağlar. Bu gelen bağlantında da kalırlar.", "attachClientsTargets": "Hedef Gelen Bağlantılar", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Her kullanıcının yükleme/indirme sayaçları sıfırlanır. Kotalar ve son kullanma tarihleri etkilenmez. Geri alınamaz.", "deleteConfirmTitle": "{email} Kullanıcısı Silinsin Mi?", "deleteConfirmContent": "Bu işlem kullanıcıyı bağlı tüm gelen bağlantılarndan kaldırır ve trafik kaydını siler. Geri alınamaz.", - "adjustSelected": "Ayarla ({count})", - "subLinksSelected": "Abonelik Bağlantıları ({count})", - "addToGroupTitle": "{count} Kullanıcıyı Bir Gruba Ekle", - "addToGroupTooltip": "Mevcut bir grubu seçin veya yeni ad girin. Kullanıcıları mevcut gruplarından çıkarmak için Gruptan Çıkar'ı kullanın.", - "groupName": "Grup Adı", - "addToGroupSuccessToast": "{count} kullanıcı {group} grubuna eklendi", - "ungroupSuccessToast": "{count} kullanıcının grubu temizlendi", - "ungroup": "Gruptan Çıkar", - "ungroupConfirmTitle": "{count} Kullanıcıyı Gruptan Çıkar?", - "ungroupConfirmContent": "Seçilen her kullanıcının grup etiketini temizler. Kullanıcılar korunur (tamamen kaldırmak için Sil'i kullanın).", - "addToGroup": "Gruba Ekle", "attach": "Bağla", "adjust": "Ayarla", "subLinks": "Abonelik Bağlantıları", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Her N günde bir yerine, her takvim ayının bu gününde, panel saat diliminde gece yarısı yeniler. Seçilen gün için kısa olan aylarda ayın son gününde yeniler. 0 gün aralığı modunu korur.", "renewsUsed": "Kullanılan yenileme" }, - "groups": { - "name": "İsim", - "clientCount": "Kullanıcılar", - "totalGroups": "Toplam grup", - "totalGroupedClients": "Grubu olan kullanıcılar", - "trafficUsed": "Kullanılan trafik", - "upload": "Yükleme", - "download": "İndirme", - "totalTraffic": "Toplam trafik", - "totalUpDown": "Toplam yükleme / indirme", - "addGroup": "Grup ekle", - "createSuccess": "«{name}» grubu oluşturuldu.", - "rename": "Yeniden adlandır", - "renameTitle": "{name} yeniden adlandır", - "renameCollision": "«{name}» adında bir grup zaten var.", - "renameSuccess": "{count} kullanıcının grubu yeniden adlandırıldı.", - "deleteConfirmTitle": "{name} Grubunu Sil?", - "deleteConfirmContent": "Bu işlem grubu siler ve etiketini {count} kullanıcıdan kaldırır. Kullanıcılar silinmez.", - "deleteSuccess": "{count} kullanıcının grubu temizlendi.", - "resetTraffic": "Trafiği Sıfırla", - "resetConfirmTitle": "{name} Grubunun Trafiğini Sıfırla?", - "resetConfirmContent": "Bu yalnızca grubun trafik sayacını sıfırlar. Tek tek kullanıcı sayaçları etkilenmez.", - "resetSuccess": "{name} grubunun trafiği sıfırlandı.", - "adjustSuccess": "{name} içinde {count} kullanıcı ayarlandı.", - "emptyForAction": "Bu grupta henüz kullanıcı yok.", - "deleteGroupOnly": "Grubu Sil (Kullanıcıları Tut)", - "deleteClients": "Gruptaki Kullanıcıları Sil", - "deleteClientsConfirmTitle": "{name} İçindeki Tüm Kullanıcıları Sil?", - "deleteClientsConfirmContent": "Bu işlem, {count} kullanıcıyı trafik kayıtlarıyla birlikte kalıcı olarak siler. Grup etiketi de temizlenir. Geri alınamaz.", - "deleteClientsSuccess": "{count} kullanıcı silindi.", - "deleteClientsMixed": "{ok} silindi, {failed} atlandı", - "addToGroup": "Kullanıcı Ekle…", - "addToGroupTitle": "«{name}» Grubuna Kullanıcı Ekle", - "addToGroupDesc": "Bu gruba eklemek için kullanıcıları seçin. Mevcut gelen bağlantılar korunur; yalnızca grup etiketi değişir. Halihazırda bu grupta olan kullanıcılar listelenmez.", - "addToGroupEmpty": "Eklenecek başka kullanıcı yok.", - "addToGroupResult": "{count} kullanıcı {name} grubuna eklendi.", - "removeFromGroup": "Kullanıcı Çıkar…", - "removeFromGroupTitle": "«{name}» Grubundan Kullanıcı Çıkar", - "removeFromGroupDesc": "Bu gruptan çıkarılacak üyeleri seçin. Kullanıcılar korunur (tamamen kaldırmak için «Gruptaki kullanıcıları sil» kullanın).", - "removeFromGroupResult": "{name} grubundan {count} kullanıcı çıkarıldı." - }, "nodes": { "addNode": "Düğüm Ekle", "editNode": "Düğümü Düzenle", diff --git a/internal/web/translation/uk-UA.json b/internal/web/translation/uk-UA.json index 619d161..ae5f4de 100644 --- a/internal/web/translation/uk-UA.json +++ b/internal/web/translation/uk-UA.json @@ -95,13 +95,11 @@ "dashboard": "Огляд", "inbounds": "Вхідні", "clients": "Клієнти", - "groups": "Групи", "nodes": "Вузли", "settings": "Налаштування панелі", "xray": "Конфігурації Xray", "routing": "Маршрутизація", "outbounds": "Вихідні", - "apiDocs": "Документація API", "donate": "Підтримати", "hosts": "Хости", "docs": "Документація", @@ -128,9 +126,6 @@ "swap": "Підкачка", "storage": "Сховище", "memory": "Пам’ять", - "xrayStatus": "Xray", - "stopXray": "Стоп", - "restartXray": "Перезапуск", "updatePanel": "Оновити панель", "panelUpdateDesc": "Це оновить 3X-UI до останнього релізу та перезапустить сервіс панелі.", "currentPanelVersion": "Поточна версія панелі", @@ -141,10 +136,6 @@ "currentCommit": "Поточний коміт", "latestCommit": "Останній коміт", "updateChannelChanged": "Канал оновлення змінено", - "xrayStatusUnknown": "Невідомо", - "xrayStatusRunning": "Запущено", - "xrayStatusStop": "Зупинено", - "xrayStatusError": "Помилка", "systemHistoryTitle": "Історія системи", "historyTitleCpu": "Завантаження ЦП", "historyTitleMem": "Використання пам’яті", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Видалити всіх {count} клієнтів із \"{remark}\"?", "delAllClientsConfirmContent": "Видаляє всіх клієнтів цього вхідного й скидає їхні записи трафіку. Сам вхідний зберігається. Цю дію не можна скасувати.", "attachClients": "Прив'язати клієнтів до…", - "addClientsToGroup": "Додати клієнтів до групи…", "attachClientsTitle": "Прив'язати клієнтів з «{remark}»", "attachClientsDesc": "Прив'язує тих самих {count} клієнт(ів) (з тим самим UUID/паролем і спільним трафіком) до обраних вхідних. Вони залишаються і на цьому вхідному.", "attachClientsTargets": "Цільові вхідні", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Лічильники відправлення/отримання кожного клієнта обнулюються. Квоти й термін дії не змінюються. Цю дію неможливо скасувати.", "deleteConfirmTitle": "Видалити клієнта {email}?", "deleteConfirmContent": "Клієнт буде вилучений з усіх прив'язаних вхідних, його запис трафіку буде знищено. Цю дію неможливо скасувати.", - "adjustSelected": "Змінити ({count})", - "subLinksSelected": "Sub-посилання ({count})", - "addToGroupTitle": "Додати {count} клієнт(ів) до групи", - "addToGroupTooltip": "Виберіть існуючу групу або введіть нову назву. Використовуйте Ungroup, щоб вилучити клієнтів із поточної групи.", - "groupName": "Назва групи", - "addToGroupSuccessToast": "{count} клієнт(ів) додано до {group}", - "ungroupSuccessToast": "Групу очищено у {count} клієнт(ів)", - "ungroup": "Розгрупувати", - "ungroupConfirmTitle": "Видалити {count} клієнт(ів) з їхньої групи?", - "ungroupConfirmContent": "Очищує мітку групи у кожного обраного клієнта. Самі клієнти зберігаються (використовуйте Delete для повного видалення).", - "addToGroup": "Додати до групи", "attach": "Прив'язати", "adjust": "Коригування", "subLinks": "Sub-посилання", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Подовжувати цього числа кожного місяця, опівночі за часовим поясом панелі, замість інтервалу в днях. Якщо в місяці такого числа немає, подовження припаде на останній день. 0 — залишити режим інтервалу.", "renewsUsed": "Подовжень витрачено" }, - "groups": { - "name": "Назва", - "clientCount": "Клієнти", - "totalGroups": "Всього груп", - "totalGroupedClients": "Клієнти з групою", - "trafficUsed": "Використаний трафік", - "upload": "Вивантаження", - "download": "Завантаження", - "totalTraffic": "Загальний трафік", - "totalUpDown": "Всього вивантажено / завантажено", - "addGroup": "Додати групу", - "createSuccess": "Групу «{name}» створено.", - "rename": "Перейменувати", - "renameTitle": "Перейменувати {name}", - "renameCollision": "Група з назвою «{name}» вже існує.", - "renameSuccess": "Групу перейменовано на {count} клієнт(ах).", - "deleteConfirmTitle": "Видалити групу {name}?", - "deleteConfirmContent": "Це видаляє групу й очищує її мітку у {count} клієнт(ів). Самі клієнти не видаляються.", - "deleteSuccess": "Групу очищено у {count} клієнт(ів).", - "resetTraffic": "Скинути трафік", - "resetConfirmTitle": "Скинути трафік групи {name}?", - "resetConfirmContent": "Це скине лише лічильник трафіку групи. Лічильники окремих клієнтів не змінюються.", - "resetSuccess": "Трафік групи {name} скинуто.", - "adjustSuccess": "Скориговано {count} клієнт(ів) у {name}.", - "emptyForAction": "У цій групі ще немає клієнтів.", - "deleteGroupOnly": "Видалити групу (зберегти клієнтів)", - "deleteClients": "Видалити клієнтів групи", - "deleteClientsConfirmTitle": "Видалити всіх клієнтів у {name}?", - "deleteClientsConfirmContent": "Це безповоротно видалить {count} клієнт(ів) разом з їхніми записами трафіку. Мітка групи також очищується. Дію не можна скасувати.", - "deleteClientsSuccess": "Видалено {count} клієнт(ів).", - "deleteClientsMixed": "{ok} видалено, {failed} пропущено", - "addToGroup": "Додати клієнтів…", - "addToGroupTitle": "Додати клієнтів до групи «{name}»", - "addToGroupDesc": "Виберіть клієнтів для додавання в цю групу. Існуючі прив'язки до вхідних зберігаються; змінюється лише мітка групи. Клієнти, які вже в цій групі, не відображаються.", - "addToGroupEmpty": "Немає інших клієнтів для додавання.", - "addToGroupResult": "Додано {count} клієнт(ів) до {name}.", - "removeFromGroup": "Видалити клієнтів…", - "removeFromGroupTitle": "Видалити клієнтів з групи «{name}»", - "removeFromGroupDesc": "Виберіть учасників для видалення з цієї групи. Самі клієнти зберігаються (використовуйте «Видалити клієнтів групи» для повного видалення).", - "removeFromGroupResult": "Видалено {count} клієнт(ів) з {name}." - }, "nodes": { "addNode": "Додати вузол", "editNode": "Змінити вузол", diff --git a/internal/web/translation/vi-VN.json b/internal/web/translation/vi-VN.json index 89c7712..5d3adb9 100644 --- a/internal/web/translation/vi-VN.json +++ b/internal/web/translation/vi-VN.json @@ -95,13 +95,11 @@ "dashboard": "Trạng thái hệ thống", "inbounds": "Inbound", "clients": "Khách hàng", - "groups": "Nhóm", "nodes": "Nút", "settings": "Cài đặt bảng điều khiển", "xray": "Cấu hình Xray", "routing": "Định tuyến", "outbounds": "Outbound", - "apiDocs": "Tài liệu API", "donate": "Quyên góp", "hosts": "Hosts", "docs": "Tài liệu", @@ -128,9 +126,6 @@ "swap": "Swap", "storage": "Lưu trữ", "memory": "Bộ nhớ", - "xrayStatus": "Xray", - "stopXray": "Dừng", - "restartXray": "Khởi động lại", "updatePanel": "Cập nhật Panel", "panelUpdateDesc": "Điều này sẽ cập nhật 3X-UI lên bản phát hành mới nhất và khởi động lại dịch vụ panel.", "currentPanelVersion": "Phiên bản panel hiện tại", @@ -141,10 +136,6 @@ "currentCommit": "Commit hiện tại", "latestCommit": "Commit mới nhất", "updateChannelChanged": "Đã đổi kênh cập nhật", - "xrayStatusUnknown": "Không xác định", - "xrayStatusRunning": "Đang chạy", - "xrayStatusStop": "Dừng", - "xrayStatusError": "Lỗi", "systemHistoryTitle": "Lịch sử hệ thống", "historyTitleCpu": "Mức sử dụng CPU", "historyTitleMem": "Mức sử dụng bộ nhớ", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "Xóa toàn bộ {count} khách hàng khỏi \"{remark}\"?", "delAllClientsConfirmContent": "Xóa mọi khách hàng khỏi inbound này và hủy bản ghi lưu lượng của họ. Bản thân inbound vẫn được giữ lại. Hành động này không thể hoàn tác.", "attachClients": "Gắn client vào…", - "addClientsToGroup": "Thêm client vào nhóm…", "attachClientsTitle": "Gắn client từ «{remark}»", "attachClientsDesc": "Gắn cùng {count} client (cùng UUID/mật khẩu và lưu lượng chung) vào các inbound đã chọn. Họ vẫn ở trên inbound này.", "attachClientsTargets": "Inbound đích", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "Bộ đếm gửi/nhận của mỗi khách hàng về 0. Hạn mức và thời hạn không bị ảnh hưởng. Không thể hoàn tác.", "deleteConfirmTitle": "Xóa khách hàng {email}?", "deleteConfirmContent": "Hành động này gỡ khách hàng khỏi mọi inbound đã gắn và xóa bản ghi lưu lượng. Không thể hoàn tác.", - "adjustSelected": "Điều chỉnh ({count})", - "subLinksSelected": "Liên kết sub ({count})", - "addToGroupTitle": "Thêm {count} client vào một nhóm", - "addToGroupTooltip": "Chọn nhóm có sẵn hoặc nhập tên mới. Dùng Ungroup để xóa client khỏi nhóm hiện tại.", - "groupName": "Tên nhóm", - "addToGroupSuccessToast": "Đã thêm {count} client vào {group}", - "ungroupSuccessToast": "Đã xóa nhóm khỏi {count} client", - "ungroup": "Bỏ nhóm", - "ungroupConfirmTitle": "Xóa {count} client khỏi nhóm của họ?", - "ungroupConfirmContent": "Xóa nhãn nhóm trên mỗi client đã chọn. Bản thân client được giữ lại (dùng Delete để xóa hoàn toàn).", - "addToGroup": "Thêm vào nhóm", "attach": "Gắn", "adjust": "Điều chỉnh", "subLinks": "Liên kết sub", @@ -880,47 +859,6 @@ "renewOnDayDesc": "Gia hạn vào ngày này của mỗi tháng dương lịch, lúc nửa đêm theo múi giờ của bảng điều khiển, thay vì mỗi N ngày. Tháng không có ngày đã chọn sẽ gia hạn vào ngày cuối cùng của tháng. 0 giữ nguyên chế độ khoảng cách theo ngày.", "renewsUsed": "Số lần gia hạn đã dùng" }, - "groups": { - "name": "Tên", - "clientCount": "Client", - "totalGroups": "Tổng số nhóm", - "totalGroupedClients": "Client có nhóm", - "trafficUsed": "Lưu lượng đã dùng", - "upload": "Tải lên", - "download": "Tải xuống", - "totalTraffic": "Tổng lưu lượng", - "totalUpDown": "Tổng tải lên / tải xuống", - "addGroup": "Thêm nhóm", - "createSuccess": "Đã tạo nhóm «{name}».", - "rename": "Đổi tên", - "renameTitle": "Đổi tên {name}", - "renameCollision": "Nhóm có tên «{name}» đã tồn tại.", - "renameSuccess": "Đã đổi tên nhóm trên {count} client.", - "deleteConfirmTitle": "Xóa nhóm {name}?", - "deleteConfirmContent": "Việc này xóa nhóm và xóa nhãn khỏi {count} client. Bản thân client không bị xóa.", - "deleteSuccess": "Đã xóa nhóm khỏi {count} client.", - "resetTraffic": "Đặt lại lưu lượng", - "resetConfirmTitle": "Đặt lại lưu lượng nhóm {name}?", - "resetConfirmContent": "Việc này chỉ đặt lại bộ đếm lưu lượng của nhóm. Bộ đếm của từng client không bị ảnh hưởng.", - "resetSuccess": "Đã đặt lại lưu lượng nhóm {name}.", - "adjustSuccess": "Đã điều chỉnh {count} client trong {name}.", - "emptyForAction": "Nhóm này chưa có client.", - "deleteGroupOnly": "Xóa nhóm (giữ client)", - "deleteClients": "Xóa client trong nhóm", - "deleteClientsConfirmTitle": "Xóa tất cả client trong {name}?", - "deleteClientsConfirmContent": "Việc này xóa vĩnh viễn {count} client cùng với hồ sơ lưu lượng. Nhãn nhóm cũng được xóa. Không thể hoàn tác.", - "deleteClientsSuccess": "Đã xóa {count} client.", - "deleteClientsMixed": "{ok} đã xóa, {failed} bỏ qua", - "addToGroup": "Thêm client…", - "addToGroupTitle": "Thêm client vào nhóm «{name}»", - "addToGroupDesc": "Chọn client để thêm vào nhóm này. Giữ nguyên gắn kết inbound hiện tại; chỉ thay đổi nhãn nhóm. Client đã ở trong nhóm này sẽ không được liệt kê.", - "addToGroupEmpty": "Không có client khác để thêm.", - "addToGroupResult": "Đã thêm {count} client vào {name}.", - "removeFromGroup": "Xóa client…", - "removeFromGroupTitle": "Xóa client khỏi nhóm «{name}»", - "removeFromGroupDesc": "Chọn thành viên để xóa khỏi nhóm này. Bản thân client được giữ lại (dùng «Xóa client trong nhóm» để xóa hoàn toàn).", - "removeFromGroupResult": "Đã xóa {count} client khỏi {name}." - }, "nodes": { "addNode": "Thêm nút", "editNode": "Sửa node", diff --git a/internal/web/translation/zh-CN.json b/internal/web/translation/zh-CN.json index 4e26b58..6bce478 100644 --- a/internal/web/translation/zh-CN.json +++ b/internal/web/translation/zh-CN.json @@ -95,13 +95,11 @@ "dashboard": "系统状态", "inbounds": "入站", "clients": "客户端", - "groups": "分组", "nodes": "节点", "settings": "面板设置", "xray": "Xray 配置", "routing": "路由", "outbounds": "出站", - "apiDocs": "API 文档", "donate": "捐赠", "hosts": "主机", "docs": "文档", @@ -128,9 +126,6 @@ "swap": "交换空间", "storage": "存储", "memory": "内存", - "xrayStatus": "Xray", - "stopXray": "停止", - "restartXray": "重启", "updatePanel": "更新面板", "panelUpdateDesc": "这将把 3X-UI 更新到最新版本并重启面板服务。", "currentPanelVersion": "当前面板版本", @@ -141,10 +136,6 @@ "currentCommit": "当前提交", "latestCommit": "最新提交", "updateChannelChanged": "更新通道已切换", - "xrayStatusUnknown": "未知", - "xrayStatusRunning": "运行中", - "xrayStatusStop": "停止", - "xrayStatusError": "错误", "systemHistoryTitle": "系统历史", "historyTitleCpu": "CPU 使用率", "historyTitleMem": "内存使用率", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "从 \"{remark}\" 中删除全部 {count} 个客户端？", "delAllClientsConfirmContent": "从此入站中移除每个客户端并丢弃其流量记录。入站本身将保留。此操作无法撤销。", "attachClients": "附加客户端到…", - "addClientsToGroup": "将客户端添加到分组…", "attachClientsTitle": "从 “{remark}” 附加客户端", "attachClientsDesc": "将相同的 {count} 个客户端(相同 UUID/密码和共享流量)附加到选定的入站。它们仍保留在此入站中。", "attachClientsTargets": "目标入站", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "所有客户端的上下行计数器将归零。配额与过期时间不受影响。该操作不可撤销。", "deleteConfirmTitle": "删除客户端 {email}？", "deleteConfirmContent": "将从所有关联入站中移除该客户端并删除其流量记录。该操作不可撤销。", - "adjustSelected": "调整 ({count})", - "subLinksSelected": "订阅链接 ({count})", - "addToGroupTitle": "将 {count} 个客户端添加到分组", - "addToGroupTooltip": "选择现有分组或输入新名称。使用 Ungroup 操作从当前分组移除客户端。", - "groupName": "分组名称", - "addToGroupSuccessToast": "已将 {count} 个客户端添加到 {group}", - "ungroupSuccessToast": "已清除 {count} 个客户端的分组", - "ungroup": "取消分组", - "ungroupConfirmTitle": "将 {count} 个客户端从其分组中移除?", - "ungroupConfirmContent": "清除每个选中客户端的分组标签。客户端本身保留（使用 Delete 完全移除）。", - "addToGroup": "添加到分组", "attach": "附加", "adjust": "调整", "subLinks": "订阅链接", @@ -880,47 +859,6 @@ "renewOnDayDesc": "每个自然月的这一天午夜（按面板时区）续期，而不是每 N 天续期一次。若当月没有该日期，则在当月最后一天续期。填 0 保持按天间隔模式。", "renewsUsed": "已用续期次数" }, - "groups": { - "name": "名称", - "clientCount": "客户端", - "totalGroups": "分组总数", - "totalGroupedClients": "有分组的客户端", - "trafficUsed": "已用流量", - "upload": "上传", - "download": "下载", - "totalTraffic": "总流量", - "totalUpDown": "总上传 / 下载", - "addGroup": "添加分组", - "createSuccess": "已创建分组 “{name}”。", - "rename": "重命名", - "renameTitle": "重命名 {name}", - "renameCollision": "已存在名为 “{name}” 的分组。", - "renameSuccess": "已为 {count} 个客户端重命名分组。", - "deleteConfirmTitle": "删除分组 {name}?", - "deleteConfirmContent": "这将删除分组并清除 {count} 个客户端的标签。客户端本身不会被删除。", - "deleteSuccess": "已清除 {count} 个客户端的分组。", - "resetTraffic": "重置流量", - "resetConfirmTitle": "重置分组 {name} 的流量?", - "resetConfirmContent": "这只会清零该分组的流量计数器，不影响各个客户端的计数器。", - "resetSuccess": "已重置分组 {name} 的流量。", - "adjustSuccess": "已调整 {name} 中的 {count} 个客户端。", - "emptyForAction": "此分组尚无客户端。", - "deleteGroupOnly": "删除分组(保留客户端)", - "deleteClients": "删除分组中的客户端", - "deleteClientsConfirmTitle": "删除 {name} 中的所有客户端?", - "deleteClientsConfirmContent": "这将永久删除 {count} 个客户端及其流量记录。分组标签也会被清除。此操作无法撤销。", - "deleteClientsSuccess": "已删除 {count} 个客户端。", - "deleteClientsMixed": "已删除 {ok},已跳过 {failed}", - "addToGroup": "添加客户端…", - "addToGroupTitle": "添加客户端到分组 “{name}”", - "addToGroupDesc": "选择要添加到此分组的客户端。保留其现有入站附加;仅更改分组标签。已在此分组中的客户端不会列出。", - "addToGroupEmpty": "没有其他可添加的客户端。", - "addToGroupResult": "已将 {count} 个客户端添加到 {name}。", - "removeFromGroup": "移除客户端…", - "removeFromGroupTitle": "从分组 “{name}” 移除客户端", - "removeFromGroupDesc": "选择要从此分组中移除的成员。客户端本身保留(使用 “删除分组中的客户端” 完全移除)。", - "removeFromGroupResult": "已从 {name} 移除 {count} 个客户端。" - }, "nodes": { "addNode": "添加节点", "editNode": "编辑节点", diff --git a/internal/web/translation/zh-TW.json b/internal/web/translation/zh-TW.json index 41ec9f4..b28af17 100644 --- a/internal/web/translation/zh-TW.json +++ b/internal/web/translation/zh-TW.json @@ -95,13 +95,11 @@ "dashboard": "系統狀態", "inbounds": "入站", "clients": "客戶端", - "groups": "群組", "nodes": "節點", "settings": "面板設定", "xray": "Xray 設定", "routing": "路由", "outbounds": "出站", - "apiDocs": "API 文件", "donate": "捐贈", "hosts": "主機", "docs": "文件", @@ -128,9 +126,6 @@ "swap": "交換空間", "storage": "儲存", "memory": "記憶體", - "xrayStatus": "Xray", - "stopXray": "停止", - "restartXray": "重新啟動", "updatePanel": "更新面板", "panelUpdateDesc": "這將把 3X-UI 更新到最新版本並重新啟動面板服務。", "currentPanelVersion": "目前面板版本", @@ -141,10 +136,6 @@ "currentCommit": "目前提交", "latestCommit": "最新提交", "updateChannelChanged": "更新通道已切換", - "xrayStatusUnknown": "未知", - "xrayStatusRunning": "運行中", - "xrayStatusStop": "停止", - "xrayStatusError": "錯誤", "systemHistoryTitle": "系統歷史", "historyTitleCpu": "CPU 使用率", "historyTitleMem": "記憶體使用率", @@ -295,7 +286,6 @@ "delAllClientsConfirmTitle": "從「{remark}」中刪除全部 {count} 個客戶端？", "delAllClientsConfirmContent": "從此入站中移除每個客戶端並捨棄其流量記錄。入站本身將保留。此操作無法復原。", "attachClients": "附加客戶端到…", - "addClientsToGroup": "將客戶端加入群組…", "attachClientsTitle": "從「{remark}」附加客戶端", "attachClientsDesc": "將相同的 {count} 個客戶端(相同 UUID/密碼與共享流量)附加到選定入站。它們仍保留於此入站。", "attachClientsTargets": "目標入站", @@ -768,17 +758,6 @@ "resetAllTrafficsContent": "所有客戶端的上下行計數器將歸零。配額與到期時間不受影響。此操作無法復原。", "deleteConfirmTitle": "刪除客戶端 {email}？", "deleteConfirmContent": "將從所有關聯入站中移除該客戶端並刪除其流量紀錄。此操作無法復原。", - "adjustSelected": "調整 ({count})", - "subLinksSelected": "訂閱連結 ({count})", - "addToGroupTitle": "將 {count} 個客戶端加入群組", - "addToGroupTooltip": "選擇現有群組或輸入新名稱。使用 Ungroup 操作從當前群組移除客戶端。", - "groupName": "群組名稱", - "addToGroupSuccessToast": "已將 {count} 個客戶端加入 {group}", - "ungroupSuccessToast": "已清除 {count} 個客戶端的群組", - "ungroup": "取消群組", - "ungroupConfirmTitle": "將 {count} 個客戶端從其群組中移除?", - "ungroupConfirmContent": "清除每個選取客戶端的群組標籤。客戶端本身保留(用 Delete 完全移除)。", - "addToGroup": "加入群組", "attach": "附加", "adjust": "調整", "subLinks": "訂閱連結", @@ -880,47 +859,6 @@ "renewOnDayDesc": "每個自然月的這一天午夜（依面板時區）續期，而不是每 N 天續期一次。若當月沒有該日期，則在當月最後一天續期。填 0 保持按天間隔模式。", "renewsUsed": "已用續期次數" }, - "groups": { - "name": "名稱", - "clientCount": "客戶端", - "totalGroups": "群組總數", - "totalGroupedClients": "有群組的客戶端", - "trafficUsed": "已用流量", - "upload": "上傳", - "download": "下載", - "totalTraffic": "總流量", - "totalUpDown": "總上傳 / 下載", - "addGroup": "新增群組", - "createSuccess": "已建立群組「{name}」。", - "rename": "重新命名", - "renameTitle": "重新命名 {name}", - "renameCollision": "已存在名為「{name}」的群組。", - "renameSuccess": "已為 {count} 個客戶端重新命名群組。", - "deleteConfirmTitle": "刪除群組 {name}?", - "deleteConfirmContent": "這將刪除群組並清除 {count} 個客戶端的標籤。客戶端本身不會被刪除。", - "deleteSuccess": "已清除 {count} 個客戶端的群組。", - "resetTraffic": "重置流量", - "resetConfirmTitle": "重置群組 {name} 的流量?", - "resetConfirmContent": "這只會將此群組的流量計數器歸零，不影響各個客戶端的計數器。", - "resetSuccess": "已重置群組 {name} 的流量。", - "adjustSuccess": "已調整 {name} 中的 {count} 個客戶端。", - "emptyForAction": "此群組尚無客戶端。", - "deleteGroupOnly": "刪除群組(保留客戶端)", - "deleteClients": "刪除群組中的客戶端", - "deleteClientsConfirmTitle": "刪除 {name} 中的所有客戶端?", - "deleteClientsConfirmContent": "這將永久刪除 {count} 個客戶端及其流量記錄。群組標籤亦會被清除。此操作無法復原。", - "deleteClientsSuccess": "已刪除 {count} 個客戶端。", - "deleteClientsMixed": "已刪除 {ok},已略過 {failed}", - "addToGroup": "新增客戶端…", - "addToGroupTitle": "將客戶端加入群組「{name}」", - "addToGroupDesc": "選擇要加入此群組的客戶端。保留其現有入站附加;僅更改群組標籤。已在此群組中的客戶端不會列出。", - "addToGroupEmpty": "沒有其他可加入的客戶端。", - "addToGroupResult": "已將 {count} 個客戶端加入 {name}。", - "removeFromGroup": "移除客戶端…", - "removeFromGroupTitle": "從群組「{name}」移除客戶端", - "removeFromGroupDesc": "選擇要從此群組移除的成員。客戶端本身保留(用「刪除群組中的客戶端」完全移除)。", - "removeFromGroupResult": "已從 {name} 移除 {count} 個客戶端。" - }, "nodes": { "addNode": "新增節點", "editNode": "編輯節點",