package docs import "github.com/swaggo/swag" const docTemplate = `{ "swagger": "2.0", "info": { "contact": {}, "description": "Top-Rated Web-based Linux Server Management Tool", "license": { "name": "GPL-3.0", "url": "https://www.gnu.org/licenses/gpl-3.0.html" }, "termsOfService": "http://swagger.io/terms/", "title": "1Panel", "version": "2.0" }, "host": "", "basePath": "/api/v2", "paths": { "/ai/accounts": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountCreateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create model account", "tags": [ "AI" ] } }, "/ai/accounts/counts": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountProviderCountReq" } } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Count model accounts by provider", "tags": [ "AI" ] } }, "/ai/accounts/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete model account", "tags": [ "AI" ] } }, "/ai/accounts/models": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountModelReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentAccountModel" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List model account models", "tags": [ "AI" ] } }, "/ai/accounts/models/create": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountModelCreateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create model account model", "tags": [ "AI" ] } }, "/ai/accounts/models/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountModelDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete model account model", "tags": [ "AI" ] } }, "/ai/accounts/models/discover": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountModelDiscoverReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentAccountModel" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Discover custom provider models", "tags": [ "AI" ] } }, "/ai/accounts/models/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountModelUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update model account model", "tags": [ "AI" ] } }, "/ai/accounts/providers": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ProviderInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get model account providers", "tags": [ "AI" ] } }, "/ai/accounts/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page model accounts", "tags": [ "AI" ] } }, "/ai/accounts/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update model account", "tags": [ "AI" ] } }, "/ai/accounts/verify": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentAccountVerifyReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Verify model account", "tags": [ "AI" ] } }, "/ai/agents": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentCreateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentItem" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Agent", "tags": [ "AI" ] } }, "/ai/agents/agent/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleBindReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind Agent role channel", "tags": [ "AI" ] } }, "/ai/agents/agent/channels": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleChannelsReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentRoleChannelItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent role channels from config file", "tags": [ "AI" ] } }, "/ai/agents/agent/create": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleCreateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentRoleCreateResp" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Agent role", "tags": [ "AI" ] } }, "/ai/agents/agent/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Agent role", "tags": [ "AI" ] } }, "/ai/agents/agent/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentConfiguredAgentsReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentConfiguredAgentItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get configured Agent roles from config file", "tags": [ "AI" ] } }, "/ai/agents/agent/md/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleMarkdownFilesReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentRoleMarkdownFileItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent role markdown files", "tags": [ "AI" ] } }, "/ai/agents/agent/md/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleMarkdownFilesUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent role markdown file", "tags": [ "AI" ] } }, "/ai/agents/agent/unbind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRoleBindReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Unbind Agent role channel", "tags": [ "AI" ] } }, "/ai/agents/batch/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentBatchInstallReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentItem" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch install Agent", "tags": [ "AI" ] } }, "/ai/agents/batch/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentBatchOperateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentBatchOperateResult" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch operate Agent", "tags": [ "AI" ] } }, "/ai/agents/batch/skill/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentBatchSkillInstallReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentBatchSkillInstallResult" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch install Agent Skill", "tags": [ "AI" ] } }, "/ai/agents/batch/upgrade": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentBatchUpgradeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentBatchUpgradeResult" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch upgrade Agent", "tags": [ "AI" ] } }, "/ai/agents/channel/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentChannelDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Agent channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/dingtalk/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentDingTalkConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent DingTalk channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/dingtalk/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentDingTalkConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent DingTalk channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/discord/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentDiscordConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Discord channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/discord/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentDiscordConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent Discord channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/feishu/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentFeishuConfigReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentFeishuConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Feishu channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/feishu/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentFeishuConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent Feishu channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/pairing/approve": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentChannelPairingApproveReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Approve Agent channel pairing code", "tags": [ "AI" ] } }, "/ai/agents/channel/qqbot/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentQQBotConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent QQ Bot channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/qqbot/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentQQBotConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent QQ Bot channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/telegram/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentTelegramConfigReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentTelegramConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Telegram channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/telegram/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentTelegramConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent Telegram channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/wecom/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentWecomConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent QQ Bot channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/wecom/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentWecomConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent WeCom channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/weixin/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentWeixinConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Weixin channel config", "tags": [ "AI" ] } }, "/ai/agents/channel/weixin/login": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentWeixinLoginReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Login Agent Weixin channel", "tags": [ "AI" ] } }, "/ai/agents/config-file/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentConfigFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentConfigFile" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent config file", "tags": [ "AI" ] } }, "/ai/agents/config-file/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentConfigFileUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent config file", "tags": [ "AI" ] } }, "/ai/agents/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Agent", "tags": [ "AI" ] } }, "/ai/agents/delete/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppResource" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete check Agent", "tags": [ "AI" ] } }, "/ai/agents/hermes/chat/sessions": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentHermesChatSessionItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Hermes chat sessions", "tags": [ "AI" ] } }, "/ai/agents/hermes/chat/sessions/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentHermesChatSessionDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Hermes chat session", "tags": [ "AI" ] } }, "/ai/agents/hermes/chat/sessions/rename": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentHermesChatSessionRenameReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Rename Hermes chat session", "tags": [ "AI" ] } }, "/ai/agents/model/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentModelConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent model config", "tags": [ "AI" ] } }, "/ai/agents/model/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentModelConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent model config", "tags": [ "AI" ] } }, "/ai/agents/other/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentOtherConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Other config", "tags": [ "AI" ] } }, "/ai/agents/other/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentOtherConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent Other config", "tags": [ "AI" ] } }, "/ai/agents/overview": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentOverviewReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentOverview" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent overview", "tags": [ "AI" ] } }, "/ai/agents/plugin/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginCheckReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentPluginStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check Agent plugin installation status", "tags": [ "AI" ] } }, "/ai/agents/plugin/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginInstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install Agent plugin", "tags": [ "AI" ] } }, "/ai/agents/plugin/uninstall": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginUninstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Uninstall Agent plugin", "tags": [ "AI" ] } }, "/ai/agents/plugin/upgrade": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginUpgradeReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upgrade Agent plugin", "tags": [ "AI" ] } }, "/ai/agents/plugins/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginMarketInstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install an OpenClaw marketplace plugin", "tags": [ "AI" ] } }, "/ai/agents/plugins/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginsReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentPluginItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List OpenClaw plugins", "tags": [ "AI" ] } }, "/ai/agents/plugins/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginOperateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate an OpenClaw plugin", "tags": [ "AI" ] } }, "/ai/agents/plugins/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentPluginSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentPluginSearchItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search OpenClaw plugins", "tags": [ "AI" ] } }, "/ai/agents/remark": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentRemarkUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent remark", "tags": [ "AI" ] } }, "/ai/agents/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page Agents", "tags": [ "AI" ] } }, "/ai/agents/security/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AgentSecurityConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Agent Security config", "tags": [ "AI" ] } }, "/ai/agents/security/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSecurityConfigUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent Security config", "tags": [ "AI" ] } }, "/ai/agents/skills/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSkillInstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install Agent skill", "tags": [ "AI" ] } }, "/ai/agents/skills/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentSkillItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List Agent skills", "tags": [ "AI" ] } }, "/ai/agents/skills/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSkillSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AgentSkillSearchItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search Agent skills", "tags": [ "AI" ] } }, "/ai/agents/skills/uninstall": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSkillUninstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Uninstall Agent skill", "tags": [ "AI" ] } }, "/ai/agents/skills/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSkillUpdateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Agent skill status", "tags": [ "AI" ] } }, "/ai/agents/token/reset": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentTokenResetReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Reset Agent token", "tags": [ "AI" ] } }, "/ai/agents/website/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentWebsiteBindReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind Agent website", "tags": [ "AI" ] } }, "/ai/agents/website/unbind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentIDReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Unbind Agent website", "tags": [ "AI" ] } }, "/ai/domain/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaBindDomain" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind domain", "tags": [ "AI" ] } }, "/ai/domain/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaBindDomainReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.OllamaBindDomainRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get bind domain", "tags": [ "AI" ] } }, "/ai/domain/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaBindDomain" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update bind domain", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "domain" ], "formatEN": "update Ollama bind domain [domain]", "formatZH": "更新 Ollama 绑定域名 [domain]", "paramKeys": [] } } }, "/ai/gpu/load": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load gpu / xpu info", "tags": [ "AI" ] } }, "/ai/gpu/options": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get CPU options", "tags": [ "AI" ] } }, "/ai/gpu/search": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MonitorGPUSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.MonitorGPUData" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load monitor data", "tags": [ "Monitor" ] } }, "/ai/mcp/domain/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpBindDomain" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind Domain for mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/domain/get": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.McpBindDomainRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get bin Domain for mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/domain/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpBindDomainUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update bind Domain for mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.McpServersRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List mcp servers", "tags": [ "McpServer" ] } }, "/ai/mcp/server": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/server/connection/test": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerConnectionTest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.McpServerConnectionTestRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Test mcp server connection", "tags": [ "McpServer" ] } }, "/ai/mcp/server/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/server/detail": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerDetail" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.McpServerDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mcp server detail", "tags": [ "McpServer" ] } }, "/ai/mcp/server/op": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate mcp server", "tags": [ "McpServer" ] } }, "/ai/mcp/server/status/sync": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerStatusSync" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.McpServerStatusDTO" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync mcp server status", "tags": [ "McpServer" ] } }, "/ai/mcp/server/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.McpServerUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update mcp server", "tags": [ "McpServer" ] } }, "/ai/ollama/close": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaModelName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Close Ollama model conn", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "close conn for Ollama model [name]", "formatZH": "关闭 Ollama 模型连接 [name]", "paramKeys": [] } } }, "/ai/ollama/model": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaModelName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Ollama model", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "add Ollama model [name]", "formatZH": "添加 Ollama 模型 [name]", "paramKeys": [] } } }, "/ai/ollama/model/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ForceDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Ollama model", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [ { "db": "ollama_models", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "remove Ollama model [names]", "formatZH": "删除 Ollama 模型 [names]", "paramKeys": [] } } }, "/ai/ollama/model/load": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaModelName" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page Ollama models", "tags": [ "AI" ] } }, "/ai/ollama/model/recreate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OllamaModelName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Rereate Ollama model", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "re-add Ollama model [name]", "formatZH": "添加 Ollama 模型重试 [name]", "paramKeys": [] } } }, "/ai/ollama/model/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page Ollama models", "tags": [ "AI" ] } }, "/ai/ollama/model/sync": { "post": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.OllamaModelDropList" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync Ollama model list", "tags": [ "AI" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "sync Ollama model list", "formatZH": "同步 Ollama 模型列表", "paramKeys": [] } } }, "/ai/tensorrt/create": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TensorRTLLMCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create TensorRT LLM", "tags": [ "TensorRT LLM" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create TensorRT LLM [name]", "formatZH": "创建 TensorRT LLM [name]", "paramKeys": [] } } }, "/ai/tensorrt/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TensorRTLLMDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete TensorRT LLM", "tags": [ "TensorRT LLM" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id" ], "formatEN": "delete TensorRT LLM [id]", "formatZH": "删除 TensorRT LLM [id]", "paramKeys": [] } } }, "/ai/tensorrt/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TensorRTLLMOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate TensorRT LLM", "tags": [ "TensorRT LLM" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id", "operate" ], "formatEN": "operate TensorRT LLM [id][operate]", "formatZH": "操作 TensorRT LLM [id][operate]", "paramKeys": [] } } }, "/ai/tensorrt/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TensorRTLLMSearch" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page TensorRT LLMs", "tags": [ "TensorRT LLM" ] } }, "/ai/tensorrt/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TensorRTLLMUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update TensorRT LLM", "tags": [ "TensorRT LLM" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id", "name" ], "formatEN": "update TensorRT LLM [id][name]", "formatZH": "更新 TensorRT LLM [id][name]", "paramKeys": [] } } }, "/alert": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create alert", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "title" ], "formatEN": "create alert [title]", "formatZH": "创建告警任务 [title]", "paramKeys": [] } } }, "/alert/clams/list": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get clams", "tags": [ "Alert" ] } }, "/alert/config/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DeleteRequest" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete alert config", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id" ], "formatEN": "delete alert config [id]", "formatZH": "删除告警配置 [id]", "paramKeys": [] } } }, "/alert/config/info": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get alert config", "tags": [ "Alert" ] } }, "/alert/config/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertConfigPageReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page alert config", "tags": [ "Alert" ] } }, "/alert/config/test": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertConfigTest" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Test alert config", "tags": [ "Alert" ] } }, "/alert/config/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update alert config", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id", "displayName" ], "formatEN": "update alert config [id][displayName]", "formatZH": "更新告警配置 [id][displayName]", "paramKeys": [] } } }, "/alert/cronjob/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronJobReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get cron jobs", "tags": [ "Alert" ] } }, "/alert/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DeleteRequest" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete alert", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id" ], "formatEN": "delete alert [id]", "formatZH": "删除告警任务 [id]", "paramKeys": [] } } }, "/alert/disks/list": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get disks", "tags": [ "Alert" ] } }, "/alert/logs/clean": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean alert logs", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "clean alert logs", "formatZH": "清空告警日志", "paramKeys": [] } } }, "/alert/logs/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertLogSearch" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page alert logs", "tags": [ "Alert" ] } }, "/alert/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertSearch" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page alert", "tags": [ "Alert" ] } }, "/alert/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertUpdateStatus" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update alert status", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id", "status" ], "formatEN": "update alert [id] status [status]", "formatZH": "更新告警任务 [id] 状态 [status]", "paramKeys": [] } } }, "/alert/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AlertUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update alert", "tags": [ "Alert" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "title" ], "formatEN": "update alert [title]", "formatZH": "更新告警任务 [title]", "paramKeys": [] } } }, "/apps/:key": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "app key", "in": "path", "name": "key", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app by key", "tags": [ "App" ] } }, "/apps/checkupdate": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppUpdateRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get app list update", "tags": [ "App" ] } }, "/apps/detail/:appId/:version/:type": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "app id", "in": "path", "name": "appId", "required": true, "type": "integer" }, { "description": "app 版本", "in": "path", "name": "version", "required": true, "type": "string" }, { "description": "app 类型", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppDetailDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app detail by appid", "tags": [ "App" ] } }, "/apps/detail/node/:appKey/:version": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "app key", "in": "path", "name": "appKey", "required": true, "type": "string" }, { "description": "app version", "in": "path", "name": "version", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppDetailSimpleDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app detail by appkey and version", "tags": [ "App" ] } }, "/apps/details/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppDetailDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get app detail by id", "tags": [ "App" ] } }, "/apps/icon/:key": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "app key", "in": "path", "name": "key", "required": true, "type": "string" } ], "responses": { "200": { "description": "app icon", "schema": { "type": "file" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get app icon by app_id", "tags": [ "App" ] } }, "/apps/ignored/cancel": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.ReqWithID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Cancel Ignore Upgrade App", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Cancel ignore application upgrade", "formatZH": "取消忽略应用升级", "paramKeys": [] } } }, "/apps/ignored/detail": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/model.AppIgnoreUpgrade" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List Upgrade Ignored App", "tags": [ "App" ] } }, "/apps/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstallCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.AppInstall" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install app", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Install app [name]", "formatZH": "安装应用 [name]", "paramKeys": [] } } }, "/apps/installed/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstalledInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppInstalledCheck" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check app installed", "tags": [ "App" ] } }, "/apps/installed/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search default config by key", "tags": [ "App" ] } }, "/apps/installed/config/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update app config", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "installID", "webUI" ], "formatEN": "Application config update [installID]", "formatZH": "应用配置更新 [installID]", "paramKeys": [] } } }, "/apps/installed/conninfo": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.DatabaseConn" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app password by key", "tags": [ "App" ] } }, "/apps/installed/delete/check/:appInstallId": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "App install id", "in": "path", "name": "appInstallId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppResource" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before delete", "tags": [ "App" ] } }, "/apps/installed/ignore": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppIgnoreUpgradeReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Ignore Upgrade App", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Ignore application upgrade", "formatZH": "忽略应用升级", "paramKeys": [] } } }, "/apps/installed/info/:appInstallId": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "App install id", "in": "path", "name": "appInstallId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AppInstallInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get app install info", "tags": [ "App" ] } }, "/apps/installed/list": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppInstallInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List app installed", "tags": [ "App" ] } }, "/apps/installed/loadport": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app port by key", "tags": [ "App" ] } }, "/apps/installed/op": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstalledOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate installed app", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [ { "db": "app_installs", "input_column": "id", "input_value": "installId", "isList": false, "output_column": "app_id", "output_value": "appId" }, { "db": "app_installs", "input_column": "id", "input_value": "installId", "isList": false, "output_column": "name", "output_value": "appName" }, { "db": "apps", "input_column": "id", "input_value": "appId", "isList": false, "output_column": "key", "output_value": "appKey" } ], "bodyKeys": [ "installId", "operate" ], "formatEN": "[operate] App [appKey][appName]", "formatZH": "[operate] 应用 [appKey][appName]", "paramKeys": [] } } }, "/apps/installed/params/:appInstallId": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "appInstallId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search params by appInstallId", "tags": [ "App" ] } }, "/apps/installed/params/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstalledUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change app params", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [ { "db": "app_installs", "input_column": "id", "input_value": "installId", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "installId" ], "formatEN": "Application param update [name]", "formatZH": "应用参数修改 [name]", "paramKeys": [] } } }, "/apps/installed/port/change": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PortUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change app port", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "name", "port" ], "formatEN": "Application port update [key]-[name] =\u003e [port]", "formatZH": "应用端口修改 [key]-[name] =\u003e [port]", "paramKeys": [] } } }, "/apps/installed/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstalledSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page app installed", "tags": [ "App" ] } }, "/apps/installed/sort/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppInstallSort" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update app install sort", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "update installed app sort", "formatZH": "更新已安装应用排序", "paramKeys": [] } } }, "/apps/installed/sync": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync app installed", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Sync the list of installed apps", "formatZH": "同步已安装应用列表", "paramKeys": [] } } }, "/apps/installed/update/versions": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppVersion" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app update version by install id", "tags": [ "App" ] } }, "/apps/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.AppSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.AppRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List apps", "tags": [ "App" ] } }, "/apps/services/:key": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "key", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.AppService" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search app service by key", "tags": [ "App" ] } }, "/apps/sync/local": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync local app list", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "App store synchronization", "formatZH": "应用商店同步", "paramKeys": [] } } }, "/apps/sync/remote": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync remote app list", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "App store synchronization", "formatZH": "应用商店同步", "paramKeys": [] } } }, "/apps/tags": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get app tags", "tags": [ "App" ] } }, "/backups": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "create backup account [type]", "formatZH": "创建备份账号 [type]", "paramKeys": [] } } }, "/backups/backup": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommonBackup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Backup system data", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type", "name", "detailName" ], "formatEN": "backup [type] data [name][detailName]", "formatZH": "备份 [type] 数据 [name][detailName]", "paramKeys": [] } } }, "/backups/buckets": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ForBuckets" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List buckets", "tags": [ "Backup Account" ] } }, "/backups/check/{name}": { "get": { "parameters": [ { "description": "name", "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check backup used", "tags": [ "Backup Account" ] } }, "/backups/conn/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check backup account", "tags": [ "Backup Account" ] } }, "/backups/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [ { "db": "backup_accounts", "input_column": "id", "input_value": "id", "isList": false, "output_column": "type", "output_value": "types" } ], "bodyKeys": [ "id" ], "formatEN": "delete backup account [types]", "formatZH": "删除备份账号 [types]", "paramKeys": [] } } }, "/backups/local": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "get local backup dir", "tags": [ "Backup Account" ] } }, "/backups/options": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.BackupOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load backup account options", "tags": [ "Backup Account" ] } }, "/backups/record/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete backup record", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [ { "db": "backup_records", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "file_name", "output_value": "files" } ], "bodyKeys": [ "ids" ], "formatEN": "delete backup records [files]", "formatZH": "删除备份记录 [files]", "paramKeys": [] } } }, "/backups/record/description/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update backup record description", "tags": [ "Backup Account" ] } }, "/backups/record/download": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DownloadRecord" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download backup record", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "source", "fileName" ], "formatEN": "download backup records [source][fileName]", "formatZH": "下载备份记录 [source][fileName]", "paramKeys": [] } } }, "/backups/record/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RecordSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page backup records", "tags": [ "Backup Account" ] } }, "/backups/record/search/bycronjob": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RecordSearchByCronjob" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page backup records by cronjob", "tags": [ "Backup Account" ] } }, "/backups/record/size": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchForSize" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.RecordFileSize" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load backup record size", "tags": [ "Backup Account" ] } }, "/backups/recover": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommonRecover" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Recover system data", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type", "name", "detailName", "file" ], "formatEN": "recover [type] data [name][detailName] from [file]", "formatZH": "从 [file] 恢复 [type] 数据 [name][detailName]", "paramKeys": [] } } }, "/backups/recover/byupload": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommonRecover" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Recover system data by upload", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type", "name", "detailName", "file" ], "formatEN": "recover [type] data [name][detailName] from [file]", "formatZH": "从 [file] 恢复 [type] 数据 [name][detailName]", "paramKeys": [] } } }, "/backups/refresh/token": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Refresh token", "tags": [ "Backup Account" ] } }, "/backups/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchPageWithType" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search backup accounts with page", "tags": [ "Backup Account" ] } }, "/backups/search/files": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List files from backup accounts", "tags": [ "Backup Account" ] } }, "/backups/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "update backup account [type]", "formatZH": "更新备份账号 [type]", "paramKeys": [] } } }, "/backups/upload": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UploadForRecover" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload file for recover", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "filePath" ], "formatEN": "upload backup file [filePath]", "formatZH": "上传备份文件 [filePath]", "paramKeys": [] } } }, "/containers": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "image" ], "formatEN": "create container [name][image]", "formatZH": "创建容器 [name][image]", "paramKeys": [] } } }, "/containers/clean/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean container log", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "clean container [name] logs", "formatZH": "清理容器 [name] 日志", "paramKeys": [] } } }, "/containers/commit": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerCommit" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Commit Container", "tags": [ "Container" ] } }, "/containers/compose": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create compose", "tags": [ "Container Compose" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create compose [name]", "formatZH": "创建 compose [name]", "paramKeys": [] } } }, "/containers/compose/clean/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeLogClean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean compose log", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "clean compose [name] logs", "formatZH": "清理容器编排 [name] 日志", "paramKeys": [] } } }, "/containers/compose/env": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FilePath" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load compose environment variables", "tags": [ "Container Compose" ] } }, "/containers/compose/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeOperation" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate compose", "tags": [ "Container Compose" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "operation" ], "formatEN": "compose [operation] [name]", "formatZH": "compose [operation] [name]", "paramKeys": [] } } }, "/containers/compose/pin": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposePin" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Pin compose", "tags": [ "Container Compose" ] } }, "/containers/compose/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page composes", "tags": [ "Container Compose" ] } }, "/containers/compose/test": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Test compose", "tags": [ "Container Compose" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "check compose [name]", "formatZH": "检测 compose [name] 格式", "paramKeys": [] } } }, "/containers/compose/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update compose", "tags": [ "Container Compose" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "update compose information [name]", "formatZH": "更新 compose [name]", "paramKeys": [] } } }, "/containers/daemonjson": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DaemonJsonConf" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load docker daemon.json", "tags": [ "Container Docker" ] } }, "/containers/daemonjson/file": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load docker daemon.json", "tags": [ "Container Docker" ] } }, "/containers/daemonjson/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update docker daemon.json", "tags": [ "Container Docker" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "Updated configuration [key]", "formatZH": "更新配置 [key]", "paramKeys": [] } } }, "/containers/daemonjson/update/byfile": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DaemonJsonUpdateByFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update docker daemon.json by upload file", "tags": [ "Container Docker" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Updated configuration file", "formatZH": "更新配置文件", "paramKeys": [] } } }, "/containers/docker/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DockerOperation" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate docker", "tags": [ "Container Docker" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] docker service", "formatZH": "docker 服务 [operation]", "paramKeys": [] } } }, "/containers/docker/status": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DockerStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load docker status", "tags": [ "Container Docker" ] } }, "/containers/download/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerLog" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download container logs", "tags": [ "Container" ] } }, "/containers/files/content": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ContainerFileContent" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get container file content", "tags": [ "Container" ] } }, "/containers/files/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerFileBatchDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete container file", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "containerID", "paths" ], "formatEN": "Delete files [paths] in container [containerID]", "formatZH": "删除容器 [containerID] 文件 [paths]", "paramKeys": [] } } }, "/containers/files/download": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerFileReq" } } ], "responses": {}, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download container file", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "containerID", "path" ], "formatEN": "Download file [path] from container [containerID]", "formatZH": "下载容器 [containerID] 文件 [path]", "paramKeys": [] } } }, "/containers/files/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ContainerFileInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List container files", "tags": [ "Container" ] } }, "/containers/files/size": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "int" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get container file size", "tags": [ "Container" ] } }, "/containers/files/upload": { "post": { "consumes": [ "multipart/form-data" ], "parameters": [ { "description": "containerID", "in": "formData", "name": "containerID", "required": true, "type": "string" }, { "description": "path", "in": "formData", "name": "path", "required": true, "type": "string" }, { "description": "file", "in": "formData", "name": "file", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload container file", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "containerID", "path" ], "formatEN": "Upload file to [path] in container [containerID]", "formatZH": "容器 [containerID] 上传文件到 [path]", "paramKeys": [] } } }, "/containers/image": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.Options" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "load images options", "tags": [ "Container Image" ] } }, "/containers/image/all": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ImageInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List all images", "tags": [ "Container Image" ] } }, "/containers/image/build": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageBuild" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Build image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "build image [name]", "formatZH": "构建镜像 [name]", "paramKeys": [] } } }, "/containers/image/load": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageLoad" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "load image from [path]", "formatZH": "从 [path] 加载镜像", "paramKeys": [] } } }, "/containers/image/pull": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImagePull" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Pull image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [ { "db": "image_repos", "input_column": "id", "input_value": "repoID", "isList": false, "output_column": "name", "output_value": "reponame" } ], "bodyKeys": [ "repoID", "imageName" ], "formatEN": "image pull [reponame][imageName]", "formatZH": "镜像拉取 [reponame][imageName]", "paramKeys": [] } } }, "/containers/image/push": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImagePush" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Push image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [ { "db": "image_repos", "input_column": "id", "input_value": "repoID", "isList": false, "output_column": "name", "output_value": "reponame" } ], "bodyKeys": [ "repoID", "tagName", "name" ], "formatEN": "push [tagName] to [reponame][name]", "formatZH": "[tagName] 推送到 [reponame][name]", "paramKeys": [] } } }, "/containers/image/remove": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "names" ], "formatEN": "remove image [names]", "formatZH": "移除镜像 [names]", "paramKeys": [] } } }, "/containers/image/save": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageSave" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Save image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "tagName", "path", "name" ], "formatEN": "save [tagName] as [path]/[name]", "formatZH": "保留 [tagName] 为 [path]/[name]", "paramKeys": [] } } }, "/containers/image/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageImage" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page images", "tags": [ "Container Image" ] } }, "/containers/image/tag": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageTag" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Tag image", "tags": [ "Container Image" ], "x-panel-log": { "BeforeFunctions": [ { "db": "image_repos", "input_column": "id", "input_value": "repoID", "isList": false, "output_column": "name", "output_value": "reponame" } ], "bodyKeys": [ "repoID", "targetName" ], "formatEN": "tag image [reponame][targetName]", "formatZH": "tag 镜像 [reponame][targetName]", "paramKeys": [] } } }, "/containers/info": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ContainerOperate" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load container info", "tags": [ "Container" ] } }, "/containers/inspect": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.InspectReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Container inspect", "tags": [ "Container" ] } }, "/containers/ipv6option/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.LogOption" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update docker daemon.json ipv6 option", "tags": [ "Container Docker" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Updated the ipv6 option", "formatZH": "更新 ipv6 配置", "paramKeys": [] } } }, "/containers/item/stats": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ContainerItemStats" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load container stats size", "tags": [ "Container" ] } }, "/containers/limit": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ResourceLimit" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load container limits", "tags": [ "Container" ] } }, "/containers/list": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ContainerOptions" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List containers", "tags": [ "Container" ] } }, "/containers/list/byimage": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ContainerOptions" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List containers by image", "tags": [ "Container" ] } }, "/containers/list/stats": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ContainerListStats" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load container stats", "tags": [ "Container" ] } }, "/containers/logoption/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.LogOption" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update docker daemon.json log option", "tags": [ "Container Docker" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Updated the log option", "formatZH": "更新日志配置", "paramKeys": [] } } }, "/containers/network": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.Options" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List networks", "tags": [ "Container Network" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.NetworkCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create network", "tags": [ "Container Network" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create container network [name]", "formatZH": "创建容器网络 name", "paramKeys": [] } } }, "/containers/network/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete network", "tags": [ "Container Network" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "names" ], "formatEN": "delete container network [names]", "formatZH": "删除容器网络 [names]", "paramKeys": [] } } }, "/containers/network/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page networks", "tags": [ "Container Network" ] } }, "/containers/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerOperation" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "names", "operation" ], "formatEN": "container [operation] [names]", "formatZH": "容器 [names] 执行 [operation]", "paramKeys": [] } } }, "/containers/prune": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerPrune" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "pruneType" ], "formatEN": "clean container [pruneType]", "formatZH": "清理容器 [pruneType]", "paramKeys": [] } } }, "/containers/rename": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerRename" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Rename Container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "newName" ], "formatEN": "rename container [name] =\u003e [newName]", "formatZH": "容器重命名 [name] =\u003e [newName]", "paramKeys": [] } } }, "/containers/repo": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ImageRepoOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List image repos", "tags": [ "Container Image-repo" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageRepoDelete" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create image repo", "tags": [ "Container Image-repo" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create image repo [name]", "formatZH": "创建镜像仓库 [name]", "paramKeys": [] } } }, "/containers/repo/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete image repo", "tags": [ "Container Image-repo" ], "x-panel-log": { "BeforeFunctions": [ { "db": "image_repos", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "delete image repo [name]", "formatZH": "删除镜像仓库 [name]", "paramKeys": [] } } }, "/containers/repo/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page image repos", "tags": [ "Container Image-repo" ] } }, "/containers/repo/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load repo status", "tags": [ "Container Image-repo" ] } }, "/containers/repo/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ImageRepoUpdate" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update image repo", "tags": [ "Container Image-repo" ], "x-panel-log": { "BeforeFunctions": [ { "db": "image_repos", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "update image repo information [name]", "formatZH": "更新镜像仓库 [name]", "paramKeys": [] } } }, "/containers/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageContainer" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page containers", "tags": [ "Container" ] } }, "/containers/search/log": { "get": { "parameters": [ { "description": "容器名称", "in": "query", "name": "container", "type": "string" }, { "description": "时间筛选", "in": "query", "name": "since", "type": "string" }, { "description": "是否追踪", "in": "query", "name": "follow", "type": "string" }, { "description": "显示行号", "in": "query", "name": "tail", "type": "string" }, { "description": "是否显示时间", "in": "query", "name": "timestamp", "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Container logs", "tags": [ "Container" ] } }, "/containers/stats/:id": { "get": { "parameters": [ { "description": "容器id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ContainerStats" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Container stats", "tags": [ "Container" ] } }, "/containers/status": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ContainerStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load containers status", "tags": [ "Container" ] } }, "/containers/template": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ComposeTemplateInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List compose templates", "tags": [ "Container Compose-template" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeTemplateCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create compose template", "tags": [ "Container Compose-template" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create compose template [name]", "formatZH": "创建 compose 模版 [name]", "paramKeys": [] } } }, "/containers/template/batch": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeTemplateBatch" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bacth compose template", "tags": [ "Container Compose-template" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "batch import compose templates", "formatZH": "批量导入编排模版", "paramKeys": [] } } }, "/containers/template/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete compose template", "tags": [ "Container Compose-template" ], "x-panel-log": { "BeforeFunctions": [ { "db": "compose_templates", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete compose template [names]", "formatZH": "删除 compose 模版 [names]", "paramKeys": [] } } }, "/containers/template/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page compose templates", "tags": [ "Container Compose-template" ] } }, "/containers/template/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ComposeTemplateUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update compose template", "tags": [ "Container Compose-template" ], "x-panel-log": { "BeforeFunctions": [ { "db": "compose_templates", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "update compose template information [name]", "formatZH": "更新 compose 模版 [name]", "paramKeys": [] } } }, "/containers/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "image" ], "formatEN": "update container [name][image]", "formatZH": "更新容器 [name][image]", "paramKeys": [] } } }, "/containers/upgrade": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ContainerUpgrade" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upgrade container", "tags": [ "Container" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "names", "image" ], "formatEN": "upgrade container image [names][image]", "formatZH": "更新容器镜像 [names][image]", "paramKeys": [] } } }, "/containers/users": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load container users", "tags": [ "Container" ] } }, "/containers/volume": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.Options" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List volumes", "tags": [ "Container Volume" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.VolumeCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create volume", "tags": [ "Container Volume" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create container volume [name]", "formatZH": "创建容器存储卷 [name]", "paramKeys": [] } } }, "/containers/volume/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete volume", "tags": [ "Container Volume" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "names" ], "formatEN": "delete container volume [names]", "formatZH": "删除容器存储卷 [names]", "paramKeys": [] } } }, "/containers/volume/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page volumes", "tags": [ "Container Volume" ] } }, "/core/auth/api/generate": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "generate api key", "tags": [ "Auth" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "generate api key", "formatZH": "生成 API 接口密钥", "paramKeys": [] } } }, "/core/auth/api/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ApiInterfaceConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update api config", "tags": [ "Auth" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "ipWhiteList", "apiTrustedProxies" ], "formatEN": "update api config =\u003e IP Allowlist: [ipWhiteList], API Trusted Proxies: [apiTrustedProxies]", "formatZH": "更新 API 接口配置 =\u003e IP 白名单: [ipWhiteList], API 可信代理: [apiTrustedProxies]", "paramKeys": [] } } }, "/core/auth/captcha": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CaptchaResponse" } } }, "summary": "Load captcha", "tags": [ "Auth" ] } }, "/core/auth/current": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CurrentUserInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load current user info", "tags": [ "Auth" ] } }, "/core/auth/current/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CurrentUserUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update current user info", "tags": [ "Auth" ] } }, "/core/auth/expired/reset": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PasswordUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Reset system password expired", "tags": [ "Auth" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "reset an expired Password", "formatZH": "重置过期密码", "paramKeys": [] } } }, "/core/auth/login": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "安全入口 base64 加密串", "in": "header", "name": "EntranceCode", "required": true, "type": "string" }, { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Login" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UserLoginInfo" } } }, "summary": "User login", "tags": [ "Auth" ] } }, "/core/auth/logout": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "User logout", "tags": [ "Auth" ] } }, "/core/auth/mfa": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MfaCredential" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/mfa.Otp" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mfa info", "tags": [ "System Setting" ] } }, "/core/auth/mfa/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MfaCredential" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind mfa", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "bind mfa", "formatZH": "mfa 绑定", "paramKeys": [] } } }, "/core/auth/mfa/close": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Close mfa", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "close mfa", "formatZH": "mfa 关闭", "paramKeys": [] } } }, "/core/auth/mfalogin": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MFALogin" } } ], "responses": { "200": { "description": "OK", "headers": { "EntranceCode": { "description": "安全入口", "type": "string" } }, "schema": { "$ref": "#/definitions/dto.UserLoginInfo" } } }, "summary": "User login with mfa", "tags": [ "Auth" ] } }, "/core/auth/passkey/begin": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PasskeyBeginResponse" } } }, "summary": "User login with passkey", "tags": [ "Auth" ] } }, "/core/auth/passkey/del": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete passkey", "tags": [ "Auth" ] } }, "/core/auth/passkey/finish": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UserLoginInfo" } } }, "summary": "User login with passkey", "tags": [ "Auth" ] } }, "/core/auth/passkey/list": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.PasskeyInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List passkeys", "tags": [ "Auth" ] } }, "/core/auth/passkey/register/begin": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PasskeyRegisterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PasskeyBeginResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Begin passkey registration", "tags": [ "Auth" ] } }, "/core/auth/passkey/register/finish": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Finish passkey registration", "tags": [ "Auth" ] } }, "/core/auth/setting": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.LoginSetting" } } }, "summary": "Get Setting For Login", "tags": [ "Auth" ] } }, "/core/auth/welcome": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get welcome page", "tags": [ "Auth" ] } }, "/core/backups": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "create backup account [type]", "formatZH": "创建备份账号 [type]", "paramKeys": [] } } }, "/core/backups/client/:clientType": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "clientType", "in": "path", "name": "clientType", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.BackupClientInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load backup account base info", "tags": [ "Backup Account" ] } }, "/core/backups/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "delete backup account [name]", "formatZH": "删除备份账号 [name]", "paramKeys": [] } } }, "/core/backups/refresh/token": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByName" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Refresh token", "tags": [ "Backup Account" ] } }, "/core/backups/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BackupOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update backup account", "tags": [ "Backup Account" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "update backup account [type]", "formatZH": "更新备份账号 [type]", "paramKeys": [] } } }, "/core/commands": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommandOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create command", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "command" ], "formatEN": "create quick command [name][command]", "formatZH": "创建快捷命令 [name][command]", "paramKeys": [] } } }, "/core/commands/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByIDs" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete command", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [ { "db": "commands", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete quick command [names]", "formatZH": "删除快捷命令 [names]", "paramKeys": [] } } }, "/core/commands/export": { "post": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Export command", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "export quick commands", "formatZH": "导出快速命令", "paramKeys": [] } } }, "/core/commands/import": { "post": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Import command", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "import quick commands", "formatZH": "导入快速命令", "paramKeys": [] } } }, "/core/commands/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByType" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommandInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List commands", "tags": [ "Command" ] } }, "/core/commands/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page commands", "tags": [ "Command" ] } }, "/core/commands/tree": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByType" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.CommandTree" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Tree commands", "tags": [ "Command" ] } }, "/core/commands/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommandOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update command", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "update quick command [name]", "formatZH": "更新快捷命令 [name]", "paramKeys": [] } } }, "/core/commands/upload": { "post": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload command csv for list", "tags": [ "Command" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "upload quick commands with csv", "formatZH": "上传快速命令文件", "paramKeys": [] } } }, "/core/groups": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "create group [name][type]", "formatZH": "创建组 [name][type]", "paramKeys": [] } } }, "/core/groups/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [ { "db": "groups", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" }, { "db": "groups", "input_column": "id", "input_value": "id", "isList": false, "output_column": "type", "output_value": "type" } ], "bodyKeys": [ "id" ], "formatEN": "delete group [type][name]", "formatZH": "删除组 [type][name]", "paramKeys": [] } } }, "/core/groups/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.OperateByType" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List groups", "tags": [ "System Group" ] } }, "/core/groups/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "update group [name][type]", "formatZH": "更新组 [name][type]", "paramKeys": [] } } }, "/core/logs/clean": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CleanLog" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean operation logs", "tags": [ "Logs" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "logType" ], "formatEN": "Clean the [logType] log information", "formatZH": "清空 [logType] 日志信息", "paramKeys": [] } } }, "/core/logs/login": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchLgLogWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page login logs", "tags": [ "Logs" ] } }, "/core/logs/operation": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchOpLogWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page operation logs", "tags": [ "Logs" ] } }, "/core/script": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ScriptOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Add script", "tags": [ "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "add script [name]", "formatZH": "添加脚本库脚本 [name]", "paramKeys": [] } } }, "/core/script/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByIDs" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete script", "tags": [ "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [ { "db": "script_librarys", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete script [names]", "formatZH": "删除脚本库脚本 [names]", "paramKeys": [] } } }, "/core/script/run": { "get": { "parameters": [ { "description": "cols", "in": "query", "name": "cols", "type": "integer" }, { "description": "rows", "in": "query", "name": "rows", "type": "integer" }, { "description": "script_id", "in": "query", "name": "script_id", "type": "integer" }, { "description": "operateNode", "in": "query", "name": "operateNode", "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Run script", "tags": [ "ScriptLibrary" ] } }, "/core/script/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchPageWithGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page script", "tags": [ "ScriptLibrary" ] } }, "/core/script/sync": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByTaskID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync script from remote", "tags": [ "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "sync scripts", "formatZH": "同步脚本库脚本", "paramKeys": [] } } }, "/core/script/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ScriptOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update script", "tags": [ "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "update script [name]", "formatZH": "更新脚本库脚本 [name]", "paramKeys": [] } } }, "/core/settings/apps/store/config": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.AppstoreConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get appstore config", "tags": [ "App" ] } }, "/core/settings/apps/store/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AppstoreUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update appstore config", "tags": [ "App" ] } }, "/core/settings/bind/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BindInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system bind info", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "ipv6", "bindAddress" ], "formatEN": "update system bind info =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", "formatZH": "修改系统监听信息 =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", "paramKeys": [] } } }, "/core/settings/interface": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system address", "tags": [ "System Setting" ] } }, "/core/settings/memo": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load dashboard memo", "tags": [ "System Setting" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MemoUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update dashboard memo", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "update dashboard memo", "formatZH": "更新仪表盘备忘录", "paramKeys": [] } } }, "/core/settings/menu/default": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Default menu", "tags": [ "Menu Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Init menu.", "formatZH": "初始化菜单", "paramKeys": [] } } }, "/core/settings/menu/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Hide advanced feature menu.", "formatZH": "隐藏高级功能菜单", "paramKeys": [] } } }, "/core/settings/port/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PortUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system port", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "serverPort" ], "formatEN": "update system port =\u003e [serverPort]", "formatZH": "修改系统端口 =\u003e [serverPort]", "paramKeys": [] } } }, "/core/settings/proxy/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ProxyUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update proxy setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "proxyUrl", "proxyPort" ], "formatEN": "set proxy [proxyPort]:[proxyPort].", "formatZH": "服务器代理配置 [proxyPort]:[proxyPort]", "paramKeys": [] } } }, "/core/settings/search": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SettingInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system setting info", "tags": [ "System Setting" ] } }, "/core/settings/search/available": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system available status", "tags": [ "System Setting" ] } }, "/core/settings/search/base": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SettingBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load base system setting info", "tags": [ "System Setting" ] } }, "/core/settings/ssl/download": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download system cert", "tags": [ "System Setting" ] } }, "/core/settings/ssl/info": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SSLInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system cert info", "tags": [ "System Setting" ] } }, "/core/settings/ssl/reload": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Reload SSL", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "reload system SSL", "formatZH": "重载系统 SSL", "paramKeys": [] } } }, "/core/settings/ssl/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SSLUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system ssl", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "ssl" ], "formatEN": "update system ssl =\u003e [ssl]", "formatZH": "修改系统 ssl =\u003e [ssl]", "paramKeys": [] } } }, "/core/settings/terminal/search": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.TerminalInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system terminal setting info", "tags": [ "System Setting" ] } }, "/core/settings/terminal/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.TerminalUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system terminal setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "update system terminal setting", "formatZH": "修改系统终端配置", "paramKeys": [] } } }, "/core/settings/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update system setting [key] =\u003e [value]", "formatZH": "修改系统配置 [key] =\u003e [value]", "paramKeys": [] } } }, "/core/settings/upgrade": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpgradeInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load upgrade info", "tags": [ "System Setting" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Upgrade" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upgrade", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "version" ], "formatEN": "upgrade system =\u003e [version]", "formatZH": "更新系统 =\u003e [version]", "paramKeys": [] } } }, "/core/settings/upgrade/notes": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Upgrade" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load release notes by version", "tags": [ "System Setting" ] } }, "/core/settings/upgrade/releases": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ReleasesNotes" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load upgrade notes", "tags": [ "System Setting" ] } }, "/cronjobs": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create cronjob", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type", "name" ], "formatEN": "create cronjob [type][name]", "formatZH": "创建计划任务 [type][name]", "paramKeys": [] } } }, "/cronjobs/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobBatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete cronjob", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete cronjob [names]", "formatZH": "删除计划任务 [names]", "paramKeys": [] } } }, "/cronjobs/export": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByIDs" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Export cronjob list", "tags": [ "Cronjob" ] } }, "/cronjobs/group/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeGroup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update cronjob group", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "update cronjob group [name]", "formatZH": "更新计划任务分组 [name]", "paramKeys": [] } } }, "/cronjobs/handle": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Handle cronjob once", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "manually execute the cronjob [name]", "formatZH": "手动执行计划任务 [name]", "paramKeys": [] } } }, "/cronjobs/import": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobImport" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Import cronjob list", "tags": [ "Cronjob" ] } }, "/cronjobs/load/info": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load cronjob info", "tags": [ "Cronjob" ] } }, "/cronjobs/next": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobSpec" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load cronjob spec time", "tags": [ "Cronjob" ] } }, "/cronjobs/records/clean": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobClean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean job records", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "cronjobID", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "cronjobID" ], "formatEN": "clean cronjob [name] records", "formatZH": "清空计划任务记录 [name]", "paramKeys": [] } } }, "/cronjobs/records/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load Cronjob record log", "tags": [ "Cronjob" ] } }, "/cronjobs/script/options": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.ScriptOptions" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load script options", "tags": [ "Cronjob" ] } }, "/cronjobs/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageCronjob" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page cronjobs", "tags": [ "Cronjob" ] } }, "/cronjobs/search/records": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchRecord" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page job records", "tags": [ "Cronjob" ] } }, "/cronjobs/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobUpdateStatus" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update cronjob status", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "status" ], "formatEN": "change the status of cronjob [name] to [status].", "formatZH": "修改计划任务 [name] 状态为 [status]", "paramKeys": [] } } }, "/cronjobs/stop": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Handle stop job", "tags": [ "Cronjob" ] } }, "/cronjobs/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CronjobOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update cronjob", "tags": [ "Cronjob" ], "x-panel-log": { "BeforeFunctions": [ { "db": "cronjobs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "update cronjob [name]", "formatZH": "更新计划任务 [name]", "paramKeys": [] } } }, "/dashboard/app/launcher": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppLauncher" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load app launcher", "tags": [ "Dashboard" ] } }, "/dashboard/app/launcher/option": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchByFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.LauncherOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load app launcher options", "tags": [ "Dashboard" ] } }, "/dashboard/app/launcher/show": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update app Launcher", "tags": [ "Dashboard" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "app launcher [key] =\u003e show: [value]", "formatZH": "首页应用 [key] =\u003e 显示:[value]", "paramKeys": [] } } }, "/dashboard/base/:ioOption/:netOption": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "ioOption", "required": true, "type": "string" }, { "description": "request", "in": "path", "name": "netOption", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DashboardBase" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load dashboard base info", "tags": [ "Dashboard" ] } }, "/dashboard/base/os": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.OsInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load os info", "tags": [ "Dashboard" ] } }, "/dashboard/current/:ioOption/:netOption": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "ioOption", "required": true, "type": "string" }, { "description": "request", "in": "path", "name": "netOption", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DashboardCurrent" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load dashboard current info", "tags": [ "Dashboard" ] } }, "/dashboard/current/node": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NodeCurrent" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load dashboard current info for node", "tags": [ "Dashboard" ] } }, "/dashboard/current/top/cpu": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.Process" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load top cpu processes", "tags": [ "Dashboard" ] } }, "/dashboard/current/top/mem": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.Process" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load top memory processes", "tags": [ "Dashboard" ] } }, "/dashboard/quick/change": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeQuicks" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update quick jump", "tags": [ "Dashboard" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "change quick jump", "formatZH": "切换快速跳转", "paramKeys": [] } } }, "/dashboard/quick/option": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.QuickJump" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load quick jump options", "tags": [ "Dashboard" ] } }, "/dashboard/system/restart/:operation": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "operation", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "System restart", "tags": [ "Dashboard" ] } }, "/databases": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlDBCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create mysql database", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create mysql database [name]", "formatZH": "创建 mysql 数据库 [name]", "paramKeys": [] } } }, "/databases/change/access": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeDBInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mysql root access", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database" ], "formatEN": "Update database [database] root access", "formatZH": "更新数据库 [database] root 访问权限", "paramKeys": [] } } }, "/databases/change/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeDBInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mysql root password", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database" ], "formatEN": "Update database [database] root password", "formatZH": "更新数据库 [database] root 密码", "paramKeys": [] } } }, "/databases/common/info": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DBBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load base info", "tags": [ "Database Common" ] } }, "/databases/common/load/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load Database conf", "tags": [ "Database Common" ] } }, "/databases/common/update/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DBConfUpdateByFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update conf by upload file", "tags": [ "Database Common" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type", "database" ], "formatEN": "update the [type] [database] database configuration information", "formatZH": "更新 [type] 数据库 [database] 配置信息", "paramKeys": [] } } }, "/databases/db": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DatabaseCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create database", "tags": [ "Database" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "create database [name][type]", "formatZH": "创建远程数据库 [name][type]", "paramKeys": [] } } }, "/databases/db/:name": { "get": { "parameters": [ { "description": "name", "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DatabaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get databases", "tags": [ "Database" ] } }, "/databases/db/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DatabaseCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check database", "tags": [ "Database" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "check if database [name][type] is connectable", "formatZH": "检测远程数据库 [name][type] 连接性", "paramKeys": [] } } }, "/databases/db/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DatabaseDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete database", "tags": [ "Database" ], "x-panel-log": { "BeforeFunctions": [ { "db": "databases", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete database [names]", "formatZH": "删除远程数据库 [names]", "paramKeys": [] } } }, "/databases/db/del/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before delete remote database", "tags": [ "Database" ] } }, "/databases/db/item/:type": { "get": { "parameters": [ { "description": "type", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.DatabaseItem" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List databases", "tags": [ "Database" ] } }, "/databases/db/list/:type": { "get": { "parameters": [ { "description": "type", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.DatabaseOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List databases", "tags": [ "Database" ] } }, "/databases/db/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DatabaseSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page databases", "tags": [ "Database" ] } }, "/databases/db/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DatabaseUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update database", "tags": [ "Database" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "update database [name]", "formatZH": "更新远程数据库 [name]", "paramKeys": [] } } }, "/databases/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlDBDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete mysql database", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_mysqls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "delete mysql database [name]", "formatZH": "删除 mysql 数据库 [name]", "paramKeys": [] } } }, "/databases/del/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlDBDeleteCheck" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before delete mysql database", "tags": [ "Database Mysql" ] } }, "/databases/description/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update mysql database description", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_mysqls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "description" ], "formatEN": "The description of the mysql database [name] is modified =\u003e [description]", "formatZH": "mysql 数据库 [name] 描述信息修改 [description]", "paramKeys": [] } } }, "/databases/format/options": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.MysqlFormatCollationOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List mysql database format collation options", "tags": [ "Database Mysql" ] } }, "/databases/grants": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlGrantCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Grant mysql user", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "db", "username", "host" ], "formatEN": "grant mysql database [database] user [username]@[host] access to [db]", "formatZH": "授权 mysql 数据库 [database] 用户 [username]@[host] 访问 [db]", "paramKeys": [] } } }, "/databases/grants/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlGrantDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Revoke mysql grant", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "db", "username", "host" ], "formatEN": "revoke mysql database [database] user [username]@[host] access to [db]", "formatZH": "取消 mysql 数据库 [database] 用户 [username]@[host] 对 [db] 的授权", "paramKeys": [] } } }, "/databases/grants/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.MysqlGrant" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List mysql grants", "tags": [ "Database Mysql" ] } }, "/databases/grants/summary": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlGrantSummarySearch" } } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "items": { "$ref": "#/definitions/dto.MysqlUser" }, "type": "array" }, "type": "object" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List mysql grant summary", "tags": [ "Database Mysql" ] } }, "/databases/load": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlLoadDB" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mysql database from remote", "tags": [ "Database Mysql" ] } }, "/databases/mongodb": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbDBCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create mongodb database", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create mongodb database [name]", "formatZH": "创建 mongodb 数据库 [name]", "paramKeys": [] } } }, "/databases/mongodb/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbBind" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind mongodb database user info", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "name", "username" ], "formatEN": "bind mongodb database [database] [name] user [username]", "formatZH": "绑定 mongodb 数据库 [database] [name] 用户 [username]", "paramKeys": [] } } }, "/databases/mongodb/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbDBDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete mongodb database", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_mongodbs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "delete mongodb database [name]", "formatZH": "删除 mongodb 数据库 [name]", "paramKeys": [] } } }, "/databases/mongodb/del/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbDBDeleteCheck" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before delete mongodb database", "tags": [ "Database Mongodb" ] } }, "/databases/mongodb/description": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update mongodb database description", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_mongodbs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "description" ], "formatEN": "The description of the mongodb database [name] is modified =\u003e [description]", "formatZH": "mongodb 数据库 [name] 描述信息修改 [description]", "paramKeys": [] } } }, "/databases/mongodb/load": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbLoadDB" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mongodb database from remote", "tags": [ "Database Mongodb" ] } }, "/databases/mongodb/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbPassword" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mongodb database password", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "name" ], "formatEN": "update mongodb database [database] [name] password", "formatZH": "更新 mongodb 数据库 [database] [name] 密码", "paramKeys": [] } } }, "/databases/mongodb/privileges": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbPrivilegesLoad" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mongodb privileges", "tags": [ "Database Mongodb" ] } }, "/databases/mongodb/privileges/change": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbPrivileges" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mongodb privileges", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username" ], "formatEN": "update mongodb database [database] user [username] privileges", "formatZH": "更新 mongodb 数据库 [database] 用户 [username] 权限", "paramKeys": [] } } }, "/databases/mongodb/root/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeDBInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mongodb root password", "tags": [ "Database Mongodb" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database" ], "formatEN": "update mongodb database [database] root password", "formatZH": "更新 mongodb 数据库 [database] root 密码", "paramKeys": [] } } }, "/databases/mongodb/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MongodbDBSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page mongodb databases", "tags": [ "Database Mongodb" ] } }, "/databases/pg": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlDBCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create postgresql database", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "create postgresql database [name]", "formatZH": "创建 postgresql 数据库 [name]", "paramKeys": [] } } }, "/databases/pg/:database/load": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlLoadDB" } }, { "description": "database", "in": "path", "name": "database", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load postgresql database from remote", "tags": [ "Database PostgreSQL" ] } }, "/databases/pg/bind": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlBindUser" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Bind postgresql user", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "username" ], "formatEN": "bind postgresql database [name] user [username]", "formatZH": "绑定 postgresql 数据库 [name] 用户 [username]", "paramKeys": [] } } }, "/databases/pg/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlDBDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete postgresql database", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_postgresqls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "delete postgresql database [name]", "formatZH": "删除 postgresql 数据库 [name]", "paramKeys": [] } } }, "/databases/pg/del/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlDBDeleteCheck" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before delete postgresql database", "tags": [ "Database PostgreSQL" ] } }, "/databases/pg/description": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update postgresql database description", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_postgresqls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "description" ], "formatEN": "The description of the postgresql database [name] is modified =\u003e [description]", "formatZH": "postgresql 数据库 [name] 描述信息修改 [description]", "paramKeys": [] } } }, "/databases/pg/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeDBInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change postgresql password", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "database_postgresqls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Update database [name] password", "formatZH": "更新数据库 [name] 密码", "paramKeys": [] } } }, "/databases/pg/privileges": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeDBInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change postgresql privileges", "tags": [ "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username" ], "formatEN": "Update [username] privileges of database [database]", "formatZH": "更新数据库 [database] 用户 [username] 权限", "paramKeys": [] } } }, "/databases/pg/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PostgresqlDBSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page postgresql databases", "tags": [ "Database PostgreSQL" ] } }, "/databases/redis/check": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check has cli", "tags": [ "Database Redis" ] } }, "/databases/redis/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.LoadRedisStatus" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RedisConf" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load redis conf", "tags": [ "Database Redis" ] } }, "/databases/redis/conf/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RedisConfUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update redis conf", "tags": [ "Database Redis" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "update the redis database configuration information", "formatZH": "更新 redis 数据库配置信息", "paramKeys": [] } } }, "/databases/redis/install/cli": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install redis-cli", "tags": [ "Database Redis" ] } }, "/databases/redis/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeRedisPass" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change redis password", "tags": [ "Database Redis" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "change the password of the redis database", "formatZH": "修改 redis 数据库密码", "paramKeys": [] } } }, "/databases/redis/persistence/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.LoadRedisStatus" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RedisPersistence" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load redis persistence conf", "tags": [ "Database Redis" ] } }, "/databases/redis/persistence/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RedisConfPersistenceUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update redis persistence conf", "tags": [ "Database Redis" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "redis database persistence configuration update", "formatZH": "redis 数据库持久化配置更新", "paramKeys": [] } } }, "/databases/redis/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.LoadRedisStatus" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RedisStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load redis status info", "tags": [ "Database Redis" ] } }, "/databases/remote": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mysql remote access", "tags": [ "Database Mysql" ] } }, "/databases/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlDBSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page mysql databases", "tags": [ "Database Mysql" ] } }, "/databases/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.MysqlStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mysql status info", "tags": [ "Database Mysql" ] } }, "/databases/users": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create mysql user", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username", "host" ], "formatEN": "create mysql database [database] user [username]@[host]", "formatZH": "创建 mysql 数据库 [database] 用户 [username]@[host]", "paramKeys": [] } } }, "/databases/users/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete mysql user", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username", "host" ], "formatEN": "delete mysql database [database] user [username]@[host]", "formatZH": "删除 mysql 数据库 [database] 用户 [username]@[host]", "paramKeys": [] } } }, "/databases/users/password": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserPassword" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change mysql user password", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username", "host" ], "formatEN": "update mysql database [database] user [username]@[host] password", "formatZH": "更新 mysql 数据库 [database] 用户 [username]@[host] 密码", "paramKeys": [] } } }, "/databases/users/password/save": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserPassword" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Save mysql user password locally", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username", "host" ], "formatEN": "save mysql database [database] user [username]@[host] password locally", "formatZH": "补充 mysql 数据库 [database] 用户 [username]@[host] 密码", "paramKeys": [] } } }, "/databases/users/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.MysqlUser" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List mysql users", "tags": [ "Database Mysql" ] } }, "/databases/users/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlUserUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update mysql user", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "database", "username", "host", "newHost", "description" ], "formatEN": "update mysql database [database] user [username] access [host] =\u003e [newHost] description [description]", "formatZH": "更新 mysql 数据库 [database] 用户 [username] 访问权限 [host] =\u003e [newHost] 描述 [description]", "paramKeys": [] } } }, "/databases/variables": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.MysqlVariables" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load mysql variables info", "tags": [ "Database Mysql" ] } }, "/databases/variables/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MysqlVariablesUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update mysql variables", "tags": [ "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "adjust mysql database performance parameters", "formatZH": "调整 mysql 数据库性能参数", "paramKeys": [] } } }, "/files": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Create dir or file [path]", "formatZH": "创建文件/文件夹 [path]", "paramKeys": [] } } }, "/files/ai-search": { "post": { "consumes": [ "application/json" ], "description": "When file-management AI is enabled, returns mode=ai with summary and hits. When disabled, returns mode=grep with hits only. Scans file contents only. Supports match options, extension/size/time filters, and scan limits.", "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileAISearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileAISearchResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "File search: content grep + optional AI summary", "tags": [ "File" ] } }, "/files/batch/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FilePathsCheck" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.ExistFileInfo" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch check file exist", "tags": [ "File" ] } }, "/files/batch/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileBatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch delete file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "paths" ], "formatEN": "Batch delete dir or file [paths]", "formatZH": "批量删除文件/文件夹 [paths]", "paramKeys": [] } } }, "/files/batch/role": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileRoleReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch change file mode and owner", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "paths", "mode", "user", "group" ], "formatEN": "Batch change file mode and owner [paths] =\u003e [mode]/[user]/[group]", "formatZH": "批量修改文件权限和用户/组 [paths] =\u003e [mode]/[user]/[group]", "paramKeys": [] } } }, "/files/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FilePathCheck" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check file exist", "tags": [ "File" ] } }, "/files/chunkdownload": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileDownload" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Chunk Download file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Download file [name]", "formatZH": "下载文件 [name]", "paramKeys": [] } } }, "/files/chunkupload": { "post": { "parameters": [ { "description": "request", "in": "formData", "name": "file", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "ChunkUpload file", "tags": [ "File" ] } }, "/files/compress": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileCompress" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Compress file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Compress file [name]", "formatZH": "压缩文件 [name]", "paramKeys": [] } } }, "/files/compress/stop": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileCompressStopReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Stop compress task", "tags": [ "File" ] } }, "/files/content": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileContentReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load file content", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Load file content [path]", "formatZH": "获取文件内容 [path]", "paramKeys": [] } } }, "/files/convert": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileConvert" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Convert file", "tags": [ "File" ] } }, "/files/convert/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Convert file", "tags": [ "File" ] } }, "/files/decompress": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileDeCompress" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Decompress file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Decompress file [path]", "formatZH": "解压 [path]", "paramKeys": [] } } }, "/files/decompress/stop": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileDeCompressStopReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Stop decompress task", "tags": [ "File" ] } }, "/files/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Delete dir or file [path]", "formatZH": "删除文件/文件夹 [path]", "paramKeys": [] } } }, "/files/depth/size": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.DirSizeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.DepthDirSizeRes" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Multi file size", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Multi file size [path]", "formatZH": "获取目录及其第一层子目录文件夹大小 [path]", "paramKeys": [] } } }, "/files/download": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download file", "tags": [ "File" ] } }, "/files/favorite": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FavoriteCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.Favorite" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create favorite", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "收藏文件/文件夹 [path]", "formatZH": "收藏文件/文件夹 [path]", "paramKeys": [] } } }, "/files/favorite/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FavoriteDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete favorite", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [ { "db": "favorites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "path", "output_value": "path" } ], "bodyKeys": [ "id" ], "formatEN": "delete avorite [path]", "formatZH": "删除收藏 [path]", "paramKeys": [] } } }, "/files/favorite/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List favorites", "tags": [ "File" ] } }, "/files/history/content": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileHistoryContentReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileHistoryInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load file history content", "tags": [ "File" ] } }, "/files/history/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileHistoryDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete file history record", "tags": [ "File" ] } }, "/files/history/restore": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileHistoryRestoreReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Restore file history record", "tags": [ "File" ] } }, "/files/history/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileHistorySearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load file history list", "tags": [ "File" ] } }, "/files/mode": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change file mode", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path", "mode" ], "formatEN": "Change mode [path] =\u003e [mode]", "formatZH": "修改权限 [path] =\u003e [mode]", "paramKeys": [] } } }, "/files/mount": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DiskInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "system mount", "tags": [ "File" ] } }, "/files/move": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileMove" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Move file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "oldPaths", "newPath" ], "formatEN": "Move [oldPaths] =\u003e [newPath]", "formatZH": "移动文件 [oldPaths] =\u003e [newPath]", "paramKeys": [] } } }, "/files/move/stop": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileMoveStopReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Stop file move task", "tags": [ "File" ] } }, "/files/owner": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileRoleUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change file owner", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path", "user", "group" ], "formatEN": "Change owner [path] =\u003e [user]/[group]", "formatZH": "修改用户/组 [path] =\u003e [user]/[group]", "paramKeys": [] } } }, "/files/preview": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileContentReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Preview file content", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Preview file content [path]", "formatZH": "预览文件内容 [path]", "paramKeys": [] } } }, "/files/read/{type}": { "post": { "parameters": [ { "description": "type", "in": "path", "name": "type", "required": true, "type": "string" }, { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileReadByLineReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileLineContent" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Read file by Line", "tags": [ "File" ] } }, "/files/recycle/clear": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clear RecycleBin files", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "清空回收站", "formatZH": "清空回收站", "paramKeys": [] } } }, "/files/recycle/reduce": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RecycleBinReduce" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Reduce RecycleBin files", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Reduce RecycleBin file [name]", "formatZH": "还原回收站文件 [name]", "paramKeys": [] } } }, "/files/recycle/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List RecycleBin files", "tags": [ "File" ] } }, "/files/recycle/status": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get RecycleBin status", "tags": [ "File" ] } }, "/files/remark": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileRemarkUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Set file remark", "tags": [ "File" ] } }, "/files/remarks": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileRemarkBatch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileRemarksRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch get file remarks", "tags": [ "File" ] } }, "/files/rename": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileRename" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change file name", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "oldName", "newName" ], "formatEN": "Rename [oldName] =\u003e [newName]", "formatZH": "重命名 [oldName] =\u003e [newName]", "paramKeys": [] } } }, "/files/save": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileEdit" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update file content", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Update file content [path]", "formatZH": "更新文件内容 [path]", "paramKeys": [] } } }, "/files/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileOption" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List files", "tags": [ "File" ] } }, "/files/share/check": { "get": { "parameters": [ { "description": "share code", "in": "query", "name": "code", "required": true, "type": "string" }, { "description": "optional password", "in": "query", "name": "password", "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.Response" } } }, "summary": "Check file share code (no login)", "tags": [ "File" ] } }, "/files/share/create": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileShareCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileShareInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create temporary file share link", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path", "expireMinutes" ], "formatEN": "Create file share [path]", "formatZH": "创建文件分享 [path]", "paramKeys": [] } } }, "/files/share/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FilePath" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete file share by path", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Close file share [path]", "formatZH": "关闭文件分享 [path]", "paramKeys": [] } } }, "/files/share/detail": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FilePath" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileShareInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get file share detail by path", "tags": [ "File" ] } }, "/files/share/download": { "get": { "parameters": [ { "description": "share code", "in": "query", "name": "code", "required": true, "type": "string" }, { "description": "optional password", "in": "query", "name": "password", "type": "string" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } }, "summary": "Download file by share code (no login)", "tags": [ "File" ] } }, "/files/share/info": { "get": { "parameters": [ { "description": "share code", "in": "query", "name": "code", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileSharePublicInfo" } } }, "summary": "Get file share detail by code (no login)", "tags": [ "File" ] } }, "/files/share/qrcode": { "get": { "parameters": [ { "description": "share code", "in": "query", "name": "code", "required": true, "type": "string" }, { "description": "operate node", "in": "query", "name": "operateNode", "type": "string" } ], "produces": [ "image/png" ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get file share QR code image", "tags": [ "File" ] } }, "/files/share/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List file shares", "tags": [ "File" ] } }, "/files/size": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.DirSizeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.DirSizeRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load file size", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path" ], "formatEN": "Load file size [path]", "formatZH": "获取文件夹大小 [path]", "paramKeys": [] } } }, "/files/tree": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileOption" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.FileTree" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load files tree", "tags": [ "File" ] } }, "/files/upload": { "post": { "parameters": [ { "description": "request", "in": "formData", "name": "file", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "path", "file" ], "formatEN": "Upload file [path]/[file]", "formatZH": "上传文件 [path]/[file]", "paramKeys": [] } } }, "/files/upload/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.SearchUploadWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page file", "tags": [ "File" ] } }, "/files/user/group": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.UserGroupResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "system user and group", "tags": [ "File" ] } }, "/files/wget": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileWget" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileWgetRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Wget file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "url", "path", "name" ], "formatEN": "Download url =\u003e [path]/[name]", "formatZH": "下载 url =\u003e [path]/[name]", "paramKeys": [] } } }, "/files/wget/process": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Wget process", "tags": [ "File" ] } }, "/files/wget/process/keys": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Process keys", "tags": [ "File" ] } }, "/files/wget/stop": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileProcessReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Stop wget file download", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key" ], "formatEN": "Stop wget task [key]", "formatZH": "停止下载任务 [key]", "paramKeys": [] } } }, "/groups": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "create group [name][type]", "formatZH": "创建组 [name][type]", "paramKeys": [] } } }, "/groups/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [ { "db": "groups", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" }, { "db": "groups", "input_column": "id", "input_value": "id", "isList": false, "output_column": "type", "output_value": "type" } ], "bodyKeys": [ "id" ], "formatEN": "delete group [type][name]", "formatZH": "删除组 [type][name]", "paramKeys": [] } } }, "/groups/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.OperateByType" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List groups", "tags": [ "System Group" ] } }, "/groups/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.GroupUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update group", "tags": [ "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "type" ], "formatEN": "update group [name][type]", "formatZH": "更新组 [name][type]", "paramKeys": [] } } }, "/health/check": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check health", "tags": [ "Health" ] } }, "/hosts": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.HostOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create host", "tags": [ "Host" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "addr" ], "formatEN": "create host [name][addr]", "formatZH": "创建主机 [name][addr]", "paramKeys": [] } } }, "/hosts/components/{name}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "Component name to check (e.g., rsync, docker)", "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.ComponentInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check if a system component exists", "tags": [ "Host" ] } }, "/hosts/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByIDs" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete host", "tags": [ "Host" ], "x-panel-log": { "BeforeFunctions": [ { "db": "hosts", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete host [names]", "formatZH": "删除主机 [names]", "paramKeys": [] } } }, "/hosts/diagnostics/goroutines": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RuntimeGoroutineSnapshot" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load grouped goroutine snapshot", "tags": [ "RuntimeDiagnostics" ] } }, "/hosts/diagnostics/profiles": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RuntimeProfileCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Capture runtime profile", "tags": [ "RuntimeDiagnostics" ] } }, "/hosts/diagnostics/summary": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RuntimeDiagnosticsSummary" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load runtime diagnostics summary", "tags": [ "RuntimeDiagnostics" ] } }, "/hosts/disks": { "get": { "description": "Get information about all disks including partitioned and unpartitioned disks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.CompleteDiskInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get complete disk information", "tags": [ "Disk Management" ] } }, "/hosts/disks/mount": { "post": { "consumes": [ "application/json" ], "description": "Mount partition to specified mount point", "parameters": [ { "description": "mount request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.DiskMountRequest" } } ], "responses": { "200": { "description": "Disk mounted successfully", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Mount disk", "tags": [ "Disk Management" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "device", "mountPoint" ], "formatEN": "Mount disk [device] to [mountPoint]", "formatZH": "挂载磁盘 [device] 到 [mountPoint]", "paramKeys": [] } } }, "/hosts/disks/partition": { "post": { "consumes": [ "application/json" ], "description": "Create partition and format disk with specified filesystem", "parameters": [ { "description": "partition request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.DiskPartitionRequest" } } ], "responses": { "200": { "description": "Partition created successfully", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Partition disk", "tags": [ "Disk Management" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "device", "filesystem", "mountPoint" ], "formatEN": "Partition disk [device] with filesystem [filesystem], mount point [mountPoint]", "formatZH": "对磁盘 [device] 进行分区,文件系统 [filesystem],挂载点 [mountPoint]", "paramKeys": [] } } }, "/hosts/disks/unmount": { "post": { "consumes": [ "application/json" ], "description": "Unmount partition from mount point", "parameters": [ { "description": "unmount request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.DiskUnmountRequest" } } ], "responses": { "200": { "description": "Disk unmounted successfully", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Unmount disk", "tags": [ "Disk Management" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "device", "mountPoint" ], "formatEN": "Unmount disk [device] from [mountPoint]", "formatZH": "卸载磁盘 [device] 从 [mountPoint]", "paramKeys": [] } } }, "/hosts/firewall/base": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallSubsystemStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load firewall base info", "tags": [ "Firewall" ] } }, "/hosts/firewall/docker/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DockerPortGuardOperation" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Docker port guard", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] Docker port guard", "formatZH": "[operation] Docker 端口防护", "paramKeys": [] } } }, "/hosts/firewall/docker/policies/batch": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DockerPortGuardPolicyBatch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch upsert Docker port guard policies", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "batch update Docker port guard policies", "formatZH": "批量更新 Docker 端口防护策略", "paramKeys": [] } } }, "/hosts/firewall/docker/policies/delete/batch": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.DockerPortGuardPolicyBatchDelete" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Docker port guard policies", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "uuids" ], "formatEN": "delete Docker port guard policies [uuids]", "formatZH": "删除 Docker 端口防护策略 [uuids]", "paramKeys": [] } } }, "/hosts/firewall/docker/ports": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DockerPortGuardList" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List Docker port guard status and policies", "tags": [ "Firewall" ] } }, "/hosts/firewall/docker/sync": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync Docker port guard rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "sync Docker port guard rules", "formatZH": "同步 Docker 端口防护规则", "paramKeys": [] } } }, "/hosts/firewall/filter/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FilterChainOperation" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Apply/Unload/Init firewall filter chain", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operate" ], "formatEN": "[operate] firewall filter chain", "formatZH": "[operate] 防火墙过滤链", "paramKeys": [] } } }, "/hosts/firewall/forward/base": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallSubsystemStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load forwarding base info", "tags": [ "Firewall" ] } }, "/hosts/firewall/forward/enable": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallInitializationTask" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Enable forwarding", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "initialize and enable port forwarding", "formatZH": "初始化并启用端口转发", "paramKeys": [] } } }, "/hosts/firewall/forward/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ForwardRuleOperate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate forwarding rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "update port forward rules", "formatZH": "更新端口转发规则", "paramKeys": [] } } }, "/hosts/firewall/forward/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ForwardRuleSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page forwarding rules", "tags": [ "Firewall" ] } }, "/hosts/firewall/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallLifecycleOperation" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate firewall", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] firewall", "formatZH": "[operation] 防火墙", "paramKeys": [] } } }, "/hosts/firewall/rules": { "post": { "consumes": [ "application/json" ], "description": "Creation and import return a taskID immediately; validation and execution results are written to the task log.", "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallRuleCreateResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Queue firewall rule creation", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "create firewall rules", "formatZH": "添加防火墙规则", "paramKeys": [] } } }, "/hosts/firewall/rules/adopt": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleAdopt" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Adopt an external firewall rule", "tags": [ "Firewall" ], "x-panel-log": { "bodyKeys": [], "paramKeys": [], "BeforeFunctions": [], "formatZH": "纳管防火墙规则", "formatEN": "adopt firewall rule" } } }, "/hosts/firewall/rules/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleDelete" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallRuleDeleteResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete managed unified firewall v2 rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "delete firewall rules", "formatZH": "删除防火墙规则", "paramKeys": [] } } }, "/hosts/firewall/rules/native/detail": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallNativeDetail" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load one provider-native firewall object definition", "tags": [ "Firewall" ] } }, "/hosts/firewall/rules/reorder": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleReorder" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Reorder a managed unified firewall v2 rule", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "uuid" ], "formatEN": "reorder firewall rule [uuid]", "formatZH": "调整防火墙规则顺序 [uuid]", "paramKeys": [] } } }, "/hosts/firewall/rules/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleInventory" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallRuleInventoryResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List unified firewall v2 rules", "tags": [ "Firewall" ] } }, "/hosts/firewall/rules/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallRuleUpdate" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/dto.Response" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update a managed unified firewall v2 rule", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "uuid" ], "formatEN": "update firewall rule [uuid]", "formatZH": "更新防火墙规则 [uuid]", "paramKeys": [] } } }, "/hosts/firewall/settings": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FirewallSettings" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load firewall settings", "tags": [ "Firewall" ] } }, "/hosts/firewall/settings/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallBackendOperation" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate firewall backend", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "subsystem", "backend", "operation" ], "formatEN": "[operation] firewall [subsystem] backend [backend]", "formatZH": "防火墙子系统 [subsystem] 后端 [operation] [backend]", "paramKeys": [] } } }, "/hosts/firewall/settings/whitelist": { "post": { "consumes": [ "application/json" ], "description": "Returns a synchronization taskID. The whitelist configuration is saved only after synchronization succeeds.", "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallPortWhitelistCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create firewall port whitelist rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "rule" ], "formatEN": "create firewall port whitelist", "formatZH": "创建防火墙端口白名单", "paramKeys": [] } } }, "/hosts/firewall/settings/whitelist/delete": { "post": { "consumes": [ "application/json" ], "description": "Returns a synchronization taskID. The whitelist configuration is saved only after synchronization succeeds.", "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallPortWhitelistDelete" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete firewall port whitelist rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "rules" ], "formatEN": "delete firewall port whitelist", "formatZH": "删除防火墙端口白名单", "paramKeys": [] } } }, "/hosts/firewall/settings/whitelist/update": { "post": { "consumes": [ "application/json" ], "description": "Returns a synchronization taskID. The whitelist configuration is saved only after synchronization succeeds.", "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FirewallPortWhitelistUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FilterChainOperationResponse" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update firewall port whitelist rules", "tags": [ "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "oldRule", "rule" ], "formatEN": "update firewall port whitelist", "formatZH": "编辑防火墙端口白名单", "paramKeys": [] } } }, "/hosts/info": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get host by ID", "tags": [ "Host" ] } }, "/hosts/monitor/clean": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean monitor data", "tags": [ "Monitor" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "clean monitor datas", "formatZH": "清空监控数据", "paramKeys": [] } } }, "/hosts/monitor/iooptions": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get IO options", "tags": [ "Monitor" ] } }, "/hosts/monitor/netoptions": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get network options", "tags": [ "Monitor" ] } }, "/hosts/monitor/search": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MonitorSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.MonitorData" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load monitor data", "tags": [ "Monitor" ] } }, "/hosts/monitor/setting": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.MonitorSetting" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load monitor setting", "tags": [ "Monitor" ] } }, "/hosts/monitor/setting/update": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.MonitorSettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update monitor setting", "tags": [ "Monitor" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update default monitor [key]-[value]", "formatZH": "修改默认监控网卡 [key]-[value]", "paramKeys": [] } } }, "/hosts/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchPageWithGroup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search host", "tags": [ "Host" ] } }, "/hosts/ssh/cert": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RootCertOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Generate host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "generate SSH secret", "formatZH": "生成 SSH 密钥 ", "paramKeys": [] } } }, "/hosts/ssh/cert/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ForceDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "delete SSH secret", "formatZH": "删除 SSH 密钥 ", "paramKeys": [] } } }, "/hosts/ssh/cert/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load host SSH secret", "tags": [ "SSH" ] } }, "/hosts/ssh/cert/sync": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sycn host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "sync SSH secret", "formatZH": "同步 SSH 密钥 ", "paramKeys": [] } } }, "/hosts/ssh/cert/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.RootCertOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "generate SSH secret", "formatZH": "生成 SSH 密钥 ", "paramKeys": [] } } }, "/hosts/ssh/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load host SSH conf", "tags": [ "SSH" ] } }, "/hosts/ssh/file/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SSHConfUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update host SSH setting by file", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key" ], "formatEN": "update SSH conf [key]", "formatZH": "修改 SSH 配置文件 [key]", "paramKeys": [] } } }, "/hosts/ssh/log": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchSSHLog" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load host SSH logs", "tags": [ "SSH" ] } }, "/hosts/ssh/log/clean": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean host SSH logs", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "clean SSH login logs", "formatZH": "清空 SSH 登录日志", "paramKeys": [] } } }, "/hosts/ssh/log/export": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchSSHLog" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Export host SSH logs", "tags": [ "SSH" ] } }, "/hosts/ssh/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Operate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate SSH", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] SSH", "formatZH": "[operation] SSH ", "paramKeys": [] } } }, "/hosts/ssh/search": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SSHInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load host SSH setting info", "tags": [ "SSH" ] } }, "/hosts/ssh/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SSHUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update host SSH setting", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "newValue" ], "formatEN": "update SSH setting [key] =\u003e [newValue]", "formatZH": "修改 SSH 配置 [key] =\u003e [newValue]", "paramKeys": [] } } }, "/hosts/terminal/container": { "get": { "parameters": [ { "description": "cols", "in": "query", "name": "cols", "type": "integer" }, { "description": "rows", "in": "query", "name": "rows", "type": "integer" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Ws container terminal", "tags": [ "Terminal" ] } }, "/hosts/terminal/local": { "get": { "parameters": [ { "description": "command", "in": "query", "name": "command", "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Ws local terminal", "tags": [ "Terminal" ] } }, "/hosts/terminal/ssh": { "get": { "parameters": [ { "description": "id", "in": "query", "name": "id", "type": "integer" }, { "description": "command", "in": "query", "name": "command", "type": "string" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Ws host SSH", "tags": [ "Terminal" ] } }, "/hosts/test/byid": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Test by ID", "tags": [ "Host" ] } }, "/hosts/test/byinfo": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.HostConnTest" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Test by info", "tags": [ "Host" ] } }, "/hosts/tool/config/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostToolTypeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.HostToolConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get tool config", "tags": [ "Host tool" ] } }, "/hosts/tool/config/set": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostToolConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update tool config", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "update [type] tool config", "formatZH": "更新 [type] 主机工具配置文件 ", "paramKeys": [] } } }, "/hosts/tool/init": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostToolCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Host tool Config", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "create [type] config", "formatZH": "创建 [type] 配置", "paramKeys": [] } } }, "/hosts/tool/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostToolOperateReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate tool", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operate", "type" ], "formatEN": "[operate] [type]", "formatZH": "[operate] [type] ", "paramKeys": [] } } }, "/hosts/tool/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostToolTypeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.HostToolRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get tool status", "tags": [ "Host tool" ] } }, "/hosts/tool/supervisor/process": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.SupervisorProcessConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Supervisor process config", "tags": [ "Host tool" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.SupervisorProcessConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Supervisor process", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operate" ], "formatEN": "[operate] process", "formatZH": "[operate] 守护进程 ", "paramKeys": [] } } }, "/hosts/tool/supervisor/process/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostSupervisorProcessFileOperateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Supervisor process config file", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operate" ], "formatEN": "[operate] Supervisor Process Config file", "formatZH": "[operate] Supervisor 进程文件 ", "paramKeys": [] } } }, "/hosts/tool/supervisor/process/file/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.HostSupervisorProcessFileGetReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Supervisor process config file", "tags": [ "Host tool" ] } }, "/hosts/tree": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchForTree" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Host tree", "tags": [ "Host" ] } }, "/hosts/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.HostOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update host", "tags": [ "Host" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "addr" ], "formatEN": "update host [name][addr]", "formatZH": "更新主机 [name][addr]", "paramKeys": [] } } }, "/hosts/update/group": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangeGroup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update host group", "tags": [ "Host" ], "x-panel-log": { "BeforeFunctions": [ { "db": "hosts", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "groupID" ], "formatEN": "update host [name] group", "formatZH": "更新主机 [name] 分组", "paramKeys": [] } } }, "/logs/system/files": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system log files", "tags": [ "Logs" ] } }, "/logs/system/read": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SystemLogReq" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SystemLogRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Read host logs", "tags": [ "Logs" ] } }, "/logs/system/services": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List running host services", "tags": [ "Logs" ] } }, "/logs/system/status": { "get": { "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SystemLogStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get host system log status", "tags": [ "Logs" ] } }, "/logs/tasks/executing/count": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "integer" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get the number of executing tasks", "tags": [ "TaskLog" ] } }, "/logs/tasks/read": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.TaskLogReadReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileLineContent" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Read task log by Line", "tags": [ "TaskLog" ] } }, "/logs/tasks/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchTaskLogReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page task logs", "tags": [ "TaskLog" ] } }, "/openresty": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxFile" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load OpenResty conf", "tags": [ "OpenResty" ] } }, "/openresty/build": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxBuildReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Build OpenResty", "tags": [ "OpenResty" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Build OpenResty", "formatZH": "构建 OpenResty", "paramKeys": [] } } }, "/openresty/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxConfigFileUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update OpenResty conf by upload file", "tags": [ "OpenResty" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Update nginx conf", "formatZH": "更新 nginx 配置", "paramKeys": [] } } }, "/openresty/https": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxConfigRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get default HTTPs status", "tags": [ "OpenResty" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxDefaultHTTPSUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate default HTTPs", "tags": [ "OpenResty" ] } }, "/openresty/modules": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxBuildConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get OpenResty modules", "tags": [ "OpenResty" ] } }, "/openresty/modules/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxModuleUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update OpenResty module", "tags": [ "OpenResty" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Update OpenResty module", "formatZH": "更新 OpenResty 模块", "paramKeys": [] } } }, "/openresty/scope": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxScopeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.NginxParam" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load partial OpenResty conf", "tags": [ "OpenResty" ] } }, "/openresty/status": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxStatus" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load OpenResty status info", "tags": [ "OpenResty" ] } }, "/openresty/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update OpenResty conf", "tags": [ "OpenResty" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteId", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteId" ], "formatEN": "Update nginx conf [domain]", "formatZH": "更新 nginx 配置 [domain]", "paramKeys": [] } } }, "/process/listening": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Listening Process", "tags": [ "Process" ] } }, "/process/stop": { "post": { "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.ProcessReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Stop Process", "tags": [ "Process" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "PID" ], "formatEN": "结束进程 [PID]", "formatZH": "结束进程 [PID]", "paramKeys": [] } } }, "/process/ws": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Process ws", "tags": [ "Process" ] } }, "/process/{pid}": { "get": { "parameters": [ { "description": "PID", "in": "path", "name": "pid", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Process Info By PID", "tags": [ "Process" ] } }, "/runtimes": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.Runtime" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create runtime", "tags": [ "Runtime" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Create runtime [name]", "formatZH": "创建运行环境 [name]", "paramKeys": [] } } }, "/runtimes/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.RuntimeDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get runtime", "tags": [ "Runtime" ] } }, "/runtimes/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete runtime", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id" ], "formatEN": "Delete runtime [id]", "formatZH": "删除运行环境 [id]", "paramKeys": [] } } }, "/runtimes/installed/delete/check/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.AppResource" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete runtime", "tags": [ "Website" ] } }, "/runtimes/node/modules": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NodeModuleReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.NodeModule" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Node modules", "tags": [ "Runtime" ] } }, "/runtimes/node/modules/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NodeModuleReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Node modules", "tags": [ "Runtime" ] } }, "/runtimes/node/package": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NodePackageReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.PackageScripts" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Node package scripts", "tags": [ "Runtime" ] } }, "/runtimes/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate runtime", "tags": [ "Runtime" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "id" ], "formatEN": "Operate runtime [id]", "formatZH": "操作运行环境 [id]", "paramKeys": [] } } }, "/runtimes/php/:id/extensions": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.PHPExtensionRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get php runtime extension", "tags": [ "Runtime" ] } }, "/runtimes/php/config": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update runtime php conf", "tags": [ "Runtime" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "[domain] PHP conf update", "formatZH": "[domain] PHP 配置修改", "paramKeys": [] } } }, "/runtimes/php/config/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.PHPConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load php runtime conf", "tags": [ "Runtime" ] } }, "/runtimes/php/container/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/request.PHPContainerConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get PHP container config", "tags": [ "Runtime" ] } }, "/runtimes/php/container/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPContainerConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update PHP container config", "tags": [ "Runtime" ] } }, "/runtimes/php/extensions": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionsCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create Extensions", "tags": [ "PHP Extensions" ] } }, "/runtimes/php/extensions/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionsDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete Extensions", "tags": [ "PHP Extensions" ] } }, "/runtimes/php/extensions/install": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionInstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Install php extension", "tags": [ "Runtime" ] } }, "/runtimes/php/extensions/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionsSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page Extensions", "tags": [ "PHP Extensions" ] } }, "/runtimes/php/extensions/uninstall": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionInstallReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "UnInstall php extension", "tags": [ "Runtime" ] } }, "/runtimes/php/extensions/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPExtensionsUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Extensions", "tags": [ "PHP Extensions" ] } }, "/runtimes/php/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get php conf file", "tags": [ "Runtime" ] } }, "/runtimes/php/fpm/config": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FPMConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update fpm config", "tags": [ "Runtime" ] } }, "/runtimes/php/fpm/config/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/request.FPMConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get fpm config", "tags": [ "Runtime" ] } }, "/runtimes/php/fpm/status/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": true, "type": "object" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get PHP runtime status", "tags": [ "Runtime" ] } }, "/runtimes/php/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPFileUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update php conf file", "tags": [ "Runtime" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteId", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteId" ], "formatEN": "Nginx conf update [domain]", "formatZH": "php 配置修改 [domain]", "paramKeys": [] } } }, "/runtimes/remark": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeRemark" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update runtime remark", "tags": [ "Runtime" ] } }, "/runtimes/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List runtimes", "tags": [ "Runtime" ] } }, "/runtimes/supervisor/process": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPSupervisorProcessConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate supervisor process", "tags": [ "Runtime" ] } }, "/runtimes/supervisor/process/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.SupervisorProcessConfig" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get supervisor process", "tags": [ "Runtime" ] } }, "/runtimes/supervisor/process/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.PHPSupervisorProcessFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate supervisor process file", "tags": [ "Runtime" ] } }, "/runtimes/sync": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "Sync runtime status", "tags": [ "Runtime" ] } }, "/runtimes/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.RuntimeUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update runtime", "tags": [ "Runtime" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Update runtime [name]", "formatZH": "更新运行环境 [name]", "paramKeys": [] } } }, "/settings/basedir": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load local backup dir", "tags": [ "System Setting" ] } }, "/settings/description/save": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.CommonDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Save common description", "tags": [ "System Setting" ] } }, "/settings/file-history/search": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileHistorySettingInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load file history setting info", "tags": [ "System Setting" ] } }, "/settings/file-history/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.FileHistorySettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update file history setting", "tags": [ "System Setting" ] } }, "/settings/files/ai/search": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get file manage AI setting info", "tags": [ "System Setting" ] } }, "/settings/files/ai/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FileManageAIInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update file manage AI setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "aiStatus", "aiAccountId" ], "formatEN": "update file manage AI setting [aiStatus][aiAccountId]", "formatZH": "更新文件管理 AI 设置 [aiStatus][aiAccountId]", "paramKeys": [] } } }, "/settings/search": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SettingInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system setting info", "tags": [ "System Setting" ] } }, "/settings/search/available": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system available status", "tags": [ "System Setting" ] } }, "/settings/snapshot": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SnapshotCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create system snapshot", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "from", "description" ], "formatEN": "Create system backup [description] to [from]", "formatZH": "创建系统快照 [description] 到 [from]", "paramKeys": [] } } }, "/settings/snapshot/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SnapshotBatchDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete system backup", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { "db": "snapshots", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "ids" ], "formatEN": "Delete system backup [name]", "formatZH": "删除系统快照 [name]", "paramKeys": [] } } }, "/settings/snapshot/description/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update snapshot description", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { "db": "snapshots", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "description" ], "formatEN": "The description of the snapshot [name] is modified =\u003e [description]", "formatZH": "快照 [name] 描述信息修改 [description]", "paramKeys": [] } } }, "/settings/snapshot/import": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SnapshotImport" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Import system snapshot", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "from", "names" ], "formatEN": "Sync system snapshots [names] from [from]", "formatZH": "从 [from] 同步系统快照 [names]", "paramKeys": [] } } }, "/settings/snapshot/load": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SnapshotData" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load system snapshot data", "tags": [ "System Setting" ] } }, "/settings/snapshot/recover": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SnapshotRecover" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Recover system backup", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { "db": "snapshots", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Recover from system backup [name]", "formatZH": "从系统快照 [name] 恢复", "paramKeys": [] } } }, "/settings/snapshot/recreate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Recreate system snapshot", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { "db": "snapshots", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "recrete the snapshot [name]", "formatZH": "重试创建快照 [name]", "paramKeys": [] } } }, "/settings/snapshot/rollback": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SnapshotRecover" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Rollback system backup", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { "db": "snapshots", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Rollback from system backup [name]", "formatZH": "从系统快照 [name] 回滚", "paramKeys": [] } } }, "/settings/snapshot/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageSnapshot" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page system snapshot", "tags": [ "System Setting" ] } }, "/settings/ssh": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Save local conn info", "tags": [ "System Setting" ] } }, "/settings/ssh/check": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check local conn", "tags": [ "System Setting" ] } }, "/settings/ssh/check/info": { "post": { "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check local conn info", "tags": [ "System Setting" ] } }, "/settings/ssh/conn": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SSHConnData" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load local conn", "tags": [ "System Setting" ] } }, "/settings/ssh/default": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SSHDefaultConn" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update local is conn", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "defaultConn" ], "formatEN": "update system default conn [defaultConn]", "formatZH": "本地终端默认连接 [defaultConn]", "paramKeys": [] } } }, "/settings/terminal/ai/search": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get terminal AI setting info", "tags": [ "System Setting" ] } }, "/settings/terminal/ai/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.TerminalAIInfo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update terminal AI setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "aiStatus", "aiAccountId" ], "formatEN": "update terminal AI setting [aiStatus][aiAccountId]", "formatZH": "更新终端 AI 设置 [aiStatus][aiAccountId]", "paramKeys": [] } } }, "/settings/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.AgentSettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update system setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update system setting [key] =\u003e [value]", "formatZH": "修改系统配置 [key] =\u003e [value]", "paramKeys": [] } } }, "/settings/website/dir": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load website dir", "tags": [ "System Setting" ] } }, "/toolbox/clam": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create clam", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "path" ], "formatEN": "create clam [name][path]", "formatZH": "创建扫描规则 [name][path]", "paramKeys": [] } } }, "/toolbox/clam/base": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ClamBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load clam base info", "tags": [ "Clam" ] } }, "/toolbox/clam/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete clam", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [ { "db": "clams", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "name", "output_value": "names" } ], "bodyKeys": [ "ids" ], "formatEN": "delete clam [names]", "formatZH": "删除扫描规则 [names]", "paramKeys": [] } } }, "/toolbox/clam/file/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamFileReq" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load clam file", "tags": [ "Clam" ] } }, "/toolbox/clam/file/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateByNameAndFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update clam file", "tags": [ "Clam" ] } }, "/toolbox/clam/handle": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Handle clam scan", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [ { "db": "clams", "input_column": "id", "input_value": "id", "isList": true, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "handle clam scan [name]", "formatZH": "执行病毒扫描 [name]", "paramKeys": [] } } }, "/toolbox/clam/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Operate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Clam", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] Clam", "formatZH": "[operation] Clam", "paramKeys": [] } } }, "/toolbox/clam/record/clean": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean clam record", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [ { "db": "clams", "input_column": "id", "input_value": "id", "isList": true, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "clean clam record [name]", "formatZH": "清空扫描报告 [name]", "paramKeys": [] } } }, "/toolbox/clam/record/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamLogSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page clam record", "tags": [ "Clam" ] } }, "/toolbox/clam/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchClamWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page clam", "tags": [ "Clam" ] } }, "/toolbox/clam/status/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamUpdateStatus" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update clam status", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [ { "db": "clams", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id", "status" ], "formatEN": "change the status of clam [name] to [status].", "formatZH": "修改扫描规则 [name] 状态为 [status]", "paramKeys": [] } } }, "/toolbox/clam/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ClamUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update clam", "tags": [ "Clam" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name", "path" ], "formatEN": "update clam [name][path]", "formatZH": "修改扫描规则 [name][path]", "paramKeys": [] } } }, "/toolbox/clean": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "items": { "$ref": "#/definitions/dto.Clean" }, "type": "array" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clean system", "tags": [ "Device" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Clean system junk files", "formatZH": "清理系统垃圾文件", "paramKeys": [] } } }, "/toolbox/device/base": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DeviceBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load device base info", "tags": [ "Device" ] } }, "/toolbox/device/check/dns": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check device DNS conf", "tags": [ "Device" ] } }, "/toolbox/device/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperationWithName" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "load conf", "tags": [ "Device" ] } }, "/toolbox/device/update/byconf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateByNameAndFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update device conf by file", "tags": [ "Device" ] } }, "/toolbox/device/update/conf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SettingUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update device", "tags": [ "Device" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update device conf [key] =\u003e [value]", "formatZH": "修改主机参数 [key] =\u003e [value]", "paramKeys": [] } } }, "/toolbox/device/update/host": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update device hosts", "tags": [ "Device" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update device host [key] =\u003e [value]", "formatZH": "修改主机 Host [key] =\u003e [value]", "paramKeys": [] } } }, "/toolbox/device/update/passwd": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.ChangePasswd" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update device passwd", "tags": [ "Device" ] } }, "/toolbox/device/update/swap": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SwapHelper" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update device swap", "tags": [ "Device" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operate", "path" ], "formatEN": "[operate] device swap [path]", "formatZH": "[operate] 主机 swap [path]", "paramKeys": [] } } }, "/toolbox/device/users": { "get": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load user list", "tags": [ "Device" ] } }, "/toolbox/device/zone/options": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "list time zone options", "tags": [ "Device" ] } }, "/toolbox/fail2ban/base": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.Fail2BanBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load fail2ban base info", "tags": [ "Fail2ban" ] } }, "/toolbox/fail2ban/load/conf": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load fail2ban conf", "tags": [ "Fail2ban" ] } }, "/toolbox/fail2ban/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Operate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate fail2ban", "tags": [ "Fail2ban" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] Fail2ban", "formatZH": "[operation] Fail2ban", "paramKeys": [] } } }, "/toolbox/fail2ban/operate/sshd": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Fail2BanSet" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate sshd of fail2ban", "tags": [ "Fail2ban" ] } }, "/toolbox/fail2ban/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Fail2BanSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page fail2ban ip list", "tags": [ "Fail2ban" ] } }, "/toolbox/fail2ban/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Fail2BanUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update fail2ban conf", "tags": [ "Fail2ban" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "key", "value" ], "formatEN": "update fail2ban conf [key] =\u003e [value]", "formatZH": "修改 Fail2ban 配置 [key] =\u003e [value]", "paramKeys": [] } } }, "/toolbox/fail2ban/update/byconf": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateByFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update fail2ban conf by file", "tags": [ "Fail2ban" ] } }, "/toolbox/ftp": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FtpCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create FTP user", "tags": [ "FTP" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "user", "path" ], "formatEN": "create FTP [user][path]", "formatZH": "创建 FTP 账户 [user][path]", "paramKeys": [] } } }, "/toolbox/ftp/base": { "get": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.FtpBaseInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load FTP base info", "tags": [ "FTP" ] } }, "/toolbox/ftp/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete FTP user", "tags": [ "FTP" ], "x-panel-log": { "BeforeFunctions": [ { "db": "ftps", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "user", "output_value": "users" } ], "bodyKeys": [ "ids" ], "formatEN": "delete FTP users [users]", "formatZH": "删除 FTP 账户 [users]", "paramKeys": [] } } }, "/toolbox/ftp/log/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FtpLogSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load FTP operation log", "tags": [ "FTP" ] } }, "/toolbox/ftp/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.Operate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate FTP", "tags": [ "FTP" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "operation" ], "formatEN": "[operation] FTP", "formatZH": "[operation] FTP", "paramKeys": [] } } }, "/toolbox/ftp/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.SearchWithPage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page FTP user", "tags": [ "FTP" ] } }, "/toolbox/ftp/sync": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.BatchDeleteReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Sync FTP user", "tags": [ "FTP" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "sync FTP users", "formatZH": "同步 FTP 账户", "paramKeys": [] } } }, "/toolbox/ftp/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.FtpUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update FTP user", "tags": [ "FTP" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "user", "path" ], "formatEN": "update FTP [user][path]", "formatZH": "修改 FTP 账户 [user][path]", "paramKeys": [] } } }, "/toolbox/scan": { "post": { "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CleanData" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Scan system", "tags": [ "Device" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "scan System Junk Files", "formatZH": "扫描系统垃圾文件", "paramKeys": [] } } }, "/websites": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "alias" ], "formatEN": "Create website [alias]", "formatZH": "创建网站 [alias]", "paramKeys": [] } } }, "/websites/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search website by id", "tags": [ "Website" ] } }, "/websites/:id/config/:type": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" }, { "description": "type", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.FileInfo" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search website nginx by id", "tags": [ "Website Nginx" ] } }, "/websites/:id/https": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteHTTPS" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load https conf", "tags": [ "Website HTTPS" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteHTTPSOp" } }, { "description": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteHTTPS" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update https conf", "tags": [ "Website HTTPS" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteId", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteId" ], "formatEN": "Update website https [domain] conf", "formatZH": "更新网站 [domain] https 配置", "paramKeys": [] } } }, "/websites/acme": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteAcmeAccountCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteAcmeAccountDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website acme account", "tags": [ "Website Acme" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "email" ], "formatEN": "Create website acme [email]", "formatZH": "创建网站 acme [email]", "paramKeys": [] } } }, "/websites/acme/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteResourceReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website acme account", "tags": [ "Website Acme" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_acme_accounts", "input_column": "id", "input_value": "id", "isList": false, "output_column": "email", "output_value": "email" } ], "bodyKeys": [ "id" ], "formatEN": "Delete website acme [email]", "formatZH": "删除网站 acme [email]", "paramKeys": [] } } }, "/websites/acme/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website acme accounts", "tags": [ "Website Acme" ] } }, "/websites/acme/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteAcmeAccountUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteAcmeAccountDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website acme account", "tags": [ "Website Acme" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_acme_accounts", "input_column": "id", "input_value": "id", "isList": false, "output_column": "email", "output_value": "email" } ], "bodyKeys": [ "id" ], "formatEN": "Update acme [email]", "formatZH": "更新 acme [email]", "paramKeys": [] } } }, "/websites/auths": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxAuthReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxAuthRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get AuthBasic conf", "tags": [ "Website" ] } }, "/websites/auths/path": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxAuthReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxPathAuthRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get AuthBasic conf", "tags": [ "Website" ] } }, "/websites/auths/path/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxPathAuthUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get AuthBasic conf", "tags": [ "Website" ] } }, "/websites/auths/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxAuthUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get AuthBasic conf", "tags": [ "Website" ] } }, "/websites/batch/group": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.BatchWebsiteGroup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch set website group", "tags": [ "Website" ] } }, "/websites/batch/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.BatchWebsiteOp" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch operate websites", "tags": [ "Website" ] } }, "/websites/batch/ssl": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.BatchWebsiteHttps" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Batch set HTTPS for websites", "tags": [ "Website" ] } }, "/websites/ca": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCACreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/request.WebsiteCACreate" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website ca", "tags": [ "Website CA" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Create website ca [name]", "formatZH": "创建网站 ca [name]", "paramKeys": [] } } }, "/websites/ca/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCommonReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website ca", "tags": [ "Website CA" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_cas", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Delete website ca [name]", "formatZH": "删除网站 ca [name]", "paramKeys": [] } } }, "/websites/ca/download": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteResourceReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download CA file", "tags": [ "Website CA" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_cas", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "download ca file [name]", "formatZH": "下载 CA 证书文件 [name]", "paramKeys": [] } } }, "/websites/ca/obtain": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCAObtain" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Obtain SSL", "tags": [ "Website CA" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_cas", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Obtain SSL [name]", "formatZH": "自签 SSL 证书 [name]", "paramKeys": [] } } }, "/websites/ca/renew": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCAObtain" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Obtain SSL", "tags": [ "Website CA" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_cas", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Obtain SSL [name]", "formatZH": "自签 SSL 证书 [name]", "paramKeys": [] } } }, "/websites/ca/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCASearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website ca", "tags": [ "Website CA" ] } }, "/websites/ca/{id}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteCADTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website ca", "tags": [ "Website CA" ] } }, "/websites/check": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteInstallCheckReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsitePreInstallCheck" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Check before create website", "tags": [ "Website" ] } }, "/websites/config": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxScopeReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteNginxConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Load nginx conf", "tags": [ "Website Nginx" ] } }, "/websites/config/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxConfigUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update nginx conf", "tags": [ "Website Nginx" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteId", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteId" ], "formatEN": "Nginx conf update [domain]", "formatZH": "nginx 配置修改 [domain]", "paramKeys": [] } } }, "/websites/cors/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.CorsConfigReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update CORS Config", "tags": [ "Website" ] } }, "/websites/cors/{id}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/request.CorsConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get CORS Config", "tags": [ "Website" ] } }, "/websites/crosssite": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.CrossSiteAccessOp" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate Cross Site Access", "tags": [ "Website" ] } }, "/websites/databases": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Database" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get databases", "tags": [ "Website" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.ChangeDatabase" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change website database", "tags": [ "Website" ] } }, "/websites/default/html/:type": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "type", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteHtmlRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get default html", "tags": [ "Website" ] } }, "/websites/default/html/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteHtmlUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update default html", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "Update default html", "formatZH": "更新默认 html", "paramKeys": [] } } }, "/websites/default/server": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDefaultUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change default server", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "operate" ], "formatEN": "Change default server =\u003e [domain]", "formatZH": "修改默认 server =\u003e [domain]", "paramKeys": [] } } }, "/websites/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Delete website [domain]", "formatZH": "删除网站 [domain]", "paramKeys": [] } } }, "/websites/dir": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteCommonReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteDirConfig" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website dir", "tags": [ "Website" ] } }, "/websites/dir/permission": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteUpdateDirPermission" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Site Dir permission", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Update domain [domain] dir permission", "formatZH": "更新网站 [domain] 目录权限", "paramKeys": [] } } }, "/websites/dir/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteUpdateDir" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Site Dir", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Update domain [domain] dir", "formatZH": "更新网站 [domain] 目录", "paramKeys": [] } } }, "/websites/dns": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDnsAccountCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website dns account", "tags": [ "Website DNS" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Create website dns [name]", "formatZH": "创建网站 dns [name]", "paramKeys": [] } } }, "/websites/dns/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteResourceReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website dns account", "tags": [ "Website DNS" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_dns_accounts", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Delete website dns [name]", "formatZH": "删除网站 dns [name]", "paramKeys": [] } } }, "/websites/dns/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website dns accounts", "tags": [ "Website DNS" ] } }, "/websites/dns/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDnsAccountUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website dns account", "tags": [ "Website DNS" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Update website dns [name]", "formatZH": "更新网站 dns [name]", "paramKeys": [] } } }, "/websites/domains": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDomainCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.WebsiteDomain" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website domain", "tags": [ "Website Domain" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "domain" ], "formatEN": "Create domain [domain]", "formatZH": "创建域名 [domain]", "paramKeys": [] } } }, "/websites/domains/:websiteId": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "websiteId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/model.WebsiteDomain" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search website domains by websiteId", "tags": [ "Website Domain" ] } }, "/websites/domains/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDomainDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website domain", "tags": [ "Website Domain" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_domains", "input_column": "id", "input_value": "id", "isList": false, "output_column": "domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Delete domain [domain]", "formatZH": "删除域名 [domain]", "paramKeys": [] } } }, "/websites/domains/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDomainUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website domain", "tags": [ "Website Domain" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_domains", "input_column": "id", "input_value": "id", "isList": false, "output_column": "domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Update domain [domain]", "formatZH": "更新域名 [domain]", "paramKeys": [] } } }, "/websites/exec/composer": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.ExecComposerReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Exec Composer", "tags": [ "Website" ] } }, "/websites/group/change": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateGroup" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Change website group", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "group", "newGroup" ], "formatEN": "change website group [group] to [newGroup]", "formatZH": "网站分组 [group] 迁移到 [newGroup]", "paramKeys": [] } } }, "/websites/lbs/create": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLBCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website upstream", "tags": [ "Website" ] } }, "/websites/lbs/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLBDelete" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website upstream", "tags": [ "Website" ] } }, "/websites/lbs/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLBUpdateFile" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website upstream file", "tags": [ "Website" ] } }, "/websites/lbs/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLBUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website upstream", "tags": [ "Website" ] } }, "/websites/leech": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxCommonReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxAntiLeechRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get AntiLeech conf", "tags": [ "Website" ] } }, "/websites/leech/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxAntiLeechUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update AntiLeech", "tags": [ "Website" ] } }, "/websites/list": { "get": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsiteDTO" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List websites", "tags": [ "Website" ] } }, "/websites/log/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLogReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate website log", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "operate" ], "formatEN": "[domain][operate] logs", "formatZH": "[domain][operate] 日志", "paramKeys": [] } } }, "/websites/log/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteLogSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteLog" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website log", "tags": [ "Website" ] } }, "/websites/nginx/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteNginxUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website nginx conf", "tags": [ "Website Nginx" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "[domain] Nginx conf update", "formatZH": "[domain] Nginx 配置修改", "paramKeys": [] } } }, "/websites/operate": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteOp" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate website", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "operate" ], "formatEN": "[operate] website [domain]", "formatZH": "[operate] 网站 [domain]", "paramKeys": [] } } }, "/websites/options": { "post": { "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsiteOption" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List website names", "tags": [ "Website" ] } }, "/websites/php/version": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsitePHPVersionReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update php version", "tags": [ "Website PHP" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteId", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteId" ], "formatEN": "php version update [domain]", "formatZH": "php 版本变更 [domain]", "paramKeys": [] } } }, "/websites/proxies": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteProxyReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/request.WebsiteProxyConfig" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get proxy conf", "tags": [ "Website" ] } }, "/websites/proxies/delete": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteProxyDel" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete proxy config", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "name" ], "formatEN": "Delete domain [domain] proxy config [name]", "formatZH": "删除网站 [domain] 反向代理配置 [name] ", "paramKeys": [] } } }, "/websites/proxies/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxProxyUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update proxy file", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteID", "name" ], "formatEN": "Update domain [domain] proxy config file [name]", "formatZH": "修改网站 [domain] 反向代理配置文件 [name] ", "paramKeys": [] } } }, "/websites/proxies/status": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteProxyStatusUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update proxy config status", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "name", "status" ], "formatEN": "Update domain [domain] proxy config [name] status [status]", "formatZH": "修改网站 [domain] 反向代理配置 [name] 状态 [status] ", "paramKeys": [] } } }, "/websites/proxies/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteProxyConfig" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update proxy conf", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id", "name", "operate" ], "formatEN": "Update [operate] domain [domain] proxy config [name]", "formatZH": "修改 [operate] 网站 [domain] 反向代理配置 [name] ", "paramKeys": [] } } }, "/websites/proxy/clear": { "post": { "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Clear Website proxy cache", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], "formatEN": "Clear nginx proxy cache", "formatZH": "清理 Openresty 代理缓存", "paramKeys": [] } } }, "/websites/proxy/config": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxProxyCacheUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "update website proxy cache config", "tags": [ "Website" ] } }, "/websites/proxy/config/{id}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxProxyCache" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website proxy cache config", "tags": [ "Website" ] } }, "/websites/realip/config": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteRealIP" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Set Real IP", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteID" ], "formatEN": "Modify the real IP configuration of [domain] website", "formatZH": "修改 [domain] 网站真实IP配置 ", "paramKeys": [] } } }, "/websites/realip/config/{id}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteRealIP" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get Real IP Config", "tags": [ "Website" ] } }, "/websites/redirect": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteProxyReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.NginxRedirectConfig" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get redirect conf", "tags": [ "Website" ] } }, "/websites/redirect/file": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxRedirectUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update redirect file", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteID" ], "formatEN": "Nginx conf redirect file update [domain]", "formatZH": "更新重定向文件 [domain]", "paramKeys": [] } } }, "/websites/redirect/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxRedirectReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update redirect conf", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteID" ], "formatEN": "Update domain [domain] redirect config", "formatZH": "修改网站 [domain] 重定向配置 ", "paramKeys": [] } } }, "/websites/resource/{id}": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Resource" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website resource", "tags": [ "Website" ] } }, "/websites/rewrite": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxRewriteReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.NginxRewriteRes" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get rewrite conf", "tags": [ "Website" ] } }, "/websites/rewrite/custom": { "get": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List custom rewrite", "tags": [ "Website" ] }, "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.CustomRewriteOperate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Operate custom rewrite", "tags": [ "Website" ] } }, "/websites/rewrite/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.NginxRewriteUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update rewrite conf", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [ { "db": "websites", "input_column": "id", "input_value": "websiteID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "websiteID" ], "formatEN": "Nginx conf rewrite update [domain]", "formatZH": "伪静态配置修改 [domain]", "paramKeys": [] } } }, "/websites/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page websites", "tags": [ "Website" ] } }, "/websites/ssl": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLCreate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/request.WebsiteSSLCreate" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website ssl", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "primaryDomain" ], "formatEN": "Create website ssl [primaryDomain]", "formatZH": "创建网站 ssl [primaryDomain]", "paramKeys": [] } } }, "/websites/ssl/:id": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteSSLDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search website ssl by id", "tags": [ "Website SSL" ] } }, "/websites/ssl/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteBatchDelReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website ssl", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_ssls", "input_column": "id", "input_value": "ids", "isList": true, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "ids" ], "formatEN": "Delete ssl [domain]", "formatZH": "删除 ssl [domain]", "paramKeys": [] } } }, "/websites/ssl/download": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteResourceReq" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Download SSL file", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_ssls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "download ssl file [domain]", "formatZH": "下载证书文件 [domain]", "paramKeys": [] } } }, "/websites/ssl/import": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/model.WebsiteSSL" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Import master SSL", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "primaryDomain" ], "formatEN": "import master SSL [primaryDomain]", "formatZH": "导入主节点证书 [primaryDomain]", "paramKeys": [] } } }, "/websites/ssl/list": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLListReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsiteSSLDTO" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "List website ssl", "tags": [ "Website SSL" ] } }, "/websites/ssl/obtain": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLApply" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Apply ssl", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_ssls", "input_column": "id", "input_value": "ID", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "ID" ], "formatEN": "apply ssl [domain]", "formatZH": "申请证书 [domain]", "paramKeys": [] } } }, "/websites/ssl/push": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLPush" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Push ssl to nodes", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_ssls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Push ssl to nodes [domain]", "formatZH": "推送证书到节点 [domain]", "paramKeys": [] } } }, "/websites/ssl/resolve": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteDNSReq" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsiteDNSRes" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Resolve website ssl", "tags": [ "Website SSL" ] } }, "/websites/ssl/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/response.WebsiteSSLDTO" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website ssl", "tags": [ "Website SSL" ] } }, "/websites/ssl/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update ssl", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_ssls", "input_column": "id", "input_value": "id", "isList": false, "output_column": "primary_domain", "output_value": "domain" } ], "bodyKeys": [ "id" ], "formatEN": "Update ssl config [domain]", "formatZH": "更新证书设置 [domain]", "paramKeys": [] } } }, "/websites/ssl/upload": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteSSLUpload" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload ssl", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "Upload ssl [type]", "formatZH": "上传 ssl [type]", "paramKeys": [] } } }, "/websites/ssl/upload/file": { "post": { "consumes": [ "multipart/form-data" ], "parameters": [ { "description": "type", "in": "formData", "name": "type", "required": true, "type": "string" }, { "description": "description", "in": "formData", "name": "description", "type": "string" }, { "description": "sslID", "in": "formData", "name": "sslID", "type": "string" }, { "description": "privateKeyFile", "in": "formData", "name": "privateKeyFile", "required": true, "type": "file" }, { "description": "certificateFile", "in": "formData", "name": "certificateFile", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload SSL file", "tags": [ "Website SSL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "type" ], "formatEN": "Upload ssl file [type]", "formatZH": "上传 ssl 文件 [type]", "paramKeys": [] } } }, "/websites/ssl/website/:websiteId": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "path", "name": "websiteId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteSSLDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Search website ssl by website id", "tags": [ "Website SSL" ] } }, "/websites/stream/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.StreamUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update Stream Config", "tags": [ "Website" ] } }, "/websites/templates": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteTemplateCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website template", "tags": [ "Website Template" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Create website template [name]", "formatZH": "创建网站模板 [name]", "paramKeys": [] } } }, "/websites/templates/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website template", "tags": [ "Website Template" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_templates", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Delete website template [name]", "formatZH": "删除网站模板 [name]", "paramKeys": [] } } }, "/websites/templates/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteTemplateDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website template", "tags": [ "Website Template" ] } }, "/websites/templates/outputs": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteTemplateOutputCreate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Create website template output", "tags": [ "Website Template" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Generate template output [name]", "formatZH": "生成模板产物 [name]", "paramKeys": [] } } }, "/websites/templates/outputs/del": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Delete website template output", "tags": [ "Website Template" ], "x-panel-log": { "BeforeFunctions": [ { "db": "website_template_outputs", "input_column": "id", "input_value": "id", "isList": false, "output_column": "name", "output_value": "name" } ], "bodyKeys": [ "id" ], "formatEN": "Delete template output [name]", "formatZH": "删除模板产物 [name]", "paramKeys": [] } } }, "/websites/templates/outputs/get": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/dto.OperateByID" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsiteTemplateOutputDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website template output", "tags": [ "Website Template" ] } }, "/websites/templates/outputs/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteTemplateOutputSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website template outputs", "tags": [ "Website Template" ] } }, "/websites/templates/preview": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsitePreviewReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.WebsitePreviewDTO" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Preview website template", "tags": [ "Website Template" ] } }, "/websites/templates/search": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteTemplateSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PageResult" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Page website templates", "tags": [ "Website Template" ] } }, "/websites/templates/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteTemplateUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website template", "tags": [ "Website Template" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], "formatEN": "Update website template [name]", "formatZH": "更新网站模板 [name]", "paramKeys": [] } } }, "/websites/templates/upload": { "post": { "consumes": [ "multipart/form-data" ], "parameters": [ { "description": "file", "in": "formData", "name": "file", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Upload website template zip", "tags": [ "Website Template" ] } }, "/websites/update": { "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/request.WebsiteUpdate" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Update website", "tags": [ "Website" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "primaryDomain" ], "formatEN": "Update website [primaryDomain]", "formatZH": "更新网站 [primaryDomain]", "paramKeys": [] } } }, "/websites/{id}/lbs": { "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/dto.NginxUpstream" }, "type": "array" } } }, "security": [ { "ApiKeyAuth": [] }, { "Timestamp": [] } ], "summary": "Get website upstreams", "tags": [ "Website" ] } } }, "definitions": { "dto.AgentAccountCreateReq": { "properties": { "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "authMode": { "type": "string" }, "baseURL": { "type": "string" }, "models": { "items": { "$ref": "#/definitions/dto.AgentAccountModel" }, "type": "array" }, "name": { "type": "string" }, "provider": { "type": "string" }, "remark": { "type": "string" }, "rememberApiKey": { "type": "boolean" }, "validateAvailability": { "type": "boolean" }, "verifyModel": { "type": "string" } }, "required": [ "apiKey", "apiType", "name", "provider" ], "type": "object" }, "dto.AgentAccountDeleteReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.AgentAccountInfo": { "properties": { "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "authMode": { "type": "string" }, "baseUrl": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "integer" }, "masterAccountId": { "type": "integer" }, "models": { "items": { "$ref": "#/definitions/dto.AgentAccountModel" }, "type": "array" }, "name": { "type": "string" }, "provider": { "type": "string" }, "providerName": { "type": "string" }, "remark": { "type": "string" }, "rememberApiKey": { "type": "boolean" }, "verified": { "type": "boolean" }, "verifyModel": { "type": "string" } }, "type": "object" }, "dto.AgentAccountModel": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "recordId": { "type": "integer" } }, "type": "object" }, "dto.AgentAccountModelCreateReq": { "properties": { "accountId": { "type": "integer" }, "model": { "$ref": "#/definitions/dto.AgentAccountModel" } }, "required": [ "accountId", "model" ], "type": "object" }, "dto.AgentAccountModelDeleteReq": { "properties": { "accountId": { "type": "integer" }, "recordId": { "type": "integer" } }, "required": [ "accountId", "recordId" ], "type": "object" }, "dto.AgentAccountModelDiscoverReq": { "properties": { "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "baseURL": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "apiKey", "apiType", "baseURL", "provider" ], "type": "object" }, "dto.AgentAccountModelReq": { "properties": { "accountId": { "type": "integer" } }, "required": [ "accountId" ], "type": "object" }, "dto.AgentAccountModelUpdateReq": { "properties": { "accountId": { "type": "integer" }, "model": { "$ref": "#/definitions/dto.AgentAccountModel" } }, "required": [ "accountId", "model" ], "type": "object" }, "dto.AgentAccountProviderCountReq": { "properties": { "providers": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.AgentAccountSearch": { "properties": { "apiType": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "provider": { "type": "string" }, "textOnly": { "type": "boolean" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.AgentAccountUpdateReq": { "properties": { "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "authMode": { "type": "string" }, "baseURL": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "rememberApiKey": { "type": "boolean" }, "syncAgents": { "type": "boolean" }, "validateAvailability": { "type": "boolean" }, "verifyModel": { "type": "string" } }, "required": [ "apiKey", "apiType", "id", "name" ], "type": "object" }, "dto.AgentAccountVerifyReq": { "properties": { "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "authMode": { "type": "string" }, "baseURL": { "type": "string" }, "model": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "apiKey", "apiType", "provider" ], "type": "object" }, "dto.AgentBatchInstallReq": { "properties": { "accountId": { "type": "integer" }, "accountModels": { "items": { "$ref": "#/definitions/dto.AgentAccountModel" }, "type": "array" }, "accountSnapshot": { "$ref": "#/definitions/dto.AgentAccountInfo" }, "advanced": { "type": "boolean" }, "agentType": { "enum": [ "openclaw", "copaw", "hermes-agent" ], "type": "string" }, "allowPort": { "type": "boolean" }, "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "appVersion": { "type": "string" }, "bridgePort": { "type": "integer" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dashboardPassword": { "type": "string" }, "dashboardUsername": { "type": "string" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "fallbackAccessHost": { "type": "string" }, "masterAccountId": { "type": "integer" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "pullImage": { "type": "boolean" }, "remark": { "type": "string" }, "restartPolicy": { "type": "string" }, "specifyIP": { "type": "string" }, "taskID": { "type": "string" }, "token": { "type": "string" }, "webUIPort": { "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "agentType", "appVersion", "webUIPort" ], "type": "object" }, "dto.AgentBatchOperateReq": { "properties": { "agentType": { "enum": [ "openclaw", "copaw", "hermes-agent" ], "type": "string" }, "forceDelete": { "type": "boolean" }, "operate": { "enum": [ "start", "stop", "restart", "delete" ], "type": "string" }, "taskID": { "type": "string" } }, "required": [ "agentType", "operate" ], "type": "object" }, "dto.AgentBatchOperateResult": { "properties": { "agentID": { "type": "integer" }, "agentName": { "type": "string" }, "appInstallID": { "type": "integer" }, "message": { "type": "string" }, "skipped": { "type": "boolean" }, "success": { "type": "boolean" } }, "type": "object" }, "dto.AgentBatchSkillInstallReq": { "properties": { "agentType": { "enum": [ "openclaw", "hermes-agent" ], "type": "string" }, "packagePath": { "type": "string" }, "skillName": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "agentType", "packagePath", "skillName" ], "type": "object" }, "dto.AgentBatchSkillInstallResult": { "properties": { "agentID": { "type": "integer" }, "agentName": { "type": "string" }, "appInstallID": { "type": "integer" }, "message": { "type": "string" }, "skipped": { "type": "boolean" }, "success": { "type": "boolean" } }, "type": "object" }, "dto.AgentBatchUpgradeReq": { "properties": { "agentType": { "enum": [ "openclaw", "copaw", "hermes-agent" ], "type": "string" }, "backup": { "type": "boolean" }, "pullImage": { "type": "boolean" }, "targetVersion": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "agentType", "targetVersion" ], "type": "object" }, "dto.AgentBatchUpgradeResult": { "properties": { "agentID": { "type": "integer" }, "agentName": { "type": "string" }, "appInstallID": { "type": "integer" }, "message": { "type": "string" }, "skipped": { "type": "boolean" }, "success": { "type": "boolean" } }, "type": "object" }, "dto.AgentChannelDeleteReq": { "properties": { "agentId": { "type": "integer" }, "type": { "enum": [ "feishu", "telegram", "discord", "wecom", "qqbot", "dingtalk", "weixin" ], "type": "string" } }, "required": [ "agentId", "type" ], "type": "object" }, "dto.AgentChannelPairingApproveReq": { "properties": { "accountId": { "type": "string" }, "agentId": { "type": "integer" }, "pairingCode": { "type": "string" }, "type": { "enum": [ "feishu", "telegram", "discord", "wecom", "qqbot", "dingtalk" ], "type": "string" } }, "required": [ "agentId", "pairingCode", "type" ], "type": "object" }, "dto.AgentConfigFile": { "properties": { "content": { "type": "string" } }, "type": "object" }, "dto.AgentConfigFileReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentConfigFileUpdateReq": { "properties": { "agentId": { "type": "integer" }, "content": { "type": "string" } }, "required": [ "agentId", "content" ], "type": "object" }, "dto.AgentConfiguredAgentItem": { "properties": { "agentDir": { "type": "string" }, "bindings": { "items": { "$ref": "#/definitions/dto.AgentRoleBinding" }, "type": "array" }, "id": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "workspace": { "type": "string" } }, "type": "object" }, "dto.AgentConfiguredAgentsReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentCreateReq": { "properties": { "accountId": { "type": "integer" }, "advanced": { "type": "boolean" }, "agentType": { "enum": [ "openclaw", "copaw", "hermes-agent" ], "type": "string" }, "allowPort": { "type": "boolean" }, "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "appVersion": { "type": "string" }, "bridgePort": { "type": "integer" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dashboardPassword": { "type": "string" }, "dashboardUsername": { "type": "string" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "pullImage": { "type": "boolean" }, "remark": { "type": "string" }, "restartPolicy": { "type": "string" }, "specifyIP": { "type": "string" }, "taskID": { "type": "string" }, "token": { "type": "string" }, "webUIPort": { "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "agentType", "appVersion", "name", "webUIPort" ], "type": "object" }, "dto.AgentDeleteReq": { "properties": { "forceDelete": { "type": "boolean" }, "id": { "type": "integer" }, "taskID": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "dto.AgentDingTalkBot": { "properties": { "accountId": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "dto.AgentDingTalkConfig": { "properties": { "ackText": { "type": "string" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "asyncMode": { "type": "boolean" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentDingTalkBot" }, "type": "array" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" }, "groupSessionScope": { "type": "string" }, "installed": { "type": "boolean" }, "separateSessionByConversation": { "type": "boolean" }, "sharedMemoryAcrossConversations": { "type": "boolean" } }, "type": "object" }, "dto.AgentDingTalkConfigUpdateReq": { "properties": { "ackText": { "type": "string" }, "agentId": { "type": "integer" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "asyncMode": { "type": "boolean" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentDingTalkBot" }, "minItems": 1, "type": "array" }, "dmPolicy": { "enum": [ "pairing", "allowlist", "open", "disabled" ], "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "enum": [ "open", "allowlist", "disabled" ], "type": "string" }, "groupSessionScope": { "enum": [ "group", "group_sender" ], "type": "string" }, "separateSessionByConversation": { "type": "boolean" }, "sharedMemoryAcrossConversations": { "type": "boolean" } }, "required": [ "agentId", "bots", "dmPolicy", "groupPolicy", "groupSessionScope" ], "type": "object" }, "dto.AgentDiscordBot": { "properties": { "accountId": { "type": "string" }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "dto.AgentDiscordConfig": { "properties": { "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentDiscordBot" }, "type": "array" }, "defaultAccount": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupPolicy": { "type": "string" }, "proxy": { "type": "string" }, "requireMention": { "type": "boolean" } }, "type": "object" }, "dto.AgentDiscordConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentDiscordBot" }, "minItems": 1, "type": "array" }, "defaultAccount": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupPolicy": { "enum": [ "open", "allowlist", "disabled" ], "type": "string" }, "proxy": { "type": "string" }, "requireMention": { "type": "boolean" } }, "required": [ "agentId", "bots", "defaultAccount", "dmPolicy", "groupPolicy" ], "type": "object" }, "dto.AgentFeishuBot": { "properties": { "accountId": { "type": "string" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "dto.AgentFeishuConfig": { "properties": { "bots": { "items": { "$ref": "#/definitions/dto.AgentFeishuBot" }, "type": "array" }, "connectionMode": { "type": "string" }, "domain": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" }, "installed": { "type": "boolean" }, "replyMode": { "type": "string" }, "requireMention": { "type": "string" }, "streaming": { "type": "boolean" }, "threadSession": { "type": "boolean" } }, "type": "object" }, "dto.AgentFeishuConfigReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentFeishuConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentFeishuBot" }, "minItems": 1, "type": "array" }, "connectionMode": { "type": "string" }, "domain": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "enum": [ "open", "allowlist", "disabled" ], "type": "string" }, "replyMode": { "type": "string" }, "requireMention": { "enum": [ "true", "false", "open" ], "type": "string" }, "streaming": { "type": "boolean" }, "threadSession": { "type": "boolean" } }, "required": [ "agentId", "bots", "groupPolicy", "replyMode", "requireMention" ], "type": "object" }, "dto.AgentHermesChatSessionDeleteReq": { "properties": { "agentId": { "type": "integer" }, "id": { "type": "string" } }, "required": [ "agentId", "id" ], "type": "object" }, "dto.AgentHermesChatSessionItem": { "properties": { "id": { "type": "string" }, "lastActive": { "type": "string" }, "messageCount": { "type": "integer" }, "model": { "type": "string" }, "startedAt": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "dto.AgentHermesChatSessionRenameReq": { "properties": { "agentId": { "type": "integer" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "agentId", "id", "title" ], "type": "object" }, "dto.AgentIDReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentItem": { "properties": { "accountId": { "type": "integer" }, "agentType": { "type": "string" }, "apiKey": { "type": "string" }, "apiType": { "type": "string" }, "appInstallId": { "type": "integer" }, "appVersion": { "type": "string" }, "baseUrl": { "type": "string" }, "bridgePort": { "type": "integer" }, "configPath": { "type": "string" }, "containerName": { "type": "string" }, "createdAt": { "type": "string" }, "dashboardPassword": { "type": "string" }, "dashboardUsername": { "type": "string" }, "id": { "type": "integer" }, "message": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "provider": { "type": "string" }, "providerName": { "type": "string" }, "remark": { "type": "string" }, "status": { "type": "string" }, "token": { "type": "string" }, "upgradable": { "type": "boolean" }, "webUIPort": { "type": "integer" }, "websiteId": { "type": "integer" }, "websitePrimaryDomain": { "type": "string" }, "websiteProtocol": { "type": "string" }, "websiteType": { "type": "string" } }, "type": "object" }, "dto.AgentModelConfig": { "properties": { "accountId": { "type": "integer" }, "fallbacks": { "items": { "type": "string" }, "type": "array" }, "model": { "type": "string" } }, "type": "object" }, "dto.AgentModelConfigUpdateReq": { "properties": { "accountId": { "type": "integer" }, "agentId": { "type": "integer" }, "fallbacks": { "items": { "type": "string" }, "type": "array" }, "model": { "type": "string" } }, "required": [ "accountId", "agentId", "model" ], "type": "object" }, "dto.AgentOtherConfig": { "properties": { "browserEnabled": { "type": "boolean" }, "dashboardPassword": { "type": "string" }, "dashboardUsername": { "type": "string" }, "npmRegistry": { "type": "string" }, "userTimezone": { "type": "string" } }, "type": "object" }, "dto.AgentOtherConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "browserEnabled": { "type": "boolean" }, "dashboardPassword": { "type": "string" }, "dashboardUsername": { "type": "string" }, "npmRegistry": { "type": "string" }, "userTimezone": { "type": "string" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentOverview": { "properties": { "snapshot": { "$ref": "#/definitions/dto.AgentOverviewSnapshot" } }, "type": "object" }, "dto.AgentOverviewReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentOverviewSnapshot": { "properties": { "appVersion": { "type": "string" }, "channelCount": { "type": "integer" }, "containerStatus": { "type": "string" }, "defaultModel": { "type": "string" }, "jobCount": { "type": "integer" }, "sessionCount": { "type": "integer" }, "skillCount": { "type": "integer" } }, "type": "object" }, "dto.AgentPluginCheckReq": { "properties": { "agentId": { "type": "integer" }, "checkLatest": { "type": "boolean" }, "type": { "enum": [ "feishu", "qqbot", "wecom", "dingtalk", "weixin" ], "type": "string" } }, "required": [ "agentId", "type" ], "type": "object" }, "dto.AgentPluginInstallReq": { "properties": { "agentId": { "type": "integer" }, "taskID": { "type": "string" }, "type": { "enum": [ "feishu", "qqbot", "wecom", "dingtalk", "weixin" ], "type": "string" } }, "required": [ "agentId", "taskID", "type" ], "type": "object" }, "dto.AgentPluginItem": { "properties": { "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "origin": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.AgentPluginMarketInstallReq": { "properties": { "agentId": { "type": "integer" }, "package": { "maxLength": 200, "type": "string" }, "taskID": { "type": "string" }, "version": { "maxLength": 100, "type": "string" } }, "required": [ "agentId", "package", "taskID", "version" ], "type": "object" }, "dto.AgentPluginOperateReq": { "properties": { "agentId": { "type": "integer" }, "operate": { "enum": [ "enable", "disable", "update", "uninstall" ], "type": "string" }, "pluginId": { "maxLength": 200, "type": "string" }, "taskID": { "type": "string" } }, "required": [ "agentId", "operate", "pluginId", "taskID" ], "type": "object" }, "dto.AgentPluginSearchItem": { "properties": { "categories": { "items": { "type": "string" }, "type": "array" }, "channel": { "type": "string" }, "description": { "type": "string" }, "downloads": { "type": "integer" }, "name": { "type": "string" }, "official": { "type": "boolean" }, "package": { "type": "string" }, "pluginId": { "type": "string" }, "score": { "type": "number" }, "verificationTier": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.AgentPluginSearchReq": { "properties": { "agentId": { "type": "integer" }, "keyword": { "maxLength": 100, "type": "string" }, "limit": { "maximum": 100, "minimum": 1, "type": "integer" } }, "required": [ "agentId", "keyword" ], "type": "object" }, "dto.AgentPluginStatus": { "properties": { "currentVersion": { "type": "string" }, "installed": { "type": "boolean" }, "latestVersion": { "type": "string" }, "upgradable": { "type": "boolean" } }, "type": "object" }, "dto.AgentPluginUninstallReq": { "properties": { "agentId": { "type": "integer" }, "taskID": { "type": "string" }, "type": { "enum": [ "feishu", "qqbot", "wecom", "dingtalk", "weixin" ], "type": "string" } }, "required": [ "agentId", "taskID", "type" ], "type": "object" }, "dto.AgentPluginUpgradeReq": { "properties": { "agentId": { "type": "integer" }, "taskID": { "type": "string" }, "type": { "enum": [ "feishu", "qqbot", "wecom", "dingtalk", "weixin" ], "type": "string" } }, "required": [ "agentId", "taskID", "type" ], "type": "object" }, "dto.AgentPluginsReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentQQBotBot": { "properties": { "accountId": { "type": "string" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "appId": { "type": "string" }, "clientSecret": { "type": "string" }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "systemPrompt": { "type": "string" } }, "type": "object" }, "dto.AgentQQBotConfig": { "properties": { "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentQQBotBot" }, "type": "array" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" }, "installed": { "type": "boolean" } }, "type": "object" }, "dto.AgentQQBotConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentQQBotBot" }, "minItems": 1, "type": "array" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" } }, "required": [ "agentId", "bots" ], "type": "object" }, "dto.AgentRemarkUpdateReq": { "properties": { "id": { "type": "integer" }, "remark": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "dto.AgentRoleBindReq": { "properties": { "accountId": { "type": "string" }, "agentId": { "type": "integer" }, "channel": { "type": "string" }, "id": { "type": "string" } }, "required": [ "agentId", "channel", "id" ], "type": "object" }, "dto.AgentRoleBinding": { "properties": { "accountId": { "type": "string" }, "channel": { "type": "string" } }, "required": [ "channel" ], "type": "object" }, "dto.AgentRoleChannelItem": { "properties": { "accountIds": { "items": { "type": "string" }, "type": "array" }, "bound": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "dto.AgentRoleChannelsReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentRoleCreateReq": { "properties": { "agentId": { "type": "integer" }, "bindings": { "items": { "$ref": "#/definitions/dto.AgentRoleBinding" }, "type": "array" }, "model": { "type": "string" }, "name": { "type": "string" } }, "required": [ "agentId", "name" ], "type": "object" }, "dto.AgentRoleCreateResp": { "properties": { "output": { "type": "string" } }, "type": "object" }, "dto.AgentRoleDeleteReq": { "properties": { "agentId": { "type": "integer" }, "id": { "type": "string" } }, "required": [ "agentId", "id" ], "type": "object" }, "dto.AgentRoleMarkdownFileItem": { "properties": { "content": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.AgentRoleMarkdownFileUpdateItem": { "properties": { "content": { "type": "string" }, "name": { "enum": [ "AGENTS.md", "SOUL.md", "USER.md", "IDENTITY.md", "TOOLS.md", "HEARTBEAT.md", "BOOT.md", "BOOTSTRAP.md" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.AgentRoleMarkdownFilesReq": { "properties": { "agentId": { "type": "integer" }, "workspace": { "type": "string" } }, "required": [ "agentId", "workspace" ], "type": "object" }, "dto.AgentRoleMarkdownFilesUpdateReq": { "properties": { "agentId": { "type": "integer" }, "files": { "items": { "$ref": "#/definitions/dto.AgentRoleMarkdownFileUpdateItem" }, "type": "array" }, "restart": { "type": "boolean" }, "workspace": { "type": "string" } }, "required": [ "agentId", "files", "workspace" ], "type": "object" }, "dto.AgentSecurityConfig": { "properties": { "allowedOrigins": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.AgentSecurityConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "allowedOrigins": { "items": { "type": "string" }, "type": "array" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentSettingUpdate": { "properties": { "key": { "enum": [ "SystemIP", "DockerSockPath", "FileRecycleBin" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.AgentSkillInstallReq": { "properties": { "agentId": { "type": "integer" }, "slug": { "type": "string" }, "source": { "enum": [ "clawhub-global", "clawhub-cn", "skillhub", "official", "skills-sh", "local-hub" ], "type": "string" }, "taskID": { "type": "string" } }, "required": [ "agentId", "slug", "source", "taskID" ], "type": "object" }, "dto.AgentSkillItem": { "properties": { "bundled": { "type": "boolean" }, "category": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "trust": { "type": "string" }, "uninstallable": { "type": "boolean" } }, "type": "object" }, "dto.AgentSkillSearchItem": { "properties": { "description": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "score": { "type": "string" }, "slug": { "type": "string" }, "source": { "type": "string" }, "summary": { "type": "string" }, "trust": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.AgentSkillSearchReq": { "properties": { "agentId": { "type": "integer" }, "keyword": { "type": "string" }, "source": { "enum": [ "clawhub-global", "clawhub-cn", "skillhub", "official", "skills-sh", "local-hub" ], "type": "string" } }, "required": [ "agentId", "keyword", "source" ], "type": "object" }, "dto.AgentSkillUninstallReq": { "properties": { "agentId": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "agentId", "name" ], "type": "object" }, "dto.AgentSkillUpdateReq": { "properties": { "agentId": { "type": "integer" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "agentId", "name" ], "type": "object" }, "dto.AgentTelegramBot": { "properties": { "accountId": { "type": "string" }, "botToken": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupPolicy": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "streaming": { "type": "string" } }, "type": "object" }, "dto.AgentTelegramConfig": { "properties": { "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentTelegramBot" }, "type": "array" }, "defaultAccount": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" }, "proxy": { "type": "string" }, "requireMention": { "type": "boolean" }, "streaming": { "type": "string" } }, "type": "object" }, "dto.AgentTelegramConfigReq": { "properties": { "agentId": { "type": "integer" } }, "required": [ "agentId" ], "type": "object" }, "dto.AgentTelegramConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "bots": { "items": { "$ref": "#/definitions/dto.AgentTelegramBot" }, "minItems": 1, "type": "array" }, "defaultAccount": { "type": "string" }, "dmPolicy": { "enum": [ "pairing", "open", "allowlist", "disabled" ], "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "enum": [ "open", "allowlist", "disabled" ], "type": "string" }, "proxy": { "type": "string" }, "requireMention": { "type": "boolean" }, "streaming": { "enum": [ "off", "partial", "block", "progress" ], "type": "string" } }, "required": [ "agentId", "bots", "defaultAccount", "dmPolicy", "groupPolicy", "streaming" ], "type": "object" }, "dto.AgentTokenResetReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.AgentWebsiteBindReq": { "properties": { "agentId": { "type": "integer" }, "websiteId": { "type": "integer" } }, "required": [ "agentId", "websiteId" ], "type": "object" }, "dto.AgentWecomConfig": { "properties": { "allowFrom": { "items": { "type": "string" }, "type": "array" }, "botId": { "type": "string" }, "dmPolicy": { "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "type": "string" }, "installed": { "type": "boolean" }, "secret": { "type": "string" } }, "type": "object" }, "dto.AgentWecomConfigUpdateReq": { "properties": { "agentId": { "type": "integer" }, "allowFrom": { "items": { "type": "string" }, "type": "array" }, "botId": { "type": "string" }, "dmPolicy": { "enum": [ "pairing", "open", "allowlist", "disabled" ], "type": "string" }, "enabled": { "type": "boolean" }, "groupAllowFrom": { "items": { "type": "string" }, "type": "array" }, "groupPolicy": { "enum": [ "open", "allowlist", "disabled" ], "type": "string" }, "secret": { "type": "string" } }, "required": [ "agentId", "botId", "dmPolicy", "groupPolicy", "secret" ], "type": "object" }, "dto.AgentWeixinConfig": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "dto.AgentWeixinLoginReq": { "properties": { "agentId": { "type": "integer" }, "taskID": { "type": "string" } }, "required": [ "agentId", "taskID" ], "type": "object" }, "dto.AlertConfigPageReq": { "properties": { "excludeTypes": { "items": { "type": "string" }, "type": "array" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.AlertConfigTest": { "properties": { "displayName": { "type": "string" }, "encryption": { "description": "\"ssl\" / \"tls\" / \"none\"", "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "recipient": { "type": "string" }, "sender": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "dto.AlertConfigUpdate": { "properties": { "config": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.AlertCreate": { "properties": { "advancedParams": { "type": "string" }, "count": { "type": "integer" }, "cycle": { "type": "integer" }, "method": { "type": "string" }, "project": { "type": "string" }, "sendCount": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "method", "type" ], "type": "object" }, "dto.AlertLogSearch": { "properties": { "count": { "type": "integer" }, "endTime": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "startTime": { "type": "string" }, "status": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.AlertSearch": { "properties": { "method": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "created_at" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.AlertUpdate": { "properties": { "advancedParams": { "type": "string" }, "count": { "type": "integer" }, "cycle": { "type": "integer" }, "id": { "type": "integer" }, "method": { "type": "string" }, "project": { "type": "string" }, "sendCount": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "dto.AlertUpdateStatus": { "properties": { "id": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "type": "object" }, "dto.ApiInterfaceConfig": { "properties": { "apiInterfaceStatus": { "type": "string" }, "apiKey": { "type": "string" }, "apiKeyValidityTime": { "type": "integer" }, "apiTrustedProxies": { "type": "string" }, "ipWhiteList": { "type": "string" } }, "type": "object" }, "dto.AppConfigVersion": { "properties": { "additionalProperties": {}, "downloadCallBackUrl": { "type": "string" }, "downloadUrl": { "type": "string" }, "lastModified": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.AppDefine": { "properties": { "additionalProperties": { "$ref": "#/definitions/dto.AppProperty" }, "icon": { "type": "string" }, "lastModified": { "type": "integer" }, "name": { "type": "string" }, "readMe": { "type": "string" }, "versions": { "items": { "$ref": "#/definitions/dto.AppConfigVersion" }, "type": "array" } }, "type": "object" }, "dto.AppInstallInfo": { "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.AppLauncher": { "properties": { "description": { "type": "string" }, "detail": { "items": { "$ref": "#/definitions/dto.InstallDetail" }, "type": "array" }, "icon": { "type": "string" }, "isInstall": { "type": "boolean" }, "isRecommend": { "type": "boolean" }, "key": { "type": "string" }, "limit": { "type": "integer" }, "name": { "type": "string" }, "recommend": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "dto.AppList": { "properties": { "additionalProperties": { "$ref": "#/definitions/dto.ExtraProperties" }, "apps": { "items": { "$ref": "#/definitions/dto.AppDefine" }, "type": "array" }, "lastModified": { "type": "integer" }, "valid": { "type": "boolean" }, "violations": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.AppProperty": { "properties": { "Required": { "items": { "type": "string" }, "type": "array" }, "architectures": { "items": { "type": "string" }, "type": "array" }, "batchInstallSupport": { "type": "boolean" }, "crossVersionUpdate": { "type": "boolean" }, "deprecated": { "type": "number" }, "description": { "$ref": "#/definitions/dto.Locale" }, "document": { "type": "string" }, "github": { "type": "string" }, "gpuSupport": { "type": "boolean" }, "key": { "type": "string" }, "limit": { "type": "integer" }, "memoryRequired": { "type": "integer" }, "name": { "type": "string" }, "recommend": { "type": "integer" }, "shortDescEn": { "type": "string" }, "shortDescZh": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "version": { "type": "number" }, "website": { "type": "string" } }, "type": "object" }, "dto.AppResource": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.AppVersion": { "properties": { "detailId": { "type": "integer" }, "dockerCompose": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.AppstoreConfig": { "properties": { "installAllowPort": { "type": "string" }, "uninstallDeleteBackup": { "type": "string" }, "uninstallDeleteImage": { "type": "string" }, "upgradeBackup": { "type": "string" }, "upgradeDeleteImage": { "type": "string" } }, "type": "object" }, "dto.AppstoreUpdate": { "properties": { "scope": { "enum": [ "UninstallDeleteImage", "UpgradeBackup", "UpgradeDeleteImage", "UninstallDeleteBackup", "InstallAllowPort" ], "type": "string" }, "status": { "enum": [ "Disable", "Enable" ], "type": "string" } }, "required": [ "scope", "status" ], "type": "object" }, "dto.BackupClientInfo": { "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "redirect_uri": { "type": "string" } }, "type": "object" }, "dto.BackupOperate": { "properties": { "accessKey": { "type": "string" }, "backupPath": { "type": "string" }, "bucket": { "type": "string" }, "credential": { "type": "string" }, "id": { "type": "integer" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "rememberAuth": { "type": "boolean" }, "type": { "type": "string" }, "vars": { "type": "string" } }, "required": [ "type", "vars" ], "type": "object" }, "dto.BackupOption": { "properties": { "id": { "type": "integer" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.BatchDelete": { "properties": { "force": { "type": "boolean" }, "names": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" } }, "required": [ "names" ], "type": "object" }, "dto.BatchDeleteReq": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "dto.BindInfo": { "properties": { "bindAddress": { "type": "string" }, "ipv6": { "enum": [ "Enable", "Disable" ], "type": "string" } }, "required": [ "bindAddress", "ipv6" ], "type": "object" }, "dto.CaptchaResponse": { "properties": { "captchaID": { "type": "string" }, "imagePath": { "type": "string" } }, "type": "object" }, "dto.ChangeDBInfo": { "properties": { "database": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "id": { "type": "integer" }, "type": { "enum": [ "mysql", "mariadb", "postgresql", "redis", "mongodb", "mysql-cluster", "postgresql-cluster", "redis-cluster" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "database", "from", "type", "value" ], "type": "object" }, "dto.ChangeGroup": { "properties": { "groupID": { "type": "integer" }, "id": { "type": "integer" } }, "required": [ "groupID", "id" ], "type": "object" }, "dto.ChangePasswd": { "properties": { "passwd": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "dto.ChangeQuicks": { "properties": { "quicks": { "items": { "$ref": "#/definitions/dto.QuickJump" }, "type": "array" } }, "type": "object" }, "dto.ChangeRedisPass": { "properties": { "database": { "type": "string" }, "value": { "type": "string" } }, "required": [ "database" ], "type": "object" }, "dto.ClamBaseInfo": { "properties": { "freshIsActive": { "type": "boolean" }, "freshIsExist": { "type": "boolean" }, "freshVersion": { "type": "string" }, "isActive": { "type": "boolean" }, "isExist": { "type": "boolean" }, "version": { "type": "string" } }, "type": "object" }, "dto.ClamCreate": { "properties": { "alertCount": { "type": "integer" }, "alertMethod": { "type": "string" }, "alertTitle": { "type": "string" }, "description": { "type": "string" }, "infectedDir": { "type": "string" }, "infectedStrategy": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "spec": { "type": "string" }, "status": { "type": "string" }, "timeout": { "type": "integer" } }, "type": "object" }, "dto.ClamDelete": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" }, "removeInfected": { "type": "boolean" } }, "required": [ "ids" ], "type": "object" }, "dto.ClamFileReq": { "properties": { "name": { "type": "string" }, "tail": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.ClamLogSearch": { "properties": { "clamID": { "type": "integer" }, "endTime": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "startTime": { "type": "string" }, "status": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.ClamUpdate": { "properties": { "alertCount": { "type": "integer" }, "alertMethod": { "type": "string" }, "alertTitle": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "infectedDir": { "type": "string" }, "infectedStrategy": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "spec": { "type": "string" }, "timeout": { "type": "integer" } }, "type": "object" }, "dto.ClamUpdateStatus": { "properties": { "id": { "type": "integer" }, "status": { "type": "string" } }, "type": "object" }, "dto.Clean": { "properties": { "name": { "type": "string" }, "size": { "type": "integer" }, "treeType": { "type": "string" } }, "type": "object" }, "dto.CleanData": { "properties": { "backupClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "containerClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "downloadClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "systemClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "systemLogClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "uploadClean": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" } }, "type": "object" }, "dto.CleanLog": { "properties": { "logType": { "enum": [ "login", "operation" ], "type": "string" } }, "required": [ "logType" ], "type": "object" }, "dto.CleanTree": { "properties": { "canDelete": { "type": "boolean" }, "children": { "items": { "$ref": "#/definitions/dto.CleanTree" }, "type": "array" }, "id": { "type": "string" }, "isCheck": { "type": "boolean" }, "isRecommend": { "type": "boolean" }, "label": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "dto.CommandInfo": { "properties": { "command": { "type": "string" }, "groupBelong": { "type": "string" }, "groupID": { "type": "integer" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.CommandOperate": { "properties": { "command": { "type": "string" }, "groupBelong": { "type": "string" }, "groupID": { "type": "integer" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "command", "name" ], "type": "object" }, "dto.CommandTree": { "properties": { "children": { "items": { "$ref": "#/definitions/dto.CommandTree" }, "type": "array" }, "label": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "dto.CommonBackup": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "detailName": { "type": "string" }, "fileName": { "type": "string" }, "isImmediate": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "string" }, "stopBefore": { "type": "boolean" }, "taskID": { "type": "string" }, "type": { "enum": [ "app", "mysql", "mariadb", "redis", "website", "postgresql", "mongodb", "mysql-cluster", "postgresql-cluster", "redis-cluster", "container", "compose" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "dto.CommonDescription": { "properties": { "description": { "type": "string" }, "detailType": { "type": "string" }, "id": { "type": "string" }, "isPinned": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "dto.CommonRecover": { "properties": { "backupRecordID": { "type": "integer" }, "detailName": { "type": "string" }, "downloadAccountID": { "type": "integer" }, "dropAllCollections": { "type": "boolean" }, "file": { "type": "string" }, "name": { "type": "string" }, "secret": { "type": "string" }, "taskID": { "type": "string" }, "timeout": { "type": "integer" }, "type": { "enum": [ "app", "mysql", "mariadb", "redis", "website", "postgresql", "mongodb", "mysql-cluster", "postgresql-cluster", "redis-cluster", "container", "compose" ], "type": "string" } }, "required": [ "downloadAccountID", "type" ], "type": "object" }, "dto.ComposeCreate": { "properties": { "dirName": { "type": "string" }, "env": { "type": "string" }, "file": { "type": "string" }, "forcePull": { "type": "boolean" }, "from": { "enum": [ "edit", "path", "template" ], "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "taskID": { "type": "string" }, "template": { "type": "integer" } }, "required": [ "from" ], "type": "object" }, "dto.ComposeLogClean": { "properties": { "detailPath": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" } }, "required": [ "name", "path" ], "type": "object" }, "dto.ComposeOperation": { "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "operation": { "enum": [ "up", "start", "restart", "stop", "down", "delete", "rebuild" ], "type": "string" }, "path": { "type": "string" }, "withFile": { "type": "boolean" } }, "required": [ "name", "operation" ], "type": "object" }, "dto.ComposePin": { "properties": { "isPinned": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.ComposeTemplateBatch": { "properties": { "templates": { "items": { "$ref": "#/definitions/dto.ComposeTemplateCreate" }, "type": "array" } }, "required": [ "templates" ], "type": "object" }, "dto.ComposeTemplateCreate": { "properties": { "content": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.ComposeTemplateInfo": { "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.ComposeTemplateUpdate": { "properties": { "content": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "dto.ComposeUpdate": { "properties": { "content": { "type": "string" }, "detailPath": { "type": "string" }, "env": { "type": "string" }, "forcePull": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "content", "name", "path" ], "type": "object" }, "dto.ContainerCommit": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "containerID": { "type": "string" }, "containerName": { "type": "string" }, "newImageName": { "type": "string" }, "pause": { "type": "boolean" }, "taskID": { "type": "string" } }, "required": [ "containerID" ], "type": "object" }, "dto.ContainerFileBatchDeleteReq": { "properties": { "containerID": { "type": "string" }, "paths": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "containerID", "paths" ], "type": "object" }, "dto.ContainerFileContent": { "properties": { "content": { "type": "string" }, "isBinary": { "type": "boolean" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" } }, "type": "object" }, "dto.ContainerFileInfo": { "properties": { "isDir": { "type": "boolean" }, "isLink": { "type": "boolean" }, "linkTo": { "type": "string" }, "modTime": { "type": "string" }, "mode": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "dto.ContainerFileReq": { "properties": { "containerID": { "type": "string" }, "path": { "type": "string" } }, "required": [ "containerID", "path" ], "type": "object" }, "dto.ContainerItemStats": { "properties": { "buildCacheReclaimable": { "type": "integer" }, "buildCacheUsage": { "type": "integer" }, "containerReclaimable": { "type": "integer" }, "containerUsage": { "type": "integer" }, "imageReclaimable": { "type": "integer" }, "imageUsage": { "type": "integer" }, "sizeRootFs": { "type": "integer" }, "sizeRw": { "type": "integer" }, "volumeReclaimable": { "type": "integer" }, "volumeUsage": { "type": "integer" } }, "type": "object" }, "dto.ContainerListStats": { "properties": { "containerID": { "type": "string" }, "cpuPercent": { "type": "number" }, "cpuTotalUsage": { "type": "integer" }, "memoryCache": { "type": "integer" }, "memoryLimit": { "type": "integer" }, "memoryPercent": { "type": "number" }, "memoryUsage": { "type": "integer" }, "percpuUsage": { "type": "integer" }, "systemUsage": { "type": "integer" } }, "type": "object" }, "dto.ContainerLog": { "properties": { "container": { "type": "string" }, "containerType": { "type": "string" }, "since": { "type": "string" }, "tail": { "type": "integer" }, "timestamp": { "type": "boolean" } }, "required": [ "container" ], "type": "object" }, "dto.ContainerNetwork": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "driverOpts": { "additionalProperties": { "type": "string" }, "type": "object" }, "gwPriority": { "type": "integer" }, "ipv4": { "type": "string" }, "ipv6": { "type": "string" }, "linkLocalIPs": { "items": { "type": "string" }, "type": "array" }, "links": { "items": { "type": "string" }, "type": "array" }, "macAddr": { "type": "string" }, "network": { "type": "string" } }, "type": "object" }, "dto.ContainerOperate": { "properties": { "autoRemove": { "type": "boolean" }, "cmd": { "items": { "type": "string" }, "type": "array" }, "cpuShares": { "type": "integer" }, "dns": { "items": { "type": "string" }, "type": "array" }, "domainName": { "type": "string" }, "entrypoint": { "items": { "type": "string" }, "type": "array" }, "env": { "items": { "type": "string" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/dto.PortHelper" }, "type": "array" }, "extraHosts": { "items": { "$ref": "#/definitions/dto.ExtraHost" }, "type": "array" }, "forcePull": { "type": "boolean" }, "hostname": { "type": "string" }, "image": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "memory": { "type": "number" }, "name": { "type": "string" }, "nanoCPUs": { "type": "number" }, "networks": { "items": { "$ref": "#/definitions/dto.ContainerNetwork" }, "type": "array" }, "openStdin": { "type": "boolean" }, "privileged": { "type": "boolean" }, "publishAllPorts": { "type": "boolean" }, "restartPolicy": { "type": "string" }, "taskID": { "type": "string" }, "tty": { "type": "boolean" }, "user": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/dto.VolumeHelper" }, "type": "array" }, "workingDir": { "type": "string" } }, "required": [ "image", "name" ], "type": "object" }, "dto.ContainerOperation": { "properties": { "names": { "items": { "type": "string" }, "type": "array" }, "operation": { "enum": [ "up", "start", "stop", "restart", "kill", "pause", "unpause", "remove" ], "type": "string" }, "taskID": { "type": "string" } }, "required": [ "names", "operation" ], "type": "object" }, "dto.ContainerOptions": { "properties": { "name": { "type": "string" }, "state": { "type": "string" } }, "type": "object" }, "dto.ContainerPrune": { "properties": { "pruneType": { "enum": [ "container", "image", "volume", "network", "buildcache" ], "type": "string" }, "taskID": { "type": "string" }, "withTagAll": { "type": "boolean" } }, "required": [ "pruneType" ], "type": "object" }, "dto.ContainerRename": { "properties": { "name": { "type": "string" }, "newName": { "type": "string" } }, "required": [ "name", "newName" ], "type": "object" }, "dto.ContainerStats": { "properties": { "cache": { "type": "number" }, "cpuPercent": { "type": "number" }, "ioRead": { "type": "number" }, "ioWrite": { "type": "number" }, "memory": { "type": "number" }, "networkRX": { "type": "number" }, "networkTX": { "type": "number" }, "shotTime": { "type": "string" } }, "type": "object" }, "dto.ContainerStatus": { "properties": { "composeCount": { "type": "integer" }, "composeTemplateCount": { "type": "integer" }, "containerCount": { "type": "integer" }, "created": { "type": "integer" }, "dead": { "type": "integer" }, "exited": { "type": "integer" }, "imageCount": { "type": "integer" }, "networkCount": { "type": "integer" }, "paused": { "type": "integer" }, "removing": { "type": "integer" }, "repoCount": { "type": "integer" }, "restarting": { "type": "integer" }, "running": { "type": "integer" }, "volumeCount": { "type": "integer" } }, "type": "object" }, "dto.ContainerUpgrade": { "properties": { "forcePull": { "type": "boolean" }, "image": { "type": "string" }, "names": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" } }, "required": [ "image", "names" ], "type": "object" }, "dto.CronJobReq": { "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.CronjobBatchDelete": { "properties": { "cleanData": { "type": "boolean" }, "cleanRemoteData": { "type": "boolean" }, "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "dto.CronjobClean": { "properties": { "cleanData": { "type": "boolean" }, "cleanRemoteData": { "type": "boolean" }, "cronjobID": { "type": "integer" }, "isDelete": { "type": "boolean" } }, "required": [ "cronjobID" ], "type": "object" }, "dto.CronjobImport": { "properties": { "cronjobs": { "items": { "$ref": "#/definitions/dto.CronjobTrans" }, "type": "array" } }, "type": "object" }, "dto.CronjobOperate": { "properties": { "alertCount": { "type": "integer" }, "alertMethod": { "type": "string" }, "alertTitle": { "type": "string" }, "appID": { "type": "string" }, "args": { "type": "string" }, "command": { "type": "string" }, "containerName": { "type": "string" }, "dbName": { "type": "string" }, "dbType": { "type": "string" }, "downloadAccountID": { "type": "integer" }, "exclusionRules": { "type": "string" }, "executor": { "type": "string" }, "groupID": { "type": "integer" }, "id": { "type": "integer" }, "ignoreErr": { "type": "boolean" }, "isDir": { "type": "boolean" }, "name": { "type": "string" }, "retainCopies": { "minimum": 1, "type": "integer" }, "retryTimes": { "minimum": 0, "type": "integer" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "script": { "type": "string" }, "scriptID": { "type": "integer" }, "scriptMode": { "type": "string" }, "secret": { "type": "string" }, "snapshotRule": { "$ref": "#/definitions/dto.SnapshotRule" }, "sourceAccountIDs": { "type": "string" }, "sourceDir": { "type": "string" }, "spec": { "type": "string" }, "specCustom": { "type": "boolean" }, "timeout": { "minimum": 1, "type": "integer" }, "type": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "website": { "type": "string" } }, "required": [ "name", "spec", "type" ], "type": "object" }, "dto.CronjobSpec": { "properties": { "spec": { "type": "string" } }, "required": [ "spec" ], "type": "object" }, "dto.CronjobTrans": { "properties": { "alertCount": { "type": "integer" }, "alertMethod": { "type": "string" }, "alertTitle": { "type": "string" }, "apps": { "items": { "$ref": "#/definitions/dto.TransHelper" }, "type": "array" }, "args": { "type": "string" }, "command": { "type": "string" }, "containerName": { "type": "string" }, "dbName": { "items": { "$ref": "#/definitions/dto.TransHelper" }, "type": "array" }, "dbType": { "type": "string" }, "downloadAccount": { "type": "string" }, "exclusionRules": { "type": "string" }, "executor": { "type": "string" }, "groupID": { "type": "integer" }, "ignoreErr": { "type": "boolean" }, "isDir": { "type": "boolean" }, "name": { "type": "string" }, "retainCopies": { "type": "integer" }, "retryTimes": { "type": "integer" }, "script": { "type": "string" }, "scriptMode": { "type": "string" }, "scriptName": { "type": "string" }, "secret": { "type": "string" }, "snapshotRule": { "$ref": "#/definitions/dto.SnapshotTransHelper" }, "sourceAccounts": { "items": { "type": "string" }, "type": "array" }, "sourceDir": { "type": "string" }, "spec": { "type": "string" }, "specCustom": { "type": "boolean" }, "timeout": { "type": "integer" }, "type": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "websites": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.CronjobUpdateStatus": { "properties": { "id": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "type": "object" }, "dto.CurrentUserInfo": { "properties": { "apiInterfaceStatus": { "type": "string" }, "apiKey": { "type": "string" }, "apiKeyValidityTime": { "type": "integer" }, "apiTrustedProxies": { "type": "string" }, "authSource": { "type": "string" }, "authSourceStatus": { "type": "string" }, "complexitySetting": { "type": "string" }, "ipWhiteList": { "type": "string" }, "mfaInterval": { "type": "integer" }, "mfaStatus": { "type": "string" }, "name": { "type": "string" }, "nodeRoles": { "items": { "$ref": "#/definitions/dto.CurrentUserNodeRole" }, "type": "array" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "role": { "type": "string" } }, "type": "object" }, "dto.CurrentUserNodeRole": { "properties": { "nodeId": { "type": "integer" }, "nodeName": { "type": "string" }, "roleId": { "type": "integer" }, "roleName": { "type": "string" } }, "type": "object" }, "dto.CurrentUserUpdate": { "properties": { "name": { "type": "string" }, "oldPassword": { "type": "string" }, "password": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.DBBaseInfo": { "properties": { "containerName": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" } }, "type": "object" }, "dto.DBConfUpdateByFile": { "properties": { "database": { "type": "string" }, "file": { "type": "string" }, "type": { "enum": [ "mysql", "mariadb", "postgresql", "redis", "mysql-cluster", "postgresql-cluster", "redis-cluster" ], "type": "string" } }, "required": [ "database", "type" ], "type": "object" }, "dto.DaemonJsonConf": { "properties": { "cgroupDriver": { "type": "string" }, "experimental": { "type": "boolean" }, "fixedCidrV6": { "type": "string" }, "insecureRegistries": { "items": { "type": "string" }, "type": "array" }, "ip6Tables": { "type": "boolean" }, "iptables": { "type": "boolean" }, "ipv6": { "type": "boolean" }, "isSwarm": { "type": "boolean" }, "liveRestore": { "type": "boolean" }, "logMaxFile": { "type": "string" }, "logMaxSize": { "type": "string" }, "registryMirrors": { "items": { "type": "string" }, "type": "array" }, "version": { "type": "string" } }, "type": "object" }, "dto.DaemonJsonUpdateByFile": { "properties": { "file": { "type": "string" } }, "type": "object" }, "dto.DashboardBase": { "properties": { "agentNumber": { "type": "integer" }, "appInstalledNumber": { "type": "integer" }, "cpuCores": { "type": "integer" }, "cpuLogicalCores": { "type": "integer" }, "cpuMhz": { "type": "number" }, "cpuModelName": { "type": "string" }, "cronjobNumber": { "type": "integer" }, "currentInfo": { "$ref": "#/definitions/dto.DashboardCurrent" }, "databaseNumber": { "type": "integer" }, "hostname": { "type": "string" }, "ipV4Addr": { "type": "string" }, "kernelArch": { "type": "string" }, "kernelVersion": { "type": "string" }, "os": { "type": "string" }, "platform": { "type": "string" }, "platformFamily": { "type": "string" }, "platformVersion": { "type": "string" }, "prettyDistro": { "type": "string" }, "quickJump": { "items": { "$ref": "#/definitions/dto.QuickJump" }, "type": "array" }, "systemProxy": { "type": "string" }, "virtualizationSystem": { "type": "string" }, "websiteNumber": { "type": "integer" } }, "type": "object" }, "dto.DashboardCurrent": { "properties": { "cpuDetailedPercent": { "items": { "type": "number" }, "type": "array" }, "cpuPercent": { "items": { "type": "number" }, "type": "array" }, "cpuTotal": { "type": "integer" }, "cpuUsed": { "type": "number" }, "cpuUsedPercent": { "type": "number" }, "diskData": { "items": { "$ref": "#/definitions/dto.DiskInfo" }, "type": "array" }, "gpuData": { "items": { "$ref": "#/definitions/dto.GPUInfo" }, "type": "array" }, "ioCount": { "type": "integer" }, "ioReadBytes": { "type": "integer" }, "ioReadTime": { "type": "integer" }, "ioWriteBytes": { "type": "integer" }, "ioWriteTime": { "type": "integer" }, "load1": { "type": "number" }, "load15": { "type": "number" }, "load5": { "type": "number" }, "loadUsagePercent": { "type": "number" }, "memoryAvailable": { "type": "integer" }, "memoryCache": { "type": "integer" }, "memoryFree": { "type": "integer" }, "memoryShard": { "type": "integer" }, "memoryTotal": { "type": "integer" }, "memoryUsed": { "type": "integer" }, "memoryUsedPercent": { "type": "number" }, "netBytesRecv": { "type": "integer" }, "netBytesSent": { "type": "integer" }, "procs": { "type": "integer" }, "runningTime": { "$ref": "#/definitions/dto.RunningTime" }, "shotTime": { "type": "string" }, "swapMemoryAvailable": { "type": "integer" }, "swapMemoryTotal": { "type": "integer" }, "swapMemoryUsed": { "type": "integer" }, "swapMemoryUsedPercent": { "type": "number" }, "timeSinceUptime": { "type": "string" }, "topCPUItems": { "items": { "$ref": "#/definitions/dto.Process" }, "type": "array" }, "topMemItems": { "items": { "$ref": "#/definitions/dto.Process" }, "type": "array" }, "uptime": { "type": "integer" }, "xpuData": { "items": { "$ref": "#/definitions/dto.XPUInfo" }, "type": "array" } }, "type": "object" }, "dto.DataTree": { "properties": { "children": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "id": { "type": "string" }, "isCheck": { "type": "boolean" }, "isDisable": { "type": "boolean" }, "isLocal": { "type": "boolean" }, "key": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "relationItemID": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "dto.DatabaseCreate": { "properties": { "address": { "type": "string" }, "clientCert": { "type": "string" }, "clientKey": { "type": "string" }, "description": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "initialDB": { "type": "string" }, "name": { "maxLength": 256, "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "rootCert": { "type": "string" }, "skipVerify": { "type": "boolean" }, "ssl": { "type": "boolean" }, "timeout": { "type": "integer" }, "type": { "type": "string" }, "username": { "type": "string" }, "version": { "type": "string" } }, "required": [ "from", "name", "type", "username", "version" ], "type": "object" }, "dto.DatabaseDelete": { "properties": { "deleteBackup": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.DatabaseInfo": { "properties": { "address": { "type": "string" }, "clientCert": { "type": "string" }, "clientKey": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "initialDB": { "type": "string" }, "name": { "maxLength": 256, "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "rootCert": { "type": "string" }, "skipVerify": { "type": "boolean" }, "ssl": { "type": "boolean" }, "timeout": { "type": "integer" }, "type": { "type": "string" }, "username": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.DatabaseItem": { "properties": { "database": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.DatabaseOption": { "properties": { "address": { "type": "string" }, "database": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "type": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.DatabaseSearch": { "properties": { "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.DatabaseUpdate": { "properties": { "address": { "type": "string" }, "clientCert": { "type": "string" }, "clientKey": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "initialDB": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "rootCert": { "type": "string" }, "skipVerify": { "type": "boolean" }, "ssl": { "type": "boolean" }, "timeout": { "type": "integer" }, "type": { "type": "string" }, "username": { "type": "string" }, "version": { "type": "string" } }, "required": [ "type", "username", "version" ], "type": "object" }, "dto.DeleteRequest": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.DeviceBaseInfo": { "properties": { "dns": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "hosts": { "items": { "$ref": "#/definitions/dto.HostHelper" }, "type": "array" }, "localTime": { "type": "string" }, "maxSize": { "type": "integer" }, "ntp": { "type": "string" }, "swapDetails": { "items": { "$ref": "#/definitions/dto.SwapHelper" }, "type": "array" }, "swapMemoryAvailable": { "type": "integer" }, "swapMemoryTotal": { "type": "integer" }, "swapMemoryUsed": { "type": "integer" }, "timeZone": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "dto.DiskInfo": { "properties": { "device": { "type": "string" }, "free": { "type": "integer" }, "inodesFree": { "type": "integer" }, "inodesTotal": { "type": "integer" }, "inodesUsed": { "type": "integer" }, "inodesUsedPercent": { "type": "number" }, "path": { "type": "string" }, "total": { "type": "integer" }, "type": { "type": "string" }, "used": { "type": "integer" }, "usedPercent": { "type": "number" } }, "type": "object" }, "dto.DockerOperation": { "properties": { "operation": { "enum": [ "start", "restart", "stop" ], "type": "string" } }, "required": [ "operation" ], "type": "object" }, "dto.DockerPortGuardBase": { "properties": { "backend": { "type": "string" }, "bound": { "type": "boolean" }, "initialized": { "type": "boolean" }, "ipv4": { "$ref": "#/definitions/dto.DockerPortGuardFamilyStatus" }, "ipv6": { "$ref": "#/definitions/dto.DockerPortGuardFamilyStatus" }, "message": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.DockerPortGuardContainer": { "properties": { "application": { "type": "string" }, "compose": { "type": "string" }, "endpoints": { "items": { "$ref": "#/definitions/dto.DockerPortGuardEndpoint" }, "type": "array" }, "key": { "type": "string" }, "name": { "type": "string" }, "portGroups": { "items": { "$ref": "#/definitions/dto.DockerPortGuardPortGroup" }, "type": "array" } }, "type": "object" }, "dto.DockerPortGuardEndpoint": { "properties": { "application": { "type": "string" }, "compose": { "type": "string" }, "containerID": { "type": "string" }, "containerName": { "type": "string" }, "containerPort": { "type": "integer" }, "description": { "type": "string" }, "effective": { "type": "boolean" }, "family": { "type": "string" }, "hostIP": { "type": "string" }, "hostPort": { "type": "integer" }, "mode": { "type": "string" }, "policyUUID": { "type": "string" }, "protocol": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.DockerPortGuardEndpointIdentity": { "properties": { "family": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "hostIP": { "maxLength": 45, "type": "string" }, "hostPort": { "minimum": 1, "type": "integer" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" } }, "required": [ "family", "hostIP", "hostPort", "protocol" ], "type": "object" }, "dto.DockerPortGuardFamilyStatus": { "properties": { "bound": { "type": "boolean" }, "effective": { "type": "boolean" }, "initialized": { "type": "boolean" }, "reason": { "type": "string" }, "state": { "type": "string" } }, "type": "object" }, "dto.DockerPortGuardList": { "properties": { "base": { "$ref": "#/definitions/dto.DockerPortGuardBase" }, "containers": { "items": { "$ref": "#/definitions/dto.DockerPortGuardContainer" }, "type": "array" } }, "type": "object" }, "dto.DockerPortGuardOperation": { "properties": { "operation": { "enum": [ "initialize", "bind", "unbind" ], "type": "string" }, "taskID": { "maxLength": 64, "type": "string" } }, "required": [ "operation" ], "type": "object" }, "dto.DockerPortGuardPolicy": { "properties": { "description": { "maxLength": 256, "type": "string" }, "family": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "hostIP": { "maxLength": 45, "type": "string" }, "hostPort": { "minimum": 1, "type": "integer" }, "mode": { "enum": [ "deny_sources", "allow_sources", "deny_all" ], "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" } }, "required": [ "family", "hostIP", "hostPort", "mode", "protocol" ], "type": "object" }, "dto.DockerPortGuardPolicyBatch": { "properties": { "policies": { "items": { "$ref": "#/definitions/dto.DockerPortGuardPolicy" }, "minItems": 1, "type": "array" } }, "required": [ "policies" ], "type": "object" }, "dto.DockerPortGuardPolicyBatchDelete": { "properties": { "uuids": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "uuids" ], "type": "object" }, "dto.DockerPortGuardPortGroup": { "properties": { "endpoint": { "$ref": "#/definitions/dto.DockerPortGuardEndpoint" }, "endpoints": { "items": { "$ref": "#/definitions/dto.DockerPortGuardEndpoint" }, "type": "array" }, "key": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "dto.DockerStatus": { "properties": { "isActive": { "type": "boolean" }, "isExist": { "type": "boolean" } }, "type": "object" }, "dto.DownloadRecord": { "properties": { "downloadAccountID": { "type": "integer" }, "fileDir": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "downloadAccountID", "fileDir", "fileName" ], "type": "object" }, "dto.ExtraHost": { "properties": { "hostname": { "type": "string" }, "ip": { "type": "string" } }, "type": "object" }, "dto.ExtraProperties": { "properties": { "tags": { "items": { "$ref": "#/definitions/dto.Tag" }, "type": "array" }, "version": { "type": "string" } }, "type": "object" }, "dto.Fail2BanBaseInfo": { "properties": { "banAction": { "type": "string" }, "banTime": { "type": "string" }, "findTime": { "type": "string" }, "isActive": { "type": "boolean" }, "isEnable": { "type": "boolean" }, "isExist": { "type": "boolean" }, "logPath": { "type": "string" }, "maxRetry": { "type": "integer" }, "port": { "type": "integer" }, "version": { "type": "string" } }, "type": "object" }, "dto.Fail2BanSearch": { "properties": { "status": { "enum": [ "banned", "ignore" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "dto.Fail2BanSet": { "properties": { "ips": { "items": { "type": "string" }, "type": "array" }, "operate": { "enum": [ "banned", "ignore" ], "type": "string" } }, "required": [ "operate" ], "type": "object" }, "dto.Fail2BanUpdate": { "properties": { "key": { "enum": [ "port", "bantime", "findtime", "maxretry", "banaction", "logpath", "port" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.FileManageAIInfo": { "properties": { "aiAccountId": { "type": "string" }, "aiStatus": { "type": "string" } }, "type": "object" }, "dto.FilePath": { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "dto.FilterChainOperation": { "properties": { "name": { "type": "string" }, "operate": { "enum": [ "init-base", "bind-base", "unbind-base" ], "type": "string" }, "taskID": { "maxLength": 64, "type": "string" } }, "required": [ "name", "operate" ], "type": "object" }, "dto.FilterChainOperationResponse": { "properties": { "queued": { "type": "boolean" }, "taskID": { "type": "string" } }, "type": "object" }, "dto.FirewallBackendFamilyStatus": { "properties": { "bound": { "type": "boolean" }, "initialized": { "type": "boolean" } }, "type": "object" }, "dto.FirewallBackendGroup": { "properties": { "current": { "type": "string" }, "options": { "items": { "$ref": "#/definitions/dto.FirewallBackendOption" }, "type": "array" }, "selected": { "type": "string" } }, "type": "object" }, "dto.FirewallBackendOperation": { "properties": { "backend": { "enum": [ "firewalld", "ufw", "iptables", "nftables" ], "type": "string" }, "operation": { "enum": [ "select", "initialize", "cleanup" ], "type": "string" }, "subsystem": { "enum": [ "system", "forwarding", "docker" ], "type": "string" } }, "required": [ "backend", "operation", "subsystem" ], "type": "object" }, "dto.FirewallBackendOption": { "properties": { "active": { "type": "boolean" }, "bound": { "type": "boolean" }, "implementation": { "type": "string" }, "initialized": { "type": "boolean" }, "installed": { "type": "boolean" }, "ipv4": { "$ref": "#/definitions/dto.FirewallBackendFamilyStatus" }, "ipv6": { "$ref": "#/definitions/dto.FirewallBackendFamilyStatus" }, "message": { "type": "string" }, "name": { "type": "string" }, "supported": { "type": "boolean" } }, "type": "object" }, "dto.FirewallInitializationTask": { "properties": { "taskID": { "maxLength": 64, "type": "string" } }, "type": "object" }, "dto.FirewallLifecycleOperation": { "properties": { "operation": { "enum": [ "start", "stop", "restart", "disableBanPing", "enableBanPing" ], "type": "string" }, "withDockerRestart": { "type": "boolean" } }, "required": [ "operation" ], "type": "object" }, "dto.FirewallNativeDetail": { "properties": { "name": { "type": "string" }, "nativeKind": { "allOf": [ { "$ref": "#/definitions/filter.NativeKind" } ], "enum": [ "zone_service", "ufw_application" ] }, "permanent": { "type": "boolean" }, "provider": { "enum": [ "firewalld", "ufw" ], "type": "string" } }, "required": [ "name", "nativeKind", "provider" ], "type": "object" }, "dto.FirewallPortWhitelistCreate": { "properties": { "rule": { "$ref": "#/definitions/filter.PortWhitelist" } }, "required": [ "rule" ], "type": "object" }, "dto.FirewallPortWhitelistDelete": { "properties": { "rule": { "$ref": "#/definitions/filter.PortWhitelist" } }, "required": [ "rule" ], "type": "object" }, "dto.FirewallPortWhitelistUpdate": { "properties": { "oldRule": { "$ref": "#/definitions/filter.PortWhitelist" }, "rule": { "$ref": "#/definitions/filter.PortWhitelist" } }, "required": [ "oldRule", "rule" ], "type": "object" }, "dto.FirewallRuleAdopt": { "type": "object", "required": [ "scope", "instanceKey" ], "properties": { "scope": { "$ref": "#/definitions/filter.Scope" }, "instanceKey": { "type": "string", "maxLength": 128 } } }, "dto.FirewallRuleCreate": { "properties": { "items": { "items": { "$ref": "#/definitions/dto.FirewallRuleCreateItem" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "dto.FirewallRuleCreateFailure": { "properties": { "error": { "type": "string" }, "index": { "type": "integer" }, "rule": { "$ref": "#/definitions/filter.FirewallRule" }, "status": { "type": "string" } }, "type": "object" }, "dto.FirewallRuleCreateItem": { "properties": { "rule": { "$ref": "#/definitions/filter.FirewallRule" }, "sourceID": { "type": "string" }, "sourceKind": { "enum": [ "user", "imported" ], "type": "string" } }, "required": [ "rule" ], "type": "object" }, "dto.FirewallRuleCreateResponse": { "properties": { "errors": { "items": { "$ref": "#/definitions/dto.FirewallRuleCreateFailure" }, "type": "array" }, "failed": { "type": "integer" }, "queued": { "type": "boolean" }, "skipped": { "type": "integer" }, "succeeded": { "type": "integer" }, "taskID": { "type": "string" } }, "type": "object" }, "dto.FirewallRuleDelete": { "properties": { "uuids": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "uuids" ], "type": "object" }, "dto.FirewallRuleDeleteFailure": { "properties": { "error": { "type": "string" }, "index": { "type": "integer" }, "uuid": { "type": "string" } }, "type": "object" }, "dto.FirewallRuleDeleteResponse": { "properties": { "errors": { "items": { "$ref": "#/definitions/dto.FirewallRuleDeleteFailure" }, "type": "array" }, "failed": { "type": "integer" }, "succeeded": { "type": "integer" } }, "type": "object" }, "dto.FirewallRuleInventory": { "properties": { "actions": { "items": { "enum": [ "accept", "deny" ], "type": "string" }, "type": "array" }, "all": { "type": "boolean" }, "excludeChains": { "items": { "enum": [ "1PANEL_BASIC_BEFORE", "1PANEL_BASIC", "1PANEL_BASIC_AFTER" ], "type": "string" }, "type": "array" }, "families": { "items": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "type": "array" }, "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "scope": { "$ref": "#/definitions/filter.Scope" }, "scopes": { "items": { "$ref": "#/definitions/filter.Scope" }, "maxItems": 16, "type": "array" }, "states": { "items": { "enum": [ "managed", "adopted", "external", "drifted", "protected" ], "type": "string" }, "type": "array" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.FirewallRuleInventoryResponse": { "properties": { "allTotal": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/filter.InventoryItem" }, "type": "array" }, "managedTotal": { "type": "integer" }, "notices": { "items": { "$ref": "#/definitions/filter.ScopeNotice" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" }, "dto.FirewallRuleReorder": { "properties": { "priority": { "type": "integer" }, "targetPosition": { "type": "integer" }, "uuid": { "type": "string" } }, "type": "object" }, "dto.FirewallRuleUpdate": { "properties": { "rule": { "$ref": "#/definitions/filter.FirewallRule" }, "uuid": { "type": "string" } }, "required": [ "rule" ], "type": "object" }, "dto.FirewallSettings": { "properties": { "docker": { "$ref": "#/definitions/dto.FirewallBackendGroup" }, "forwarding": { "$ref": "#/definitions/dto.FirewallBackendGroup" }, "pingStatus": { "type": "string" }, "portWhiteList": { "type": "array", "items": { "$ref": "#/definitions/filter.PortWhitelist" } }, "system": { "$ref": "#/definitions/dto.FirewallBackendGroup" } }, "type": "object" }, "dto.FirewallSubsystemStatus": { "properties": { "backend": { "type": "string" }, "isActive": { "type": "boolean" }, "isBind": { "type": "boolean" }, "isExist": { "type": "boolean" }, "isInit": { "type": "boolean" }, "name": { "type": "string" }, "pingStatus": { "type": "string" }, "syncError": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.ForBuckets": { "properties": { "accessKey": { "type": "string" }, "credential": { "type": "string" }, "type": { "type": "string" }, "vars": { "type": "string" } }, "required": [ "credential", "type", "vars" ], "type": "object" }, "dto.ForceDelete": { "properties": { "forceDelete": { "type": "boolean" }, "ids": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "dto.ForwardRuleOperate": { "properties": { "forceDelete": { "type": "boolean" }, "rules": { "items": { "$ref": "#/definitions/dto.ForwardRuleOperation" }, "type": "array", "minItems": 1 } }, "type": "object", "required": [ "rules" ] }, "dto.ForwardRuleOperation": { "properties": { "family": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "interface": { "type": "string" }, "num": { "type": "string" }, "operation": { "enum": [ "add", "remove" ], "type": "string" }, "port": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp", "tcp/udp" ], "type": "string" }, "targetIP": { "type": "string" }, "targetPort": { "type": "string" } }, "required": [ "operation", "port", "protocol", "targetPort" ], "type": "object" }, "dto.ForwardRuleSearch": { "properties": { "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "string" }, "strategy": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.FtpBaseInfo": { "properties": { "isActive": { "type": "boolean" }, "isExist": { "type": "boolean" } }, "type": "object" }, "dto.FtpCreate": { "properties": { "description": { "type": "string" }, "password": { "type": "string" }, "path": { "type": "string" }, "user": { "type": "string" } }, "required": [ "password", "path", "user" ], "type": "object" }, "dto.FtpLogSearch": { "properties": { "operation": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "user": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.FtpUpdate": { "properties": { "description": { "type": "string" }, "id": { "type": "integer" }, "password": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "string" } }, "required": [ "password", "path" ], "type": "object" }, "dto.GPUInfo": { "properties": { "fanSpeed": { "type": "string" }, "gpuUtil": { "type": "string" }, "index": { "type": "integer" }, "maxPowerLimit": { "type": "string" }, "memTotal": { "type": "string" }, "memUsed": { "type": "string" }, "memoryUsage": { "type": "string" }, "performanceState": { "type": "string" }, "powerDraw": { "type": "string" }, "powerUsage": { "type": "string" }, "productName": { "type": "string" }, "temperature": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.GPUProcess": { "properties": { "pid": { "type": "string" }, "processName": { "type": "string" }, "type": { "type": "string" }, "usedMemory": { "type": "string" } }, "type": "object" }, "dto.GroupCreate": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "dto.GroupSearch": { "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "dto.GroupUpdate": { "properties": { "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "dto.HostConnTest": { "properties": { "addr": { "type": "string" }, "authMode": { "enum": [ "password", "key" ], "type": "string" }, "passPhrase": { "type": "string" }, "password": { "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer" }, "privateKey": { "type": "string" }, "user": { "type": "string" } }, "required": [ "addr", "port", "user" ], "type": "object" }, "dto.HostHelper": { "properties": { "host": { "type": "string" }, "ip": { "type": "string" } }, "type": "object" }, "dto.HostOperate": { "properties": { "addr": { "type": "string" }, "authMode": { "enum": [ "password", "key" ], "type": "string" }, "description": { "type": "string" }, "groupID": { "type": "integer" }, "id": { "type": "integer" }, "name": { "type": "string" }, "passPhrase": { "type": "string" }, "password": { "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer" }, "privateKey": { "type": "string" }, "rememberPassword": { "type": "boolean" }, "user": { "type": "string" } }, "required": [ "addr", "port", "user" ], "type": "object" }, "dto.ImageBuild": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "dockerfile": { "type": "string" }, "from": { "type": "string" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" } }, "required": [ "dockerfile", "from", "name" ], "type": "object" }, "dto.ImageInfo": { "properties": { "createdAt": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "isPinned": { "type": "boolean" }, "isUsed": { "type": "boolean" }, "size": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.ImageLoad": { "properties": { "paths": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" } }, "required": [ "paths" ], "type": "object" }, "dto.ImagePull": { "properties": { "imageName": { "items": { "type": "string" }, "type": "array" }, "repoID": { "type": "integer" }, "taskID": { "type": "string" } }, "required": [ "imageName" ], "type": "object" }, "dto.ImagePush": { "properties": { "name": { "type": "string" }, "repoID": { "type": "integer" }, "tagName": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "name", "repoID", "tagName" ], "type": "object" }, "dto.ImageRepoDelete": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "dto.ImageRepoOption": { "properties": { "downloadUrl": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.ImageRepoUpdate": { "properties": { "auth": { "type": "boolean" }, "downloadUrl": { "type": "string" }, "id": { "type": "integer" }, "password": { "type": "string" }, "protocol": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "dto.ImageSave": { "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "tagName": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "name", "path", "tagName" ], "type": "object" }, "dto.ImageTag": { "properties": { "sourceID": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "required": [ "sourceID", "tags" ], "type": "object" }, "dto.InspectReq": { "properties": { "detail": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "dto.InstallDetail": { "properties": { "detailID": { "type": "integer" }, "httpPort": { "type": "integer" }, "httpsPort": { "type": "integer" }, "installID": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" }, "webUI": { "type": "string" } }, "type": "object" }, "dto.LauncherOption": { "properties": { "isShow": { "type": "boolean" }, "key": { "type": "string" } }, "type": "object" }, "dto.LoadRedisStatus": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "dto.Locale": { "properties": { "en": { "type": "string" }, "es-es": { "type": "string" }, "fa": { "type": "string" }, "ja": { "type": "string" }, "ko": { "type": "string" }, "lo": { "type": "string" }, "ms": { "type": "string" }, "pt-br": { "type": "string" }, "ru": { "type": "string" }, "tr": { "type": "string" }, "zh": { "type": "string" }, "zh-hant": { "type": "string" } }, "type": "object" }, "dto.LogOption": { "properties": { "logMaxFile": { "type": "string" }, "logMaxSize": { "type": "string" } }, "type": "object" }, "dto.Login": { "properties": { "authSource": { "type": "string" }, "captcha": { "type": "string" }, "captchaID": { "type": "string" }, "language": { "enum": [ "zh", "en", "zh-Hant", "ko", "ja", "ru", "ms", "pt-BR", "tr", "es-ES", "fa", "lo" ], "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" } }, "required": [ "language", "name", "password" ], "type": "object" }, "dto.LoginSetting": { "properties": { "isDemo": { "type": "boolean" }, "isEnterprise": { "type": "boolean" }, "isFxplay": { "type": "boolean" }, "isIntl": { "type": "boolean" }, "isOffline": { "type": "boolean" }, "language": { "type": "string" }, "menuAccordion": { "type": "string" }, "menuTabs": { "type": "string" }, "needCaptcha": { "type": "boolean" }, "panelName": { "type": "string" }, "passkeySetting": { "type": "boolean" }, "theme": { "type": "string" } }, "type": "object" }, "dto.MFALogin": { "properties": { "code": { "type": "string" }, "sessionId": { "type": "string" } }, "required": [ "code", "sessionId" ], "type": "object" }, "dto.MemoUpdate": { "properties": { "content": { "maxLength": 500, "type": "string" } }, "type": "object" }, "dto.MfaCredential": { "properties": { "code": { "type": "string" }, "interval": { "type": "integer" }, "secret": { "type": "string" } }, "required": [ "code", "interval", "secret" ], "type": "object" }, "dto.MongodbBind": { "properties": { "database": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "name", "password", "username" ], "type": "object" }, "dto.MongodbDBCreate": { "properties": { "database": { "type": "string" }, "description": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "permission": { "enum": [ "dbOwner", "read", "readWrite", "userAdmin" ], "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "from", "name", "password", "permission", "username" ], "type": "object" }, "dto.MongodbDBDelete": { "properties": { "database": { "type": "string" }, "deleteBackup": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" }, "type": { "enum": [ "mongodb" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.MongodbDBDeleteCheck": { "properties": { "database": { "type": "string" }, "id": { "type": "integer" }, "type": { "enum": [ "mongodb" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.MongodbDBSearch": { "properties": { "database": { "type": "string" }, "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "database", "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.MongodbLoadDB": { "properties": { "database": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "type": { "enum": [ "mongodb" ], "type": "string" } }, "required": [ "database", "from", "type" ], "type": "object" }, "dto.MongodbPassword": { "properties": { "database": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" } }, "required": [ "database", "name", "password" ], "type": "object" }, "dto.MongodbPrivileges": { "properties": { "database": { "type": "string" }, "name": { "type": "string" }, "permission": { "enum": [ "dbOwner", "read", "readWrite", "userAdmin" ], "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "name", "permission", "username" ], "type": "object" }, "dto.MongodbPrivilegesLoad": { "properties": { "database": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "name", "username" ], "type": "object" }, "dto.MonitorData": { "properties": { "date": { "items": { "type": "string" }, "type": "array" }, "param": { "type": "string" }, "value": { "items": {}, "type": "array" } }, "type": "object" }, "dto.MonitorGPUData": { "properties": { "date": { "items": { "type": "string" }, "type": "array" }, "gpuProcesses": { "items": { "items": { "$ref": "#/definitions/dto.GPUProcess" }, "type": "array" }, "type": "array" }, "gpuValue": { "items": { "type": "number" }, "type": "array" }, "memoryPercent": { "items": { "type": "number" }, "type": "array" }, "memoryTotal": { "items": { "type": "number" }, "type": "array" }, "memoryUsed": { "items": { "type": "number" }, "type": "array" }, "powerPercent": { "items": { "type": "number" }, "type": "array" }, "powerTotal": { "items": { "type": "number" }, "type": "array" }, "powerUsed": { "items": { "type": "number" }, "type": "array" }, "processCount": { "items": { "type": "integer" }, "type": "array" }, "speedValue": { "items": { "type": "integer" }, "type": "array" }, "temperatureValue": { "items": { "type": "number" }, "type": "array" } }, "type": "object" }, "dto.MonitorGPUSearch": { "properties": { "endTime": { "type": "string" }, "productName": { "type": "string" }, "startTime": { "type": "string" } }, "type": "object" }, "dto.MonitorSearch": { "properties": { "endTime": { "type": "string" }, "io": { "type": "string" }, "network": { "type": "string" }, "param": { "enum": [ "all", "cpu", "memory", "load", "io", "network" ], "type": "string" }, "startTime": { "type": "string" } }, "required": [ "param" ], "type": "object" }, "dto.MonitorSetting": { "properties": { "defaultIO": { "type": "string" }, "defaultNetwork": { "type": "string" }, "monitorInterval": { "type": "string" }, "monitorStatus": { "type": "string" }, "monitorStoreDays": { "type": "string" } }, "type": "object" }, "dto.MonitorSettingUpdate": { "properties": { "key": { "enum": [ "MonitorStatus", "MonitorStoreDays", "MonitorInterval", "DefaultNetwork", "DefaultIO" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.MysqlDBCreate": { "properties": { "collation": { "type": "string" }, "database": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "permission": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "format", "from", "name", "permission" ], "type": "object" }, "dto.MysqlDBDelete": { "properties": { "database": { "type": "string" }, "deleteBackup": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" }, "type": { "enum": [ "mysql", "mariadb", "mysql-cluster" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.MysqlDBDeleteCheck": { "properties": { "database": { "type": "string" }, "id": { "type": "integer" }, "type": { "enum": [ "mysql", "mariadb", "mysql-cluster" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.MysqlDBSearch": { "properties": { "database": { "type": "string" }, "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "database", "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.MysqlFormatCollationOption": { "properties": { "collations": { "items": { "type": "string" }, "type": "array" }, "format": { "type": "string" } }, "type": "object" }, "dto.MysqlGrant": { "properties": { "database": { "type": "string" }, "host": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "dto.MysqlGrantCreate": { "properties": { "database": { "type": "string" }, "db": { "type": "string" }, "host": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "db", "host", "username" ], "type": "object" }, "dto.MysqlGrantDelete": { "properties": { "database": { "type": "string" }, "db": { "type": "string" }, "host": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "db", "host", "username" ], "type": "object" }, "dto.MysqlGrantSummarySearch": { "properties": { "database": { "type": "string" }, "dbs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "database", "dbs" ], "type": "object" }, "dto.MysqlLoadDB": { "properties": { "database": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "type": { "enum": [ "mysql", "mariadb", "mysql-cluster" ], "type": "string" } }, "required": [ "database", "from", "type" ], "type": "object" }, "dto.MysqlStatus": { "properties": { "Aborted_clients": { "type": "string" }, "Aborted_connects": { "type": "string" }, "Bytes_received": { "type": "string" }, "Bytes_sent": { "type": "string" }, "Com_commit": { "type": "string" }, "Com_rollback": { "type": "string" }, "Connections": { "type": "string" }, "Created_tmp_disk_tables": { "type": "string" }, "Created_tmp_tables": { "type": "string" }, "File": { "type": "string" }, "Innodb_buffer_pool_pages_dirty": { "type": "string" }, "Innodb_buffer_pool_read_requests": { "type": "string" }, "Innodb_buffer_pool_reads": { "type": "string" }, "Key_read_requests": { "type": "string" }, "Key_reads": { "type": "string" }, "Key_write_requests": { "type": "string" }, "Key_writes": { "type": "string" }, "Max_used_connections": { "type": "string" }, "Open_tables": { "type": "string" }, "Opened_files": { "type": "string" }, "Opened_tables": { "type": "string" }, "Position": { "type": "string" }, "Qcache_hits": { "type": "string" }, "Qcache_inserts": { "type": "string" }, "Questions": { "type": "string" }, "Run": { "type": "string" }, "Select_full_join": { "type": "string" }, "Select_range_check": { "type": "string" }, "Sort_merge_passes": { "type": "string" }, "Table_locks_waited": { "type": "string" }, "Threads_cached": { "type": "string" }, "Threads_connected": { "type": "string" }, "Threads_created": { "type": "string" }, "Threads_running": { "type": "string" }, "Uptime": { "type": "string" } }, "type": "object" }, "dto.MysqlUser": { "properties": { "description": { "type": "string" }, "host": { "type": "string" }, "isDelete": { "type": "boolean" }, "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "dto.MysqlUserCreate": { "properties": { "database": { "type": "string" }, "dbs": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "host", "password", "username" ], "type": "object" }, "dto.MysqlUserDelete": { "properties": { "database": { "type": "string" }, "host": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "host", "username" ], "type": "object" }, "dto.MysqlUserPassword": { "properties": { "database": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "host", "password", "username" ], "type": "object" }, "dto.MysqlUserSearch": { "properties": { "database": { "type": "string" } }, "required": [ "database" ], "type": "object" }, "dto.MysqlUserUpdate": { "properties": { "database": { "type": "string" }, "description": { "type": "string" }, "host": { "type": "string" }, "newHost": { "type": "string" }, "username": { "type": "string" } }, "required": [ "database", "host", "newHost", "username" ], "type": "object" }, "dto.MysqlVariables": { "properties": { "binlog_cache_size": { "type": "string" }, "innodb_buffer_pool_size": { "type": "string" }, "innodb_log_buffer_size": { "type": "string" }, "join_buffer_size": { "type": "string" }, "key_buffer_size": { "type": "string" }, "long_query_time": { "type": "string" }, "max_connections": { "type": "string" }, "max_heap_table_size": { "type": "string" }, "query_cache_size": { "type": "string" }, "query_cache_type": { "type": "string" }, "read_buffer_size": { "type": "string" }, "read_rnd_buffer_size": { "type": "string" }, "slow_query_log": { "type": "string" }, "sort_buffer_size": { "type": "string" }, "table_open_cache": { "type": "string" }, "thread_cache_size": { "type": "string" }, "thread_stack": { "type": "string" }, "tmp_table_size": { "type": "string" } }, "type": "object" }, "dto.MysqlVariablesUpdate": { "properties": { "database": { "type": "string" }, "type": { "enum": [ "mysql", "mariadb", "mysql-cluster" ], "type": "string" }, "variables": { "items": { "$ref": "#/definitions/dto.MysqlVariablesUpdateHelper" }, "type": "array" } }, "required": [ "database", "type" ], "type": "object" }, "dto.MysqlVariablesUpdateHelper": { "properties": { "param": { "type": "string" }, "value": {} }, "type": "object" }, "dto.NetworkCreate": { "properties": { "auxAddress": { "items": { "$ref": "#/definitions/dto.SettingUpdate" }, "type": "array" }, "auxAddressV6": { "items": { "$ref": "#/definitions/dto.SettingUpdate" }, "type": "array" }, "driver": { "type": "string" }, "gateway": { "type": "string" }, "gatewayV6": { "type": "string" }, "ipRange": { "type": "string" }, "ipRangeV6": { "type": "string" }, "ipv4": { "type": "boolean" }, "ipv6": { "type": "boolean" }, "labels": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "subnet": { "type": "string" }, "subnetV6": { "type": "string" } }, "required": [ "driver", "name" ], "type": "object" }, "dto.NginxAuth": { "properties": { "remark": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "dto.NginxKey": { "enum": [ "index", "limit-conn", "ssl", "cache", "http-per", "proxy-cache" ], "type": "string", "x-enum-varnames": [ "Index", "LimitConn", "SSL", "CACHE", "HttpPer", "ProxyCache" ] }, "dto.NginxModuleArtifact": { "properties": { "checksum": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "dto.NginxUpstream": { "properties": { "algorithm": { "type": "string" }, "content": { "type": "string" }, "name": { "type": "string" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" } }, "type": "object" }, "dto.NginxUpstreamServer": { "properties": { "failTimeout": { "type": "integer" }, "failTimeoutUnit": { "type": "string" }, "flag": { "type": "string" }, "maxConns": { "type": "integer" }, "maxFails": { "type": "integer" }, "server": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object" }, "dto.NodeCurrent": { "properties": { "cpuDetailedPercent": { "items": { "type": "number" }, "type": "array" }, "cpuTotal": { "type": "integer" }, "cpuUsed": { "type": "number" }, "cpuUsedPercent": { "type": "number" }, "load1": { "type": "number" }, "load15": { "type": "number" }, "load5": { "type": "number" }, "loadUsagePercent": { "type": "number" }, "memoryAvailable": { "type": "integer" }, "memoryTotal": { "type": "integer" }, "memoryUsed": { "type": "integer" }, "memoryUsedPercent": { "type": "number" }, "swapMemoryAvailable": { "type": "integer" }, "swapMemoryTotal": { "type": "integer" }, "swapMemoryUsed": { "type": "integer" }, "swapMemoryUsedPercent": { "type": "number" } }, "type": "object" }, "dto.OllamaBindDomain": { "properties": { "appInstallID": { "type": "integer" }, "domain": { "type": "string" }, "ipList": { "type": "string" }, "sslID": { "type": "integer" }, "websiteID": { "type": "integer" } }, "required": [ "appInstallID", "domain" ], "type": "object" }, "dto.OllamaBindDomainReq": { "properties": { "appInstallID": { "type": "integer" } }, "required": [ "appInstallID" ], "type": "object" }, "dto.OllamaBindDomainRes": { "properties": { "acmeAccountID": { "type": "integer" }, "allowIPs": { "items": { "type": "string" }, "type": "array" }, "connUrl": { "type": "string" }, "domain": { "type": "string" }, "sslID": { "type": "integer" }, "websiteID": { "type": "integer" } }, "type": "object" }, "dto.OllamaModelDropList": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.OllamaModelName": { "properties": { "name": { "type": "string" }, "taskID": { "type": "string" } }, "type": "object" }, "dto.Operate": { "properties": { "operation": { "type": "string" } }, "required": [ "operation" ], "type": "object" }, "dto.OperateByID": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.OperateByIDs": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "dto.OperateByName": { "properties": { "name": { "type": "string" } }, "type": "object" }, "dto.OperateByTaskID": { "properties": { "taskID": { "type": "string" } }, "type": "object" }, "dto.OperateByType": { "properties": { "type": { "type": "string" } }, "type": "object" }, "dto.OperationWithName": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.OperationWithNameAndType": { "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "dto.Options": { "properties": { "option": { "type": "string" } }, "type": "object" }, "dto.OsInfo": { "properties": { "diskSize": { "type": "integer" }, "kernelArch": { "type": "string" }, "kernelVersion": { "type": "string" }, "os": { "type": "string" }, "platform": { "type": "string" }, "platformFamily": { "type": "string" }, "prettyDistro": { "type": "string" } }, "type": "object" }, "dto.PageContainer": { "properties": { "excludeAppStore": { "type": "boolean" }, "filters": { "type": "string" }, "name": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt", "state" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "state": { "enum": [ "all", "created", "running", "paused", "restarting", "removing", "exited", "dead" ], "type": "string" } }, "required": [ "order", "orderBy", "page", "pageSize", "state" ], "type": "object" }, "dto.PageCronjob": { "properties": { "groupIDs": { "items": { "type": "integer" }, "type": "array" }, "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "status", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.PageImage": { "properties": { "name": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "size", "tags", "createdAt", "isUsed" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.PageInfo": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.PageResult": { "properties": { "items": {}, "total": { "type": "integer" } }, "type": "object" }, "dto.PageSnapshot": { "properties": { "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.PasskeyBeginResponse": { "properties": { "publicKey": {}, "sessionId": { "type": "string" } }, "type": "object" }, "dto.PasskeyInfo": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "string" }, "lastUsedAt": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.PasskeyRegisterRequest": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "dto.PasswordUpdate": { "properties": { "newPassword": { "type": "string" }, "oldPassword": { "type": "string" } }, "required": [ "newPassword", "oldPassword" ], "type": "object" }, "dto.PortHelper": { "properties": { "containerPort": { "type": "string" }, "hostIP": { "type": "string" }, "hostPort": { "type": "string" }, "protocol": { "type": "string" } }, "type": "object" }, "dto.PortUpdate": { "properties": { "serverPort": { "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "serverPort" ], "type": "object" }, "dto.PostgresqlBindUser": { "properties": { "database": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "superUser": { "type": "boolean" }, "username": { "type": "string" } }, "required": [ "database", "name", "password", "username" ], "type": "object" }, "dto.PostgresqlDBCreate": { "properties": { "database": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "superUser": { "type": "boolean" }, "username": { "type": "string" } }, "required": [ "database", "from", "name", "password", "username" ], "type": "object" }, "dto.PostgresqlDBDelete": { "properties": { "database": { "type": "string" }, "deleteBackup": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" }, "type": { "enum": [ "postgresql", "postgresql-cluster" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.PostgresqlDBDeleteCheck": { "properties": { "database": { "type": "string" }, "id": { "type": "integer" }, "type": { "enum": [ "postgresql", "postgresql-cluster" ], "type": "string" } }, "required": [ "database", "id", "type" ], "type": "object" }, "dto.PostgresqlDBSearch": { "properties": { "database": { "type": "string" }, "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "database", "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.PostgresqlLoadDB": { "properties": { "database": { "type": "string" }, "from": { "enum": [ "local", "remote" ], "type": "string" }, "type": { "enum": [ "postgresql", "postgresql-cluster" ], "type": "string" } }, "required": [ "database", "from", "type" ], "type": "object" }, "dto.Process": { "properties": { "cmd": { "type": "string" }, "memory": { "type": "integer" }, "name": { "type": "string" }, "percent": { "type": "number" }, "pid": { "type": "integer" }, "user": { "type": "string" } }, "type": "object" }, "dto.ProviderAPIInfo": { "properties": { "apiType": { "type": "string" }, "authModes": { "items": { "type": "string" }, "type": "array" }, "baseUrl": { "type": "string" }, "defaultAuthMode": { "type": "string" }, "editableBaseUrl": { "type": "boolean" }, "models": { "items": { "$ref": "#/definitions/dto.ProviderModelInfo" }, "type": "array" }, "supportsModelDiscovery": { "type": "boolean" } }, "type": "object" }, "dto.ProviderInfo": { "properties": { "apiTypes": { "items": { "$ref": "#/definitions/dto.ProviderAPIInfo" }, "type": "array" }, "baseUrl": { "type": "string" }, "defaultApiType": { "type": "string" }, "displayName": { "type": "string" }, "models": { "items": { "$ref": "#/definitions/dto.ProviderModelInfo" }, "type": "array" }, "provider": { "type": "string" } }, "type": "object" }, "dto.ProviderModelInfo": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.ProxyUpdate": { "properties": { "proxyDocker": { "type": "boolean" }, "proxyPasswd": { "type": "string" }, "proxyPasswdKeep": { "type": "string" }, "proxyPort": { "type": "string" }, "proxyType": { "type": "string" }, "proxyUrl": { "type": "string" }, "proxyUser": { "type": "string" }, "withDockerRestart": { "type": "boolean" } }, "type": "object" }, "dto.QuickJump": { "properties": { "alias": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "integer" }, "isShow": { "type": "boolean" }, "name": { "type": "string" }, "recommend": { "type": "integer" }, "router": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "dto.RecordFileSize": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "dto.RecordSearch": { "properties": { "detailName": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "page", "pageSize", "type" ], "type": "object" }, "dto.RecordSearchByCronjob": { "properties": { "cronjobID": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "cronjobID", "page", "pageSize" ], "type": "object" }, "dto.RedisConf": { "properties": { "containerName": { "type": "string" }, "database": { "type": "string" }, "maxclients": { "type": "string" }, "maxmemory": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" }, "requirepass": { "type": "string" }, "timeout": { "type": "string" } }, "required": [ "database" ], "type": "object" }, "dto.RedisConfPersistenceUpdate": { "properties": { "appendfsync": { "type": "string" }, "appendonly": { "type": "string" }, "database": { "type": "string" }, "dbType": { "enum": [ "redis", "redis-cluster" ], "type": "string" }, "save": { "type": "string" }, "type": { "enum": [ "aof", "rbd" ], "type": "string" } }, "required": [ "database", "dbType", "type" ], "type": "object" }, "dto.RedisConfUpdate": { "properties": { "database": { "type": "string" }, "dbType": { "enum": [ "redis", "redis-cluster" ], "type": "string" }, "maxclients": { "type": "string" }, "maxmemory": { "type": "string" }, "timeout": { "type": "string" } }, "required": [ "database", "dbType" ], "type": "object" }, "dto.RedisPersistence": { "properties": { "appendfsync": { "type": "string" }, "appendonly": { "type": "string" }, "database": { "type": "string" }, "save": { "type": "string" } }, "required": [ "database" ], "type": "object" }, "dto.RedisStatus": { "properties": { "connected_clients": { "type": "string" }, "database": { "type": "string" }, "instantaneous_ops_per_sec": { "type": "string" }, "keyspace_hits": { "type": "string" }, "keyspace_misses": { "type": "string" }, "latest_fork_usec": { "type": "string" }, "mem_fragmentation_ratio": { "type": "string" }, "tcp_port": { "type": "string" }, "total_commands_processed": { "type": "string" }, "total_connections_received": { "type": "string" }, "uptime_in_days": { "type": "string" }, "used_memory": { "type": "string" }, "used_memory_peak": { "type": "string" }, "used_memory_rss": { "type": "string" } }, "required": [ "database" ], "type": "object" }, "dto.ReleasesNotes": { "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "fixCount": { "type": "integer" }, "newCount": { "type": "integer" }, "optimizationCount": { "type": "integer" }, "version": { "type": "string" } }, "type": "object" }, "dto.ResourceLimit": { "properties": { "cpu": { "type": "integer" }, "memory": { "type": "integer" } }, "type": "object" }, "dto.Response": { "properties": { "code": { "type": "integer" }, "data": {}, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "dto.RootCertOperate": { "properties": { "description": { "type": "string" }, "encryptionMode": { "enum": [ "rsa", "ed25519", "ecdsa", "dsa" ], "type": "string" }, "id": { "type": "integer" }, "mode": { "type": "string" }, "name": { "type": "string" }, "passPhrase": { "type": "string" }, "privateKey": { "type": "string" }, "publicKey": { "type": "string" } }, "required": [ "encryptionMode" ], "type": "object" }, "dto.RunningTime": { "properties": { "days": { "type": "integer" }, "hours": { "type": "integer" }, "minutes": { "type": "integer" }, "seconds": { "type": "integer" } }, "type": "object" }, "dto.RuntimeDiagnosticsSummary": { "properties": { "goroutines": { "type": "integer" }, "heapAlloc": { "type": "integer" }, "heapObjects": { "type": "integer" }, "rss": { "type": "integer" } }, "type": "object" }, "dto.RuntimeGoroutineGroup": { "properties": { "count": { "type": "integer" }, "stack": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "top": { "type": "string" } }, "type": "object" }, "dto.RuntimeGoroutineSnapshot": { "properties": { "capturedAt": { "type": "string" }, "goroutines": { "items": { "$ref": "#/definitions/dto.RuntimeGoroutineGroup" }, "type": "array" }, "groupCount": { "type": "integer" }, "total": { "type": "integer" }, "truncated": { "type": "boolean" } }, "type": "object" }, "dto.RuntimeProfileCreate": { "properties": { "duration": { "maximum": 30, "minimum": 5, "type": "integer" }, "type": { "enum": [ "cpu", "heap", "goroutine", "mutex", "block" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "dto.SSHConfUpdate": { "properties": { "key": { "type": "string" }, "path": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.SSHConnData": { "properties": { "addr": { "type": "string" }, "authMode": { "enum": [ "password", "key" ], "type": "string" }, "localSSHConnShow": { "type": "string" }, "passPhrase": { "type": "string" }, "password": { "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer" }, "privateKey": { "type": "string" }, "user": { "type": "string" } }, "required": [ "addr", "port", "user" ], "type": "object" }, "dto.SSHDefaultConn": { "properties": { "defaultConn": { "type": "string" }, "withReset": { "type": "boolean" } }, "type": "object" }, "dto.SSHInfo": { "properties": { "autoStart": { "type": "boolean" }, "currentUser": { "type": "string" }, "isActive": { "type": "boolean" }, "isExist": { "type": "boolean" }, "listenAddress": { "type": "string" }, "message": { "type": "string" }, "passwordAuthentication": { "type": "string" }, "permitRootLogin": { "type": "string" }, "port": { "type": "string" }, "pubkeyAuthentication": { "type": "string" }, "useDNS": { "type": "string" } }, "type": "object" }, "dto.SSHUpdate": { "properties": { "key": { "type": "string" }, "newValue": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.SSLInfo": { "properties": { "cert": { "type": "string" }, "domain": { "type": "string" }, "key": { "type": "string" }, "rootPath": { "type": "string" }, "sslID": { "type": "integer" }, "timeout": { "type": "string" } }, "type": "object" }, "dto.SSLUpdate": { "properties": { "cert": { "type": "string" }, "domain": { "type": "string" }, "key": { "type": "string" }, "ssl": { "enum": [ "Enable", "Disable", "Mux" ], "type": "string" }, "sslID": { "type": "integer" }, "sslType": { "enum": [ "self", "select", "import", "import-paste", "import-local" ], "type": "string" } }, "required": [ "ssl", "sslType" ], "type": "object" }, "dto.ScriptOperate": { "properties": { "description": { "type": "string" }, "groups": { "type": "string" }, "id": { "type": "integer" }, "isInteractive": { "type": "boolean" }, "name": { "type": "string" }, "script": { "type": "string" } }, "type": "object" }, "dto.ScriptOptions": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "dto.SearchByFilter": { "properties": { "filter": { "type": "string" } }, "type": "object" }, "dto.SearchClamWithPage": { "properties": { "info": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "name", "status", "createdAt" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "dto.SearchForSize": { "properties": { "cronjobID": { "type": "integer" }, "detailName": { "type": "string" }, "info": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "string" }, "orderBy": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "page", "pageSize", "type" ], "type": "object" }, "dto.SearchForTree": { "properties": { "info": { "type": "string" } }, "type": "object" }, "dto.SearchLgLogWithPage": { "properties": { "endTime": { "type": "string" }, "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "startTime": { "type": "string" }, "status": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchOpLogWithPage": { "properties": { "node": { "type": "string" }, "operation": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "source": { "type": "string" }, "status": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchPageWithGroup": { "properties": { "groupID": { "type": "integer" }, "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchPageWithType": { "properties": { "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchRecord": { "properties": { "cronjobID": { "type": "integer" }, "endTime": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "startTime": { "type": "string" }, "status": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchSSHLog": { "properties": { "Status": { "enum": [ "Success", "Failed", "All" ], "type": "string" }, "endTime": { "type": "string" }, "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "startTime": { "type": "string" } }, "required": [ "Status", "page", "pageSize" ], "type": "object" }, "dto.SearchTaskLogReq": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SearchWithPage": { "properties": { "excludeAppStore": { "type": "boolean" }, "info": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "dto.SettingBaseInfo": { "properties": { "bindAddress": { "type": "string" }, "complexityVerification": { "type": "string" }, "dashboardMemoVisible": { "type": "string" }, "dashboardSimpleNodeVisible": { "type": "string" }, "developerMode": { "type": "string" }, "docSource": { "type": "string" }, "edition": { "type": "string" }, "hideMenu": { "type": "string" }, "ipv6": { "type": "string" }, "language": { "type": "string" }, "menuAccordion": { "type": "string" }, "menuTabs": { "type": "string" }, "noAuthSetting": { "type": "string" }, "panelName": { "type": "string" }, "port": { "type": "string" }, "proxyType": { "type": "string" }, "scriptSync": { "type": "string" }, "securityEntrance": { "type": "string" }, "serverPort": { "type": "string" }, "systemVersion": { "type": "string" }, "theme": { "type": "string" }, "upgradeBackupCopies": { "type": "string" } }, "type": "object" }, "dto.SettingInfo": { "properties": { "appStoreLastModified": { "type": "string" }, "appStoreSyncStatus": { "type": "string" }, "appStoreVersion": { "type": "string" }, "defaultIO": { "type": "string" }, "defaultNetwork": { "type": "string" }, "dockerSockPath": { "type": "string" }, "fileRecycleBin": { "type": "string" }, "firewallPortWhiteList": { "type": "string" }, "lastCleanData": { "type": "string" }, "lastCleanSize": { "type": "string" }, "lastCleanTime": { "type": "string" }, "localSSHConnShow": { "type": "string" }, "localTime": { "type": "string" }, "monitorInterval": { "type": "string" }, "monitorStatus": { "type": "string" }, "monitorStoreDays": { "type": "string" }, "ntpSite": { "type": "string" }, "systemIP": { "type": "string" }, "systemVersion": { "type": "string" }, "timeZone": { "type": "string" } }, "type": "object" }, "dto.SettingUpdate": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "dto.SnapshotBatchDelete": { "properties": { "deleteWithFile": { "type": "boolean" }, "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "dto.SnapshotCreate": { "properties": { "appData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "backupData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "description": { "maxLength": 256, "type": "string" }, "downloadAccountID": { "type": "integer" }, "id": { "type": "integer" }, "ignoreFiles": { "items": { "type": "string" }, "type": "array" }, "interruptStep": { "type": "string" }, "name": { "type": "string" }, "panelData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "secret": { "type": "string" }, "sourceAccountIDs": { "type": "string" }, "taskID": { "type": "string" }, "timeout": { "type": "integer" }, "withDockerConf": { "type": "boolean" }, "withLoginLog": { "type": "boolean" }, "withMonitorData": { "type": "boolean" }, "withOperationLog": { "type": "boolean" }, "withSystemLog": { "type": "boolean" }, "withTaskLog": { "type": "boolean" } }, "required": [ "downloadAccountID", "sourceAccountIDs" ], "type": "object" }, "dto.SnapshotData": { "properties": { "appData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "backupData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "ignoreFiles": { "items": { "type": "string" }, "type": "array" }, "panelData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, "withDockerConf": { "type": "boolean" }, "withLoginLog": { "type": "boolean" }, "withMonitorData": { "type": "boolean" }, "withOperationLog": { "type": "boolean" }, "withSystemLog": { "type": "boolean" }, "withTaskLog": { "type": "boolean" } }, "type": "object" }, "dto.SnapshotImport": { "properties": { "backupAccountID": { "type": "integer" }, "description": { "maxLength": 256, "type": "string" }, "names": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "dto.SnapshotRecover": { "properties": { "id": { "type": "integer" }, "isNew": { "type": "boolean" }, "reDownload": { "type": "boolean" }, "secret": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "dto.SnapshotRule": { "properties": { "ignoreAppIDs": { "items": { "type": "integer" }, "type": "array" }, "withImage": { "type": "boolean" } }, "type": "object" }, "dto.SnapshotTransHelper": { "properties": { "ignoreApps": { "items": { "$ref": "#/definitions/dto.TransHelper" }, "type": "array" }, "withImage": { "type": "boolean" } }, "type": "object" }, "dto.SwapHelper": { "properties": { "isNew": { "type": "boolean" }, "path": { "type": "string" }, "size": { "type": "integer" }, "taskID": { "type": "string" }, "used": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "dto.SystemLogItem": { "properties": { "message": { "type": "string" }, "priority": { "type": "string" }, "raw": { "type": "string" }, "service": { "type": "string" }, "time": { "type": "string" } }, "type": "object" }, "dto.SystemLogReq": { "properties": { "cursor": { "type": "string" }, "endTime": { "type": "string" }, "keyword": { "type": "string" }, "pageSize": { "maximum": 500, "minimum": 1, "type": "integer" }, "priority": { "type": "string" }, "service": { "type": "string" }, "startTime": { "type": "string" } }, "type": "object" }, "dto.SystemLogRes": { "properties": { "hasMore": { "type": "boolean" }, "items": { "items": { "$ref": "#/definitions/dto.SystemLogItem" }, "type": "array" }, "nextCursor": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "dto.SystemLogStatus": { "properties": { "keywordFilterSupported": { "type": "boolean" }, "message": { "type": "string" }, "source": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "dto.Tag": { "properties": { "key": { "type": "string" }, "locales": { "$ref": "#/definitions/dto.Locale" }, "name": { "type": "string" }, "sort": { "type": "integer" } }, "type": "object" }, "dto.TerminalAIInfo": { "properties": { "aiAccountId": { "type": "string" }, "aiPrefix": { "enum": [ "@ai", "#ai", "/ai" ], "type": "string" }, "aiRiskCommands": { "type": "string" }, "aiRiskCommandsDefault": { "type": "string" }, "aiStatus": { "type": "string" } }, "required": [ "aiPrefix" ], "type": "object" }, "dto.TerminalInfo": { "properties": { "backgroundColor": { "type": "string" }, "cursorBlink": { "type": "string" }, "cursorStyle": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSize": { "type": "string" }, "foregroundColor": { "type": "string" }, "letterSpacing": { "type": "string" }, "lineHeight": { "type": "string" }, "scrollSensitivity": { "type": "string" }, "scrollback": { "type": "string" }, "showTerminalButton": { "type": "string" } }, "type": "object" }, "dto.TerminalUpdate": { "properties": { "backgroundColor": { "type": "string" }, "cursorBlink": { "type": "string" }, "cursorStyle": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSize": { "type": "string" }, "foregroundColor": { "type": "string" }, "letterSpacing": { "type": "string" }, "lineHeight": { "type": "string" }, "scrollSensitivity": { "type": "string" }, "scrollback": { "type": "string" }, "showTerminalButton": { "type": "string" } }, "type": "object" }, "dto.TransHelper": { "properties": { "detailName": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.UpdateByFile": { "properties": { "file": { "type": "string" } }, "type": "object" }, "dto.UpdateByNameAndFile": { "properties": { "file": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dto.UpdateDescription": { "properties": { "description": { "maxLength": 256, "type": "string" }, "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "dto.UpdateGroup": { "properties": { "group": { "type": "integer" }, "newGroup": { "type": "integer" } }, "type": "object" }, "dto.Upgrade": { "properties": { "version": { "type": "string" } }, "required": [ "version" ], "type": "object" }, "dto.UpgradeInfo": { "properties": { "latestVersion": { "type": "string" }, "newVersion": { "type": "string" }, "releaseNote": { "type": "string" }, "testVersion": { "type": "string" } }, "type": "object" }, "dto.UploadForRecover": { "properties": { "filePath": { "type": "string" }, "targetDir": { "type": "string" } }, "type": "object" }, "dto.UserLoginInfo": { "properties": { "mfaSession": { "type": "string" }, "mfaStatus": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "dto.VolumeCreate": { "properties": { "driver": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" } }, "required": [ "driver", "name" ], "type": "object" }, "dto.VolumeHelper": { "properties": { "containerDir": { "type": "string" }, "mode": { "type": "string" }, "shared": { "type": "string" }, "sourceDir": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dto.XPUInfo": { "properties": { "deviceID": { "type": "integer" }, "deviceName": { "type": "string" }, "memory": { "type": "string" }, "memoryUsed": { "type": "string" }, "memoryUtil": { "type": "string" }, "power": { "type": "string" }, "temperature": { "type": "string" } }, "type": "object" }, "files.FileInfo": { "properties": { "content": { "type": "string" }, "extension": { "type": "string" }, "favoriteID": { "type": "integer" }, "gid": { "type": "string" }, "group": { "type": "string" }, "isAppendOnly": { "type": "boolean" }, "isDetail": { "type": "boolean" }, "isDir": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isImmutable": { "type": "boolean" }, "isSymlink": { "type": "boolean" }, "itemTotal": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/files.FileInfo" }, "type": "array" }, "linkPath": { "type": "string" }, "mimeType": { "type": "string" }, "modTime": { "type": "string" }, "mode": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "shareCode": { "type": "string" }, "size": { "type": "integer" }, "type": { "type": "string" }, "uid": { "type": "string" }, "updateTime": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "filter.Action": { "enum": [ "accept", "drop", "reject" ], "type": "string", "x-enum-varnames": [ "ActionAccept", "ActionDrop", "ActionReject" ] }, "filter.DesiredRule": { "properties": { "marker": { "type": "string" }, "observedInstanceKey": { "type": "string" }, "origin": { "type": "string" }, "rule": { "$ref": "#/definitions/filter.FirewallRule" }, "ruleKey": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "filter.Direction": { "enum": [ "input" ], "type": "string", "x-enum-varnames": [ "DirectionInput" ] }, "filter.FirewallRule": { "properties": { "action": { "$ref": "#/definitions/filter.Action" }, "connectionStates": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "destinationAddress": { "type": "string" }, "destinationPort": { "type": "string" }, "interface": { "type": "string" }, "nativeKind": { "$ref": "#/definitions/filter.NativeKind" }, "orderBucket": { "type": "string" }, "orderIndex": { "type": "integer" }, "priority": { "type": "integer" }, "protocol": { "type": "string" }, "scope": { "$ref": "#/definitions/filter.Scope" }, "sourceAddress": { "type": "string" }, "sourcePort": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "filter.InventoryItem": { "properties": { "desired": { "$ref": "#/definitions/filter.DesiredRule" }, "match": { "$ref": "#/definitions/filter.InventoryMatch" }, "observed": { "$ref": "#/definitions/filter.ObservedRule" }, "rule": { "$ref": "#/definitions/filter.FirewallRule" }, "state": { "$ref": "#/definitions/filter.InventoryState" }, "usage": { "$ref": "#/definitions/filter.RuntimeUsage" } }, "type": "object" }, "filter.InventoryMatch": { "enum": [ "none", "exact", "changed", "missing", "ambiguous", "opaque" ], "type": "string", "x-enum-varnames": [ "InventoryMatchNone", "InventoryMatchExact", "InventoryMatchChanged", "InventoryMatchMissing", "InventoryMatchAmbiguous", "InventoryMatchOpaque" ] }, "filter.InventoryState": { "enum": [ "managed", "adopted", "external", "drifted", "protected" ], "type": "string", "x-enum-varnames": [ "InventoryStateManaged", "InventoryStateAdopted", "InventoryStateExternal", "InventoryStateDrifted", "InventoryStateProtected" ] }, "filter.Locator": { "properties": { "canonical": { "type": "string" }, "nativeId": { "type": "string" }, "position": { "type": "integer" }, "provider": { "type": "string" }, "scopeKey": { "type": "string" } }, "type": "object" }, "filter.NativeKind": { "enum": [ "rule", "zone_port", "rich_rule", "ufw_rule", "ufw_application", "opaque", "zone_service" ], "type": "string", "x-enum-varnames": [ "NativeKindRule", "NativeKindZonePort", "NativeKindRichRule", "NativeKindUFWRule", "NativeKindUFWApplication", "NativeKindOpaque", "NativeKindZoneService" ] }, "filter.ObservedRule": { "properties": { "instanceKey": { "type": "string" }, "locator": { "$ref": "#/definitions/filter.Locator" }, "marker": { "type": "string" }, "parseStatus": { "$ref": "#/definitions/filter.ParseStatus" }, "persistence": { "$ref": "#/definitions/filter.PersistenceStatus" }, "protected": { "type": "boolean" }, "raw": { "type": "string" }, "rule": { "$ref": "#/definitions/filter.FirewallRule" } }, "type": "object" }, "filter.ParseStatus": { "enum": [ "supported", "partial", "opaque" ], "type": "string", "x-enum-varnames": [ "ParseStatusSupported", "ParseStatusPartial", "ParseStatusOpaque" ] }, "filter.PersistenceStatus": { "enum": [ "converged", "runtime_only", "permanent_only" ], "type": "string", "x-enum-varnames": [ "PersistenceStatusConverged", "PersistenceStatusRuntimeOnly", "PersistenceStatusPermanentOnly" ] }, "filter.PortWhitelist": { "properties": { "port": { "type": "string" }, "protocol": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } }, "type": "object" }, "filter.RuntimeUsage": { "properties": { "reason": { "type": "string" }, "used": { "type": "boolean" }, "usedBy": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "filter.Scope": { "properties": { "chain": { "type": "string" }, "direction": { "$ref": "#/definitions/filter.Direction" }, "family": { "type": "string" }, "provider": { "type": "string" }, "table": { "type": "string" }, "zone": { "type": "string" } }, "type": "object" }, "filter.ScopeNotice": { "properties": { "code": { "$ref": "#/definitions/filter.ScopeNoticeCode" }, "values": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "filter.ScopeNoticeCode": { "enum": [ "default_scope_mismatch", "managed_scope_inactive", "unmanaged_active_scopes", "runtime_permanent_mismatch", "managed_scope_missing" ], "type": "string", "x-enum-varnames": [ "ScopeNoticeDefaultScopeMismatch", "ScopeNoticeManagedScopeInactive", "ScopeNoticeUnmanagedActiveScopes", "ScopeNoticeRuntimePermanentMismatch", "ScopeNoticeManagedScopeMissing" ] }, "mfa.Otp": { "properties": { "qrImage": { "type": "string" }, "secret": { "type": "string" } }, "type": "object" }, "model.App": { "properties": { "architectures": { "type": "string" }, "batchInstallSupport": { "type": "boolean" }, "createdAt": { "type": "string" }, "crossVersionUpdate": { "type": "boolean" }, "description": { "type": "string" }, "document": { "type": "string" }, "github": { "type": "string" }, "gpuSupport": { "type": "boolean" }, "icon": { "type": "string" }, "id": { "type": "integer" }, "key": { "type": "string" }, "lastModified": { "type": "integer" }, "limit": { "type": "integer" }, "memoryRequired": { "type": "integer" }, "name": { "type": "string" }, "readMe": { "type": "string" }, "recommend": { "type": "integer" }, "required": { "type": "string" }, "requiredPanelVersion": { "type": "number" }, "resource": { "type": "string" }, "shortDescEn": { "type": "string" }, "shortDescZh": { "type": "string" }, "status": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "model.AppIgnoreUpgrade": { "properties": { "appDetailID": { "type": "integer" }, "appID": { "type": "integer" }, "createdAt": { "type": "string" }, "id": { "type": "integer" }, "scope": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, "model.AppInstall": { "properties": { "app": { "$ref": "#/definitions/model.App" }, "appDetailId": { "type": "integer" }, "appId": { "type": "integer" }, "containerName": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "dockerCompose": { "type": "string" }, "env": { "type": "string" }, "favorite": { "type": "boolean" }, "httpPort": { "type": "integer" }, "httpsPort": { "type": "integer" }, "id": { "type": "integer" }, "message": { "type": "string" }, "name": { "type": "string" }, "param": { "type": "string" }, "serviceName": { "type": "string" }, "sortOrder": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "version": { "type": "string" }, "webUI": { "type": "string" } }, "type": "object" }, "model.Favorite": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "integer" }, "isDir": { "type": "boolean" }, "isTxt": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, "model.Runtime": { "properties": { "appDetailID": { "type": "integer" }, "codeDir": { "type": "string" }, "containerName": { "type": "string" }, "createdAt": { "type": "string" }, "dockerCompose": { "type": "string" }, "env": { "type": "string" }, "id": { "type": "integer" }, "image": { "type": "string" }, "message": { "type": "string" }, "name": { "type": "string" }, "params": { "type": "string" }, "port": { "type": "string" }, "remark": { "type": "string" }, "resource": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "version": { "type": "string" }, "workDir": { "type": "string" } }, "type": "object" }, "model.Website": { "properties": { "IPV6": { "type": "boolean" }, "accessLog": { "type": "boolean" }, "alias": { "type": "string" }, "appInstallId": { "type": "integer" }, "createdAt": { "type": "string" }, "dbID": { "type": "integer" }, "dbType": { "type": "string" }, "defaultServer": { "type": "boolean" }, "domains": { "items": { "$ref": "#/definitions/model.WebsiteDomain" }, "type": "array" }, "errorLog": { "type": "boolean" }, "expireDate": { "type": "string" }, "favorite": { "type": "boolean" }, "ftpId": { "type": "integer" }, "group": { "type": "string" }, "httpConfig": { "type": "string" }, "id": { "type": "integer" }, "parentWebsiteID": { "type": "integer" }, "primaryDomain": { "type": "string" }, "protocol": { "type": "string" }, "proxy": { "type": "string" }, "proxyType": { "type": "string" }, "remark": { "type": "string" }, "rewrite": { "type": "string" }, "runtimeID": { "type": "integer" }, "siteDir": { "type": "string" }, "status": { "type": "string" }, "streamPorts": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "user": { "type": "string" }, "webSiteGroupId": { "type": "integer" }, "webSiteSSL": { "$ref": "#/definitions/model.WebsiteSSL" }, "webSiteSSLId": { "type": "integer" } }, "type": "object" }, "model.WebsiteAcmeAccount": { "properties": { "caDirURL": { "type": "string" }, "createdAt": { "type": "string" }, "eabHmacKey": { "type": "string" }, "eabKid": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "integer" }, "keyType": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "url": { "type": "string" }, "useEAB": { "type": "boolean" }, "useProxy": { "type": "boolean" } }, "type": "object" }, "model.WebsiteDnsAccount": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, "model.WebsiteDomain": { "properties": { "createdAt": { "type": "string" }, "domain": { "type": "string" }, "id": { "type": "integer" }, "port": { "type": "integer" }, "ssl": { "type": "boolean" }, "updatedAt": { "type": "string" }, "websiteId": { "type": "integer" } }, "type": "object" }, "model.WebsiteSSL": { "properties": { "acmeAccount": { "$ref": "#/definitions/model.WebsiteAcmeAccount" }, "acmeAccountId": { "type": "integer" }, "autoRenew": { "type": "boolean" }, "caId": { "type": "integer" }, "certPath": { "type": "string" }, "certURL": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "dir": { "type": "string" }, "disableCNAME": { "type": "boolean" }, "dnsAccount": { "$ref": "#/definitions/model.WebsiteDnsAccount" }, "dnsAccountId": { "type": "integer" }, "domains": { "type": "string" }, "execShell": { "type": "boolean" }, "expireDate": { "type": "string" }, "id": { "type": "integer" }, "isIP": { "type": "boolean" }, "keyType": { "type": "string" }, "masterSslId": { "type": "integer" }, "message": { "type": "string" }, "nameserver1": { "type": "string" }, "nameserver2": { "type": "string" }, "nodes": { "type": "string" }, "organization": { "type": "string" }, "pem": { "type": "string" }, "primaryDomain": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyPath": { "type": "string" }, "provider": { "type": "string" }, "pushDir": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "shell": { "type": "string" }, "skipDNS": { "type": "boolean" }, "startDate": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "websites": { "items": { "$ref": "#/definitions/model.Website" }, "type": "array" } }, "type": "object" }, "request.AppConfigUpdate": { "properties": { "installID": { "type": "integer" }, "webUI": { "type": "string" } }, "required": [ "installID" ], "type": "object" }, "request.AppIgnoreUpgradeReq": { "properties": { "appDetailID": { "type": "integer" }, "appID": { "type": "integer" }, "scope": { "enum": [ "all", "version" ], "type": "string" } }, "required": [ "appID", "scope" ], "type": "object" }, "request.AppInstallCreate": { "properties": { "advanced": { "type": "boolean" }, "allowPort": { "type": "boolean" }, "appDetailId": { "type": "integer" }, "appKey": { "type": "string" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "gpuConfig": { "type": "boolean" }, "hostMode": { "type": "boolean" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "name": { "type": "string" }, "nodes": { "items": { "type": "string" }, "type": "array" }, "params": { "additionalProperties": true, "type": "object" }, "pullImage": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "restartPolicy": { "enum": [ "always", "unless-stopped", "no", "on-failure" ], "type": "string" }, "services": { "additionalProperties": { "type": "string" }, "type": "object" }, "specifyIP": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "webUI": { "type": "string" } }, "required": [ "appDetailId", "name" ], "type": "object" }, "request.AppInstallSort": { "properties": { "items": { "items": { "$ref": "#/definitions/request.AppInstallSortItem" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "request.AppInstallSortItem": { "properties": { "installID": { "type": "integer" }, "sortOrder": { "type": "integer" } }, "type": "object" }, "request.AppInstalledInfo": { "properties": { "key": { "type": "string" }, "name": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "request.AppInstalledOperate": { "properties": { "backup": { "type": "boolean" }, "backupId": { "type": "integer" }, "deleteBackup": { "type": "boolean" }, "deleteDB": { "type": "boolean" }, "deleteImage": { "type": "boolean" }, "detailId": { "type": "integer" }, "dockerCompose": { "type": "string" }, "favorite": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "installId": { "type": "integer" }, "operate": { "type": "string" }, "pullImage": { "type": "boolean" }, "taskID": { "type": "string" } }, "required": [ "installId", "operate" ], "type": "object" }, "request.AppInstalledSearch": { "properties": { "all": { "type": "boolean" }, "checkUpdate": { "type": "boolean" }, "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sync": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "unused": { "type": "boolean" }, "update": { "type": "boolean" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.AppInstalledUpdate": { "properties": { "advanced": { "type": "boolean" }, "allowPort": { "type": "boolean" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "gpuConfig": { "type": "boolean" }, "hostMode": { "type": "boolean" }, "installId": { "type": "integer" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "params": { "additionalProperties": true, "type": "object" }, "pullImage": { "type": "boolean" }, "restartPolicy": { "enum": [ "always", "unless-stopped", "no", "on-failure" ], "type": "string" }, "specifyIP": { "type": "string" }, "type": { "type": "string" }, "webUI": { "type": "string" } }, "required": [ "installId", "params" ], "type": "object" }, "request.AppSearch": { "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "recommend": { "type": "boolean" }, "resource": { "type": "string" }, "showCurrentArch": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.BatchWebsiteGroup": { "properties": { "groupID": { "type": "integer" }, "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "groupID", "ids" ], "type": "object" }, "request.BatchWebsiteHttps": { "properties": { "SSLProtocol": { "items": { "type": "string" }, "type": "array" }, "algorithm": { "type": "string" }, "certificate": { "type": "string" }, "certificatePath": { "type": "string" }, "hsts": { "type": "boolean" }, "hstsIncludeSubDomains": { "type": "boolean" }, "http3": { "type": "boolean" }, "httpConfig": { "enum": [ "HTTPSOnly", "HTTPAlso", "HTTPToHTTPS" ], "type": "string" }, "httpsPorts": { "items": { "type": "integer" }, "type": "array" }, "ids": { "items": { "type": "integer" }, "type": "array" }, "importType": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyPath": { "type": "string" }, "taskID": { "type": "string" }, "type": { "enum": [ "existed", "auto", "manual" ], "type": "string" }, "websiteSSLId": { "type": "integer" } }, "required": [ "ids", "taskID" ], "type": "object" }, "request.BatchWebsiteOp": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" }, "operate": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "ids", "operate", "taskID" ], "type": "object" }, "request.ChangeDatabase": { "properties": { "databaseID": { "type": "integer" }, "databaseType": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.CorsConfig": { "properties": { "allowCredentials": { "type": "boolean" }, "allowHeaders": { "type": "string" }, "allowMethods": { "type": "string" }, "allowOrigins": { "type": "string" }, "cors": { "type": "boolean" }, "preflight": { "type": "boolean" } }, "type": "object" }, "request.CorsConfigReq": { "properties": { "allowCredentials": { "type": "boolean" }, "allowHeaders": { "type": "string" }, "allowMethods": { "type": "string" }, "allowOrigins": { "type": "string" }, "cors": { "type": "boolean" }, "preflight": { "type": "boolean" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.CrossSiteAccessOp": { "properties": { "operation": { "enum": [ "Enable", "Disable" ], "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "operation", "websiteID" ], "type": "object" }, "request.CustomRewriteOperate": { "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "operate": { "enum": [ "create", "delete" ], "type": "string" } }, "required": [ "operate" ], "type": "object" }, "request.DirSizeReq": { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.DiskMountRequest": { "properties": { "autoMount": { "type": "boolean" }, "device": { "type": "string" }, "filesystem": { "enum": [ "ext4", "xfs" ], "type": "string" }, "mountPoint": { "type": "string" }, "noFail": { "type": "boolean" } }, "required": [ "device", "filesystem", "mountPoint" ], "type": "object" }, "request.DiskPartitionRequest": { "properties": { "autoMount": { "type": "boolean" }, "device": { "type": "string" }, "filesystem": { "enum": [ "ext4", "xfs" ], "type": "string" }, "label": { "type": "string" }, "mountPoint": { "type": "string" } }, "required": [ "device", "filesystem", "mountPoint" ], "type": "object" }, "request.DiskUnmountRequest": { "properties": { "mountPoint": { "type": "string" } }, "required": [ "mountPoint" ], "type": "object" }, "request.Environment": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "request.ExecComposerReq": { "properties": { "command": { "type": "string" }, "dir": { "type": "string" }, "extCommand": { "type": "string" }, "mirror": { "type": "string" }, "taskID": { "type": "string" }, "user": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "command", "dir", "mirror", "taskID", "user", "websiteID" ], "type": "object" }, "request.ExposedPort": { "properties": { "containerPort": { "type": "integer" }, "hostIP": { "type": "string" }, "hostPort": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "request.ExtraHost": { "properties": { "hostname": { "type": "string" }, "ip": { "type": "string" } }, "type": "object" }, "request.FPMConfig": { "properties": { "id": { "type": "integer" }, "params": { "additionalProperties": true, "type": "object" } }, "required": [ "id", "params" ], "type": "object" }, "request.FavoriteCreate": { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FavoriteDelete": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.FileAISearch": { "properties": { "containSub": { "type": "boolean" }, "contentHitsPromptMaxBytes": { "type": "integer" }, "extensions": { "items": { "type": "string" }, "type": "array" }, "llmMaxOutputTokens": { "type": "integer" }, "matchCase": { "type": "boolean" }, "maxFileBytes": { "type": "integer" }, "maxHitsPerFile": { "type": "integer" }, "maxItems": { "maximum": 2000, "minimum": 1, "type": "integer" }, "maxScanFiles": { "type": "integer" }, "maxSize": { "type": "integer" }, "maxTotalHits": { "type": "integer" }, "minSize": { "type": "integer" }, "modifiedAfter": { "type": "string" }, "modifiedBefore": { "type": "string" }, "path": { "type": "string" }, "query": { "type": "string" }, "responseLanguage": { "type": "string" }, "useRegex": { "type": "boolean" }, "wholeWord": { "type": "boolean" } }, "required": [ "path", "query" ], "type": "object" }, "request.FileBatchDelete": { "properties": { "isDir": { "type": "boolean" }, "paths": { "items": { "type": "string" }, "type": "array" } }, "required": [ "paths" ], "type": "object" }, "request.FileCompress": { "properties": { "dst": { "type": "string" }, "files": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "replace": { "type": "boolean" }, "secret": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" } }, "required": [ "dst", "files", "name", "type" ], "type": "object" }, "request.FileCompressStopReq": { "properties": { "taskID": { "type": "string" } }, "required": [ "taskID" ], "type": "object" }, "request.FileContentReq": { "properties": { "isDetail": { "type": "boolean" }, "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FileConvert": { "properties": { "extension": { "type": "string" }, "inputFile": { "type": "string" }, "outputFormat": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "extension", "inputFile", "outputFormat", "path", "type" ], "type": "object" }, "request.FileCreate": { "properties": { "content": { "type": "string" }, "isDir": { "type": "boolean" }, "isLink": { "type": "boolean" }, "isSymlink": { "type": "boolean" }, "linkPath": { "type": "string" }, "mode": { "type": "integer" }, "path": { "type": "string" }, "sub": { "type": "boolean" } }, "required": [ "path" ], "type": "object" }, "request.FileDeCompress": { "properties": { "dst": { "type": "string" }, "path": { "type": "string" }, "secret": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" } }, "required": [ "dst", "path", "type" ], "type": "object" }, "request.FileDeCompressStopReq": { "properties": { "taskID": { "type": "string" } }, "required": [ "taskID" ], "type": "object" }, "request.FileDelete": { "properties": { "forceDelete": { "type": "boolean" }, "isDir": { "type": "boolean" }, "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FileDownload": { "properties": { "compress": { "type": "boolean" }, "name": { "type": "string" }, "paths": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "name", "paths", "type" ], "type": "object" }, "request.FileEdit": { "properties": { "content": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FileHistoryContentReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.FileHistoryDeleteReq": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "request.FileHistoryRestoreReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.FileHistorySearchReq": { "properties": { "operation": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "path": { "type": "string" }, "scope": { "enum": [ "current", "all" ], "type": "string" } }, "required": [ "page", "pageSize", "scope" ], "type": "object" }, "request.FileHistorySettingUpdate": { "properties": { "diskQuotaMB": { "maximum": 1048576, "minimum": 0, "type": "integer" }, "enable": { "enum": [ "Enable", "Disable" ], "type": "string" }, "maxPerPath": { "maximum": 1000, "minimum": 0, "type": "integer" } }, "required": [ "enable" ], "type": "object" }, "request.FileMove": { "properties": { "cover": { "type": "boolean" }, "coverPaths": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "newPath": { "type": "string" }, "oldPaths": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" }, "type": { "type": "string" } }, "required": [ "newPath", "oldPaths", "type" ], "type": "object" }, "request.FileMoveStopReq": { "properties": { "taskID": { "type": "string" } }, "required": [ "taskID" ], "type": "object" }, "request.FileOption": { "properties": { "containSub": { "type": "boolean" }, "dir": { "type": "boolean" }, "expand": { "type": "boolean" }, "isDetail": { "type": "boolean" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "path": { "type": "string" }, "search": { "type": "string" }, "showHidden": { "type": "boolean" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" } }, "type": "object" }, "request.FilePathCheck": { "properties": { "path": { "type": "string" }, "withInit": { "type": "boolean" } }, "required": [ "path" ], "type": "object" }, "request.FilePathsCheck": { "properties": { "paths": { "items": { "type": "string" }, "type": "array" } }, "required": [ "paths" ], "type": "object" }, "request.FileProcessReq": { "properties": { "key": { "type": "string" } }, "type": "object" }, "request.FileReadByLineReq": { "properties": { "ID": { "type": "integer" }, "latest": { "type": "boolean" }, "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "resourceID": { "type": "integer" }, "taskID": { "type": "string" }, "taskOperate": { "type": "string" }, "taskType": { "type": "string" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.FileRemarkBatch": { "properties": { "paths": { "items": { "type": "string" }, "type": "array" } }, "required": [ "paths" ], "type": "object" }, "request.FileRemarkUpdate": { "properties": { "path": { "type": "string" }, "remark": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FileRename": { "properties": { "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "newName", "oldName" ], "type": "object" }, "request.FileRoleReq": { "properties": { "group": { "type": "string" }, "mode": { "type": "integer" }, "paths": { "items": { "type": "string" }, "type": "array" }, "sub": { "type": "boolean" }, "user": { "type": "string" } }, "required": [ "group", "mode", "paths", "user" ], "type": "object" }, "request.FileRoleUpdate": { "properties": { "group": { "type": "string" }, "path": { "type": "string" }, "sub": { "type": "boolean" }, "user": { "type": "string" } }, "required": [ "group", "path", "user" ], "type": "object" }, "request.FileShareCreate": { "properties": { "expireMinutes": { "maximum": 10080, "minimum": 0, "type": "integer" }, "password": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "request.FileWget": { "properties": { "ignoreCertificate": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "useProxy": { "type": "boolean" } }, "required": [ "name", "path", "url" ], "type": "object" }, "request.HostSupervisorProcessFileGetReq": { "properties": { "file": { "enum": [ "out.log", "err.log", "config" ], "type": "string" }, "name": { "type": "string" } }, "required": [ "file", "name" ], "type": "object" }, "request.HostSupervisorProcessFileOperateReq": { "properties": { "content": { "type": "string" }, "file": { "enum": [ "out.log", "err.log", "config" ], "type": "string" }, "name": { "type": "string" }, "operate": { "enum": [ "clear", "update" ], "type": "string" } }, "required": [ "file", "name", "operate" ], "type": "object" }, "request.HostToolConfigUpdate": { "properties": { "content": { "type": "string" }, "type": { "enum": [ "supervisord" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "request.HostToolCreate": { "properties": { "configPath": { "type": "string" }, "serviceName": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "request.HostToolOperateReq": { "properties": { "operate": { "enum": [ "restart", "start", "stop" ], "type": "string" }, "type": { "enum": [ "supervisord" ], "type": "string" } }, "required": [ "operate", "type" ], "type": "object" }, "request.HostToolTypeReq": { "properties": { "type": { "enum": [ "supervisord" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "request.McpBindDomain": { "properties": { "domain": { "type": "string" }, "ipList": { "type": "string" }, "sslID": { "type": "integer" } }, "required": [ "domain" ], "type": "object" }, "request.McpBindDomainUpdate": { "properties": { "ipList": { "type": "string" }, "sslID": { "type": "integer" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.McpServerConnectionTest": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.McpServerCreate": { "properties": { "baseUrl": { "type": "string" }, "command": { "type": "string" }, "containerName": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "gatewayArgs": { "maxLength": 4096, "type": "string" }, "gatewayImage": { "type": "string" }, "hostIP": { "type": "string" }, "name": { "type": "string" }, "outputTransport": { "type": "string" }, "port": { "type": "integer" }, "protocolVersion": { "type": "string" }, "ssePath": { "type": "string" }, "streamableHttpPath": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "required": [ "command", "name", "outputTransport", "port", "type" ], "type": "object" }, "request.McpServerDelete": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.McpServerDetail": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.McpServerOperate": { "properties": { "id": { "type": "integer" }, "operate": { "type": "string" } }, "required": [ "id", "operate" ], "type": "object" }, "request.McpServerSearch": { "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sync": { "type": "boolean" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.McpServerStatusSync": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "request.McpServerUpdate": { "properties": { "baseUrl": { "type": "string" }, "command": { "type": "string" }, "containerName": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "gatewayArgs": { "maxLength": 4096, "type": "string" }, "gatewayImage": { "type": "string" }, "hostIP": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "outputTransport": { "type": "string" }, "port": { "type": "integer" }, "protocolVersion": { "type": "string" }, "ssePath": { "type": "string" }, "streamableHttpPath": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "required": [ "command", "id", "name", "outputTransport", "port", "type" ], "type": "object" }, "request.NewAppInstall": { "properties": { "advanced": { "type": "boolean" }, "allowPort": { "type": "boolean" }, "appDetailID": { "type": "integer" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "gpuConfig": { "type": "boolean" }, "hostMode": { "type": "boolean" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "name": { "type": "string" }, "params": { "additionalProperties": true, "type": "object" }, "pullImage": { "type": "boolean" }, "restartPolicy": { "enum": [ "always", "unless-stopped", "no", "on-failure" ], "type": "string" }, "specifyIP": { "type": "string" }, "type": { "type": "string" }, "webUI": { "type": "string" } }, "type": "object" }, "request.NginxAntiLeechUpdate": { "properties": { "blocked": { "type": "boolean" }, "cache": { "type": "boolean" }, "cacheTime": { "type": "integer" }, "cacheUint": { "type": "string" }, "enable": { "type": "boolean" }, "extends": { "type": "string" }, "logEnable": { "type": "boolean" }, "noneRef": { "type": "boolean" }, "return": { "type": "string" }, "serverNames": { "items": { "type": "string" }, "type": "array" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.NginxAuthReq": { "properties": { "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.NginxAuthUpdate": { "properties": { "operate": { "type": "string" }, "password": { "type": "string" }, "remark": { "type": "string" }, "username": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "operate", "websiteID" ], "type": "object" }, "request.NginxBuildReq": { "properties": { "force": { "type": "boolean" }, "mirror": { "type": "string" }, "modules": { "items": { "type": "string" }, "type": "array" }, "taskID": { "type": "string" } }, "required": [ "mirror", "taskID" ], "type": "object" }, "request.NginxCommonReq": { "properties": { "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.NginxConfigFileUpdate": { "properties": { "backup": { "type": "boolean" }, "content": { "type": "string" } }, "required": [ "content" ], "type": "object" }, "request.NginxConfigUpdate": { "properties": { "operate": { "enum": [ "add", "update", "delete" ], "type": "string" }, "params": {}, "scope": { "$ref": "#/definitions/dto.NginxKey" }, "websiteId": { "type": "integer" } }, "required": [ "operate" ], "type": "object" }, "request.NginxDefaultHTTPSUpdate": { "properties": { "operate": { "enum": [ "enable", "disable" ], "type": "string" }, "sslRejectHandshake": { "type": "boolean" } }, "required": [ "operate" ], "type": "object" }, "request.NginxModuleUpdate": { "properties": { "buildMode": { "enum": [ "dynamic", "static" ], "type": "string" }, "enable": { "type": "boolean" }, "loadOrder": { "maximum": 9999, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "operate": { "enum": [ "create", "delete", "update" ], "type": "string" }, "packages": { "type": "string" }, "params": { "type": "string" }, "provider": { "enum": [ "local", "prebuilt" ], "type": "string" }, "script": { "type": "string" } }, "required": [ "name", "operate" ], "type": "object" }, "request.NginxPathAuthUpdate": { "properties": { "name": { "type": "string" }, "operate": { "type": "string" }, "password": { "type": "string" }, "path": { "type": "string" }, "remark": { "type": "string" }, "username": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "operate", "websiteID" ], "type": "object" }, "request.NginxProxyCacheUpdate": { "properties": { "cacheExpire": { "type": "integer" }, "cacheExpireUnit": { "type": "string" }, "cacheLimit": { "type": "integer" }, "cacheLimitUnit": { "type": "string" }, "open": { "type": "boolean" }, "shareCache": { "type": "integer" }, "shareCacheUnit": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "cacheExpire", "cacheExpireUnit", "cacheLimit", "cacheLimitUnit", "shareCache", "shareCacheUnit", "websiteID" ], "type": "object" }, "request.NginxProxyUpdate": { "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "content", "name", "websiteID" ], "type": "object" }, "request.NginxRedirectReq": { "properties": { "domains": { "items": { "type": "string" }, "type": "array" }, "enable": { "type": "boolean" }, "keepPath": { "type": "boolean" }, "name": { "type": "string" }, "operate": { "type": "string" }, "path": { "type": "string" }, "redirect": { "type": "string" }, "redirectRoot": { "type": "boolean" }, "target": { "type": "string" }, "type": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "name", "operate", "redirect", "target", "type", "websiteID" ], "type": "object" }, "request.NginxRedirectUpdate": { "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "content", "name", "websiteID" ], "type": "object" }, "request.NginxRewriteReq": { "properties": { "name": { "type": "string" }, "websiteId": { "type": "integer" } }, "required": [ "name", "websiteId" ], "type": "object" }, "request.NginxRewriteUpdate": { "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "websiteId": { "type": "integer" } }, "required": [ "name", "websiteId" ], "type": "object" }, "request.NginxScopeReq": { "properties": { "scope": { "$ref": "#/definitions/dto.NginxKey" }, "websiteId": { "type": "integer" } }, "required": [ "scope" ], "type": "object" }, "request.NodeModuleReq": { "properties": { "ID": { "type": "integer" } }, "required": [ "ID" ], "type": "object" }, "request.NodePackageReq": { "properties": { "codeDir": { "type": "string" } }, "type": "object" }, "request.PHPConfigUpdate": { "properties": { "disableFunctions": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "integer" }, "maxExecutionTime": { "type": "string" }, "params": { "additionalProperties": { "type": "string" }, "type": "object" }, "scope": { "type": "string" }, "uploadMaxSize": { "type": "string" } }, "required": [ "id", "scope" ], "type": "object" }, "request.PHPContainerConfig": { "properties": { "containerName": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "extraHosts": { "items": { "$ref": "#/definitions/request.ExtraHost" }, "type": "array" }, "id": { "type": "integer" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "request.PHPExtensionInstallReq": { "properties": { "ID": { "type": "integer" }, "name": { "type": "string" }, "taskID": { "type": "string" } }, "required": [ "ID", "name" ], "type": "object" }, "request.PHPExtensionsCreate": { "properties": { "extensions": { "type": "string" }, "name": { "type": "string" } }, "required": [ "extensions", "name" ], "type": "object" }, "request.PHPExtensionsDelete": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.PHPExtensionsSearch": { "properties": { "all": { "type": "boolean" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.PHPExtensionsUpdate": { "properties": { "extensions": { "type": "string" }, "id": { "type": "integer" } }, "required": [ "extensions", "id" ], "type": "object" }, "request.PHPFileReq": { "properties": { "id": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "request.PHPFileUpdate": { "properties": { "content": { "type": "string" }, "id": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "content", "id", "type" ], "type": "object" }, "request.PHPSupervisorProcessConfig": { "properties": { "autoRestart": { "type": "string" }, "autoStart": { "type": "string" }, "command": { "type": "string" }, "dir": { "type": "string" }, "environment": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "numprocs": { "type": "string" }, "operate": { "type": "string" }, "user": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "request.PHPSupervisorProcessFileReq": { "properties": { "content": { "type": "string" }, "file": { "enum": [ "out.log", "err.log", "config" ], "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "operate": { "enum": [ "get", "clear", "update" ], "type": "string" } }, "required": [ "file", "id", "name", "operate" ], "type": "object" }, "request.PortUpdate": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" } }, "type": "object" }, "request.ProcessReq": { "properties": { "PID": { "type": "integer" } }, "required": [ "PID" ], "type": "object" }, "request.RecycleBinReduce": { "properties": { "from": { "type": "string" }, "name": { "type": "string" }, "rName": { "type": "string" } }, "required": [ "from", "rName" ], "type": "object" }, "request.ReqWithID": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.RuntimeCreate": { "properties": { "appDetailId": { "type": "integer" }, "clean": { "type": "boolean" }, "codeDir": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "extraHosts": { "items": { "$ref": "#/definitions/request.ExtraHost" }, "type": "array" }, "image": { "type": "string" }, "install": { "type": "boolean" }, "name": { "type": "string" }, "params": { "additionalProperties": true, "type": "object" }, "remark": { "type": "string" }, "resource": { "type": "string" }, "source": { "type": "string" }, "taskID": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "type": "object" }, "request.RuntimeDelete": { "properties": { "deleteImage": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" }, "taskID": { "type": "string" } }, "type": "object" }, "request.RuntimeOperate": { "properties": { "ID": { "type": "integer" }, "operate": { "type": "string" } }, "type": "object" }, "request.RuntimeRemark": { "properties": { "id": { "type": "integer" }, "remark": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "request.RuntimeSearch": { "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.RuntimeUpdate": { "properties": { "clean": { "type": "boolean" }, "codeDir": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "extraHosts": { "items": { "$ref": "#/definitions/request.ExtraHost" }, "type": "array" }, "id": { "type": "integer" }, "image": { "type": "string" }, "install": { "type": "boolean" }, "name": { "type": "string" }, "params": { "additionalProperties": true, "type": "object" }, "rebuild": { "type": "boolean" }, "remark": { "type": "string" }, "source": { "type": "string" }, "version": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "type": "object" }, "request.SearchUploadWithPage": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "path": { "type": "string" } }, "required": [ "page", "pageSize", "path" ], "type": "object" }, "request.StreamUpdate": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" }, "streamPorts": { "type": "string" }, "udp": { "type": "boolean" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.SupervisorProcessConfig": { "properties": { "autoRestart": { "type": "string" }, "autoStart": { "type": "string" }, "command": { "type": "string" }, "dir": { "type": "string" }, "environment": { "type": "string" }, "name": { "type": "string" }, "numprocs": { "type": "string" }, "operate": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "request.TaskLogReadReq": { "properties": { "latest": { "type": "boolean" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "minimum": 1, "type": "integer" }, "resourceID": { "type": "integer" }, "taskID": { "type": "string" }, "taskOperate": { "type": "string" }, "taskType": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.TensorRTLLMCreate": { "properties": { "command": { "type": "string" }, "containerName": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "image": { "type": "string" }, "modelDir": { "type": "string" }, "modelSpeedup": { "type": "boolean" }, "modelType": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "required": [ "command", "containerName", "image", "modelDir", "name", "version" ], "type": "object" }, "request.TensorRTLLMDelete": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.TensorRTLLMOperate": { "properties": { "id": { "type": "integer" }, "operate": { "type": "string" } }, "required": [ "id", "operate" ], "type": "object" }, "request.TensorRTLLMSearch": { "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.TensorRTLLMUpdate": { "properties": { "command": { "type": "string" }, "containerName": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "id": { "type": "integer" }, "image": { "type": "string" }, "modelDir": { "type": "string" }, "modelSpeedup": { "type": "boolean" }, "modelType": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "required": [ "command", "containerName", "id", "image", "modelDir", "name", "version" ], "type": "object" }, "request.Volume": { "properties": { "mode": { "type": "string" }, "source": { "type": "string" }, "target": { "type": "string" } }, "type": "object" }, "request.WebsiteAcmeAccountCreate": { "properties": { "caDirURL": { "type": "string" }, "eabHmacKey": { "type": "string" }, "eabKid": { "type": "string" }, "email": { "type": "string" }, "keyType": { "enum": [ "EC256", "EC384", "RSA2048", "RSA3072", "RSA4096", "RSA8192" ], "type": "string" }, "type": { "enum": [ "letsencrypt", "zerossl", "buypass", "google", "custom" ], "type": "string" }, "useEAB": { "type": "boolean" }, "useProxy": { "type": "boolean" } }, "required": [ "email", "keyType", "type" ], "type": "object" }, "request.WebsiteAcmeAccountUpdate": { "properties": { "id": { "type": "integer" }, "useProxy": { "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteBatchDelReq": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "request.WebsiteCACreate": { "properties": { "city": { "type": "string" }, "commonName": { "type": "string" }, "country": { "type": "string" }, "keyType": { "enum": [ "EC256", "EC384", "RSA2048", "RSA3072", "RSA4096", "RSA8192" ], "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "organizationUint": { "type": "string" }, "province": { "type": "string" } }, "required": [ "commonName", "country", "keyType", "name", "organization" ], "type": "object" }, "request.WebsiteCAObtain": { "properties": { "autoRenew": { "type": "boolean" }, "description": { "type": "string" }, "dir": { "type": "string" }, "domains": { "type": "string" }, "execShell": { "type": "boolean" }, "id": { "type": "integer" }, "keyType": { "enum": [ "EC256", "EC384", "RSA2048", "RSA3072", "RSA4096", "RSA8192" ], "type": "string" }, "nodes": { "type": "string" }, "pushDir": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "renew": { "type": "boolean" }, "shell": { "type": "string" }, "sslID": { "type": "integer" }, "time": { "type": "integer" }, "unit": { "type": "string" } }, "required": [ "domains", "id", "keyType", "time", "unit" ], "type": "object" }, "request.WebsiteCASearch": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.WebsiteCommonReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteCreate": { "properties": { "IPV6": { "type": "boolean" }, "algorithm": { "type": "string" }, "alias": { "type": "string" }, "appID": { "type": "integer" }, "appInstall": { "$ref": "#/definitions/request.NewAppInstall" }, "appInstallID": { "type": "integer" }, "appType": { "enum": [ "new", "installed" ], "type": "string" }, "createDb": { "type": "boolean" }, "dbFormat": { "type": "string" }, "dbHost": { "type": "string" }, "dbName": { "type": "string" }, "dbPassword": { "type": "string" }, "dbUser": { "type": "string" }, "domains": { "items": { "$ref": "#/definitions/request.WebsiteDomain" }, "type": "array" }, "enableSSL": { "type": "boolean" }, "ftpPassword": { "type": "string" }, "ftpUser": { "type": "string" }, "name": { "type": "string" }, "parentWebsiteID": { "type": "integer" }, "port": { "type": "integer" }, "proxy": { "type": "string" }, "proxyType": { "type": "string" }, "remark": { "type": "string" }, "runtimeID": { "type": "integer" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" }, "siteDir": { "type": "string" }, "streamPorts": { "type": "string" }, "taskID": { "type": "string" }, "templateOutputID": { "type": "integer" }, "type": { "type": "string" }, "udp": { "type": "boolean" }, "webSiteGroupID": { "type": "integer" }, "websiteSSLID": { "type": "integer" } }, "required": [ "alias", "type", "webSiteGroupID" ], "type": "object" }, "request.WebsiteDNSReq": { "properties": { "acmeAccountId": { "type": "integer" }, "websiteSSLId": { "type": "integer" } }, "required": [ "acmeAccountId", "websiteSSLId" ], "type": "object" }, "request.WebsiteDefaultUpdate": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "request.WebsiteDelete": { "properties": { "deleteApp": { "type": "boolean" }, "deleteBackup": { "type": "boolean" }, "deleteDB": { "type": "boolean" }, "forceDelete": { "type": "boolean" }, "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteDnsAccountCreate": { "properties": { "authorization": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "authorization", "name", "type" ], "type": "object" }, "request.WebsiteDnsAccountUpdate": { "properties": { "authorization": { "additionalProperties": { "type": "string" }, "type": "object" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "authorization", "id", "name", "type" ], "type": "object" }, "request.WebsiteDomain": { "properties": { "domain": { "type": "string" }, "port": { "type": "integer" }, "ssl": { "type": "boolean" } }, "required": [ "domain" ], "type": "object" }, "request.WebsiteDomainCreate": { "properties": { "domains": { "items": { "$ref": "#/definitions/request.WebsiteDomain" }, "type": "array" }, "websiteID": { "type": "integer" } }, "required": [ "domains", "websiteID" ], "type": "object" }, "request.WebsiteDomainDelete": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteDomainUpdate": { "properties": { "id": { "type": "integer" }, "ssl": { "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteHTTPSOp": { "properties": { "SSLProtocol": { "items": { "type": "string" }, "type": "array" }, "algorithm": { "type": "string" }, "certificate": { "type": "string" }, "certificatePath": { "type": "string" }, "enable": { "type": "boolean" }, "hsts": { "type": "boolean" }, "hstsIncludeSubDomains": { "type": "boolean" }, "http3": { "type": "boolean" }, "httpConfig": { "enum": [ "HTTPSOnly", "HTTPAlso", "HTTPToHTTPS" ], "type": "string" }, "httpsPorts": { "items": { "type": "integer" }, "type": "array" }, "importType": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyPath": { "type": "string" }, "type": { "enum": [ "existed", "auto", "manual" ], "type": "string" }, "websiteId": { "type": "integer" }, "websiteSSLId": { "type": "integer" } }, "required": [ "websiteId" ], "type": "object" }, "request.WebsiteHtmlUpdate": { "properties": { "content": { "type": "string" }, "sync": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "content", "type" ], "type": "object" }, "request.WebsiteInstallCheckReq": { "properties": { "InstallIds": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "request.WebsiteLBCreate": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" }, "websiteID": { "type": "integer" } }, "required": [ "name", "websiteID" ], "type": "object" }, "request.WebsiteLBDelete": { "properties": { "name": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "name", "websiteID" ], "type": "object" }, "request.WebsiteLBUpdate": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" }, "websiteID": { "type": "integer" } }, "required": [ "name", "websiteID" ], "type": "object" }, "request.WebsiteLBUpdateFile": { "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "websiteID": { "type": "integer" } }, "required": [ "content", "name", "websiteID" ], "type": "object" }, "request.WebsiteLogReq": { "properties": { "id": { "type": "integer" }, "logType": { "enum": [ "access.log", "error.log" ], "type": "string" }, "operate": { "enum": [ "enable", "disable", "delete" ], "type": "string" } }, "required": [ "id", "logType", "operate" ], "type": "object" }, "request.WebsiteLogSearchReq": { "properties": { "id": { "type": "integer" }, "logType": { "enum": [ "access.log", "error.log" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "id", "logType" ], "type": "object" }, "request.WebsiteNginxUpdate": { "properties": { "content": { "type": "string" }, "id": { "type": "integer" } }, "required": [ "content", "id" ], "type": "object" }, "request.WebsiteOp": { "properties": { "id": { "type": "integer" }, "operate": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "request.WebsitePHPVersionReq": { "properties": { "runtimeID": { "type": "integer" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.WebsitePreviewReq": { "properties": { "templateID": { "type": "integer" }, "variableValues": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "templateID" ], "type": "object" }, "request.WebsiteProxyConfig": { "properties": { "allowCredentials": { "type": "boolean" }, "allowHeaders": { "type": "string" }, "allowMethods": { "type": "string" }, "allowOrigins": { "type": "string" }, "cache": { "type": "boolean" }, "cacheTime": { "type": "integer" }, "cacheUnit": { "type": "string" }, "content": { "type": "string" }, "cors": { "type": "boolean" }, "enable": { "type": "boolean" }, "filePath": { "type": "string" }, "id": { "type": "integer" }, "match": { "type": "string" }, "modifier": { "type": "string" }, "name": { "type": "string" }, "operate": { "type": "string" }, "preflight": { "type": "boolean" }, "proxyHost": { "type": "string" }, "proxyPass": { "type": "string" }, "proxySSLName": { "type": "string" }, "replaces": { "additionalProperties": { "type": "string" }, "type": "object" }, "serverCacheTime": { "type": "integer" }, "serverCacheUnit": { "type": "string" }, "sni": { "type": "boolean" }, "sslVerify": { "type": "boolean" } }, "required": [ "id", "match", "name", "operate", "proxyHost", "proxyPass" ], "type": "object" }, "request.WebsiteProxyDel": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "request.WebsiteProxyReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteProxyStatusUpdate": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "name", "status" ], "type": "object" }, "request.WebsiteRealIP": { "properties": { "ipFrom": { "type": "string" }, "ipHeader": { "type": "string" }, "ipOther": { "type": "string" }, "open": { "type": "boolean" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "request.WebsiteResourceReq": { "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "request.WebsiteSSLApply": { "properties": { "ID": { "type": "integer" }, "nameservers": { "items": { "type": "string" }, "type": "array" }, "skipDNSCheck": { "type": "boolean" } }, "required": [ "ID" ], "type": "object" }, "request.WebsiteSSLCreate": { "properties": { "acmeAccountId": { "type": "integer" }, "apply": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "description": { "type": "string" }, "dir": { "type": "string" }, "disableCNAME": { "type": "boolean" }, "dnsAccountId": { "type": "integer" }, "execShell": { "type": "boolean" }, "id": { "type": "integer" }, "isIp": { "type": "boolean" }, "keyType": { "type": "string" }, "nameserver1": { "type": "string" }, "nameserver2": { "type": "string" }, "nodes": { "type": "string" }, "otherDomains": { "type": "string" }, "primaryDomain": { "type": "string" }, "provider": { "type": "string" }, "pushDir": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "shell": { "type": "string" }, "skipDNS": { "type": "boolean" } }, "required": [ "acmeAccountId", "primaryDomain", "provider" ], "type": "object" }, "request.WebsiteSSLListReq": { "properties": { "acmeAccountID": { "type": "string" } }, "type": "object" }, "request.WebsiteSSLPush": { "properties": { "id": { "type": "integer" }, "nodes": { "type": "string" }, "pushNode": { "type": "boolean" }, "sync": { "type": "boolean" }, "taskID": { "type": "string" } }, "required": [ "id", "taskID" ], "type": "object" }, "request.WebsiteSSLSearch": { "properties": { "acmeAccountID": { "type": "string" }, "domain": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "created_at", "updated_at", "expire_date" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.WebsiteSSLUpdate": { "properties": { "acmeAccountId": { "type": "integer" }, "apply": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "description": { "type": "string" }, "dir": { "type": "string" }, "disableCNAME": { "type": "boolean" }, "dnsAccountId": { "type": "integer" }, "execShell": { "type": "boolean" }, "id": { "type": "integer" }, "keyType": { "type": "string" }, "nameserver1": { "type": "string" }, "nameserver2": { "type": "string" }, "nodes": { "type": "string" }, "otherDomains": { "type": "string" }, "primaryDomain": { "type": "string" }, "provider": { "type": "string" }, "pushDir": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "shell": { "type": "string" }, "skipDNS": { "type": "boolean" } }, "required": [ "id", "primaryDomain", "provider" ], "type": "object" }, "request.WebsiteSSLUpload": { "properties": { "certificate": { "type": "string" }, "certificatePath": { "type": "string" }, "description": { "type": "string" }, "nodes": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyPath": { "type": "string" }, "pushNode": { "type": "boolean" }, "sslID": { "type": "integer" }, "type": { "enum": [ "paste", "local" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "request.WebsiteSearch": { "properties": { "name": { "type": "string" }, "order": { "enum": [ "null", "ascending", "descending" ], "type": "string" }, "orderBy": { "enum": [ "primary_domain", "type", "status", "createdAt", "expire_date", "created_at", "favorite" ], "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" }, "websiteGroupId": { "type": "integer" } }, "required": [ "order", "orderBy", "page", "pageSize" ], "type": "object" }, "request.WebsiteTemplateCreate": { "properties": { "content": { "type": "string" }, "filePath": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": "string" }, "type": { "enum": [ "single", "multi" ], "type": "string" }, "variables": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "request.WebsiteTemplateOutputCreate": { "properties": { "name": { "type": "string" }, "templateID": { "type": "integer" }, "variableValues": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "name", "templateID" ], "type": "object" }, "request.WebsiteTemplateOutputSearch": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "templateID": { "type": "integer" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.WebsiteTemplateSearch": { "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "page", "pageSize" ], "type": "object" }, "request.WebsiteTemplateUpdate": { "properties": { "content": { "type": "string" }, "filePath": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "type": { "enum": [ "single", "multi" ], "type": "string" }, "variables": { "type": "string" } }, "required": [ "id", "name", "type" ], "type": "object" }, "request.WebsiteUpdate": { "properties": { "IPV6": { "type": "boolean" }, "expireDate": { "type": "string" }, "favorite": { "type": "boolean" }, "id": { "type": "integer" }, "primaryDomain": { "type": "string" }, "remark": { "type": "string" }, "webSiteGroupID": { "type": "integer" } }, "required": [ "id", "primaryDomain" ], "type": "object" }, "request.WebsiteUpdateDir": { "properties": { "id": { "type": "integer" }, "siteDir": { "type": "string" } }, "required": [ "id", "siteDir" ], "type": "object" }, "request.WebsiteUpdateDirPermission": { "properties": { "group": { "type": "string" }, "id": { "type": "integer" }, "user": { "type": "string" } }, "required": [ "group", "id", "user" ], "type": "object" }, "response.AppConfig": { "properties": { "advanced": { "type": "boolean" }, "allowPort": { "type": "boolean" }, "containerName": { "type": "string" }, "cpuQuota": { "type": "number" }, "dockerCompose": { "type": "string" }, "editCompose": { "type": "boolean" }, "gpuConfig": { "type": "boolean" }, "hostMode": { "type": "boolean" }, "memoryLimit": { "type": "number" }, "memoryUnit": { "type": "string" }, "params": { "items": { "$ref": "#/definitions/response.AppParam" }, "type": "array" }, "pullImage": { "type": "boolean" }, "rawCompose": { "type": "string" }, "restartPolicy": { "enum": [ "always", "unless-stopped", "no", "on-failure" ], "type": "string" }, "specifyIP": { "type": "string" }, "type": { "type": "string" }, "webUI": { "type": "string" } }, "type": "object" }, "response.AppDTO": { "properties": { "architectures": { "type": "string" }, "batchInstallSupport": { "type": "boolean" }, "createdAt": { "type": "string" }, "crossVersionUpdate": { "type": "boolean" }, "description": { "type": "string" }, "document": { "type": "string" }, "github": { "type": "string" }, "gpuSupport": { "type": "boolean" }, "icon": { "type": "string" }, "id": { "type": "integer" }, "installed": { "type": "boolean" }, "key": { "type": "string" }, "lastModified": { "type": "integer" }, "limit": { "type": "integer" }, "memoryRequired": { "type": "integer" }, "name": { "type": "string" }, "readMe": { "type": "string" }, "recommend": { "type": "integer" }, "required": { "type": "string" }, "requiredPanelVersion": { "type": "number" }, "resource": { "type": "string" }, "shortDescEn": { "type": "string" }, "shortDescZh": { "type": "string" }, "status": { "type": "string" }, "tags": { "items": { "$ref": "#/definitions/response.TagDTO" }, "type": "array" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "versions": { "items": { "type": "string" }, "type": "array" }, "website": { "type": "string" } }, "type": "object" }, "response.AppDetailDTO": { "properties": { "appId": { "type": "integer" }, "architectures": { "type": "string" }, "createdAt": { "type": "string" }, "dockerCompose": { "type": "string" }, "downloadCallBackUrl": { "type": "string" }, "downloadUrl": { "type": "string" }, "enable": { "type": "boolean" }, "gpuSupport": { "type": "boolean" }, "hostMode": { "type": "boolean" }, "id": { "type": "integer" }, "image": { "type": "string" }, "lastModified": { "type": "integer" }, "lastVersion": { "type": "string" }, "memoryRequired": { "type": "integer" }, "params": {}, "status": { "type": "string" }, "update": { "type": "boolean" }, "updatedAt": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "response.AppDetailSimpleDTO": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "response.AppInstalledCheck": { "properties": { "app": { "type": "string" }, "appInstallId": { "type": "integer" }, "containerName": { "type": "string" }, "createdAt": { "type": "string" }, "httpPort": { "type": "integer" }, "httpsPort": { "type": "integer" }, "installPath": { "type": "string" }, "isExist": { "type": "boolean" }, "lastBackupAt": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" }, "websiteDir": { "type": "string" } }, "type": "object" }, "response.AppItem": { "properties": { "batchInstallSupport": { "type": "boolean" }, "description": { "type": "string" }, "gpuSupport": { "type": "boolean" }, "id": { "type": "integer" }, "installed": { "type": "boolean" }, "key": { "type": "string" }, "limit": { "type": "integer" }, "name": { "type": "string" }, "recommend": { "type": "integer" }, "status": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "type": "object" }, "response.AppParam": { "properties": { "edit": { "type": "boolean" }, "key": { "type": "string" }, "label": { "$ref": "#/definitions/dto.Locale" }, "labelEn": { "type": "string" }, "labelZh": { "type": "string" }, "multiple": { "type": "boolean" }, "required": { "type": "boolean" }, "rule": { "type": "string" }, "showValue": { "type": "string" }, "type": { "type": "string" }, "value": {}, "values": {} }, "type": "object" }, "response.AppRes": { "properties": { "items": { "items": { "$ref": "#/definitions/response.AppItem" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" }, "response.AppService": { "properties": { "config": {}, "from": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "response.AppUpdateRes": { "properties": { "appList": { "$ref": "#/definitions/dto.AppList" }, "appStoreLastModified": { "type": "integer" }, "canUpdate": { "type": "boolean" }, "isSyncing": { "type": "boolean" } }, "type": "object" }, "response.CompleteDiskInfo": { "properties": { "disks": { "items": { "$ref": "#/definitions/response.DiskInfo" }, "type": "array" }, "systemDisks": { "items": { "$ref": "#/definitions/response.DiskInfo" }, "type": "array" }, "totalCapacity": { "type": "integer" }, "totalDisks": { "type": "integer" }, "unpartitionedDisks": { "items": { "$ref": "#/definitions/response.DiskBasicInfo" }, "type": "array" } }, "type": "object" }, "response.ComponentInfo": { "properties": { "error": { "type": "string" }, "exists": { "type": "boolean" }, "path": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "response.Database": { "properties": { "databaseName": { "type": "string" }, "from": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "response.DatabaseConn": { "properties": { "containerName": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "serviceName": { "type": "string" }, "status": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "response.DepthDirSizeRes": { "properties": { "path": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "response.DirSizeRes": { "properties": { "size": { "type": "integer" } }, "required": [ "size" ], "type": "object" }, "response.DiskBasicInfo": { "properties": { "avail": { "type": "string" }, "device": { "type": "string" }, "diskType": { "type": "string" }, "filesystem": { "type": "string" }, "isMounted": { "type": "boolean" }, "isRemovable": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "model": { "type": "string" }, "mountPoint": { "type": "string" }, "serial": { "type": "string" }, "size": { "type": "string" }, "usePercent": { "type": "integer" }, "used": { "type": "string" } }, "type": "object" }, "response.DiskInfo": { "properties": { "avail": { "type": "string" }, "device": { "type": "string" }, "diskType": { "type": "string" }, "filesystem": { "type": "string" }, "isMounted": { "type": "boolean" }, "isRemovable": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "model": { "type": "string" }, "mountPoint": { "type": "string" }, "partitions": { "items": { "$ref": "#/definitions/response.DiskBasicInfo" }, "type": "array" }, "serial": { "type": "string" }, "size": { "type": "string" }, "usePercent": { "type": "integer" }, "used": { "type": "string" } }, "type": "object" }, "response.ExistFileInfo": { "properties": { "isDir": { "type": "boolean" }, "modTime": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "response.FileAIContentHit": { "properties": { "line": { "type": "integer" }, "path": { "type": "string" }, "text": { "type": "string" } }, "type": "object" }, "response.FileAISearchResult": { "properties": { "completionTokens": { "type": "integer" }, "contentHitsTruncated": { "type": "boolean" }, "contentScannedFiles": { "type": "integer" }, "duration": { "type": "string" }, "hits": { "items": { "$ref": "#/definitions/response.FileAIContentHit" }, "type": "array" }, "itemCount": { "type": "integer" }, "mode": { "type": "string" }, "preFiltered": { "type": "boolean" }, "promptTokens": { "type": "integer" }, "summary": { "type": "string" }, "totalTokens": { "type": "integer" }, "truncated": { "type": "boolean" } }, "type": "object" }, "response.FileHistoryInfo": { "properties": { "content": { "type": "string" }, "contentSHA": { "type": "string" }, "contentSize": { "type": "integer" }, "createdAt": { "type": "string" }, "currentContent": { "type": "string" }, "currentPath": { "type": "string" }, "deleted": { "type": "boolean" }, "extension": { "type": "string" }, "fileId": { "type": "string" }, "fileMode": { "type": "string" }, "fileName": { "type": "string" }, "id": { "type": "integer" }, "operation": { "type": "string" }, "path": { "type": "string" }, "previousId": { "type": "integer" }, "sourcePath": { "type": "string" }, "storagePath": { "type": "string" }, "targetPath": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, "response.FileHistorySettingInfo": { "properties": { "diskQuotaMB": { "type": "integer" }, "enable": { "type": "string" }, "maxPerPath": { "type": "integer" } }, "type": "object" }, "response.FileInfo": { "properties": { "content": { "type": "string" }, "extension": { "type": "string" }, "favoriteID": { "type": "integer" }, "gid": { "type": "string" }, "group": { "type": "string" }, "isAppendOnly": { "type": "boolean" }, "isDetail": { "type": "boolean" }, "isDir": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isImmutable": { "type": "boolean" }, "isSymlink": { "type": "boolean" }, "itemTotal": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/files.FileInfo" }, "type": "array" }, "linkPath": { "type": "string" }, "mimeType": { "type": "string" }, "modTime": { "type": "string" }, "mode": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "shareCode": { "type": "string" }, "size": { "type": "integer" }, "type": { "type": "string" }, "uid": { "type": "string" }, "updateTime": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "response.FileLineContent": { "properties": { "end": { "type": "boolean" }, "lines": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "scope": { "type": "string" }, "taskStatus": { "type": "string" }, "total": { "type": "integer" }, "totalLines": { "type": "integer" } }, "type": "object" }, "response.FileRemarksRes": { "properties": { "remarks": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "response.FileShareInfo": { "properties": { "code": { "type": "string" }, "expiresAt": { "type": "integer" }, "fileName": { "type": "string" }, "hasPassword": { "type": "boolean" }, "password": { "type": "string" }, "path": { "type": "string" }, "permanent": { "type": "boolean" } }, "type": "object" }, "response.FileSharePublicInfo": { "properties": { "expiresAt": { "type": "integer" }, "fileName": { "type": "string" }, "hasPassword": { "type": "boolean" }, "permanent": { "type": "boolean" } }, "type": "object" }, "response.FileTree": { "properties": { "children": { "items": { "$ref": "#/definitions/response.FileTree" }, "type": "array" }, "extension": { "type": "string" }, "id": { "type": "string" }, "isDir": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "response.FileWgetRes": { "properties": { "key": { "type": "string" } }, "type": "object" }, "response.HostToolConfig": { "properties": { "content": { "type": "string" } }, "type": "object" }, "response.HostToolRes": { "properties": { "config": {}, "type": { "type": "string" } }, "type": "object" }, "response.McpBindDomainRes": { "properties": { "acmeAccountID": { "type": "integer" }, "allowIPs": { "items": { "type": "string" }, "type": "array" }, "connUrl": { "type": "string" }, "domain": { "type": "string" }, "sslID": { "type": "integer" }, "websiteID": { "type": "integer" } }, "type": "object" }, "response.McpServerConnectionTestRes": { "properties": { "endpoint": { "type": "string" }, "message": { "type": "string" }, "outputTransport": { "type": "string" }, "protocolVersion": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "response.McpServerDTO": { "properties": { "baseUrl": { "type": "string" }, "command": { "type": "string" }, "containerName": { "type": "string" }, "createdAt": { "type": "string" }, "dir": { "type": "string" }, "dockerCompose": { "type": "string" }, "env": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "gatewayArgs": { "type": "string" }, "gatewayImage": { "type": "string" }, "hostIP": { "type": "string" }, "id": { "type": "integer" }, "message": { "type": "string" }, "name": { "type": "string" }, "outputTransport": { "type": "string" }, "port": { "type": "integer" }, "protocolVersion": { "type": "string" }, "ssePath": { "type": "string" }, "status": { "type": "string" }, "streamableHttpPath": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" }, "websiteID": { "type": "integer" } }, "type": "object" }, "response.McpServerStatusDTO": { "properties": { "id": { "type": "integer" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "response.McpServersRes": { "properties": { "items": { "items": { "$ref": "#/definitions/response.McpServerDTO" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" }, "response.NginxAntiLeechRes": { "properties": { "blocked": { "type": "boolean" }, "cache": { "type": "boolean" }, "cacheTime": { "type": "integer" }, "cacheUint": { "type": "string" }, "enable": { "type": "boolean" }, "extends": { "type": "string" }, "logEnable": { "type": "boolean" }, "noneRef": { "type": "boolean" }, "return": { "type": "string" }, "serverNames": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "response.NginxAuthRes": { "properties": { "enable": { "type": "boolean" }, "items": { "items": { "$ref": "#/definitions/dto.NginxAuth" }, "type": "array" } }, "type": "object" }, "response.NginxBuildConfig": { "properties": { "dynamicSupported": { "type": "boolean" }, "mirror": { "type": "string" }, "modules": { "items": { "$ref": "#/definitions/response.NginxModule" }, "type": "array" } }, "type": "object" }, "response.NginxConfigRes": { "properties": { "https": { "type": "boolean" }, "sslRejectHandshake": { "type": "boolean" } }, "type": "object" }, "response.NginxFile": { "properties": { "content": { "type": "string" } }, "type": "object" }, "response.NginxModule": { "properties": { "artifacts": { "items": { "$ref": "#/definitions/dto.NginxModuleArtifact" }, "type": "array" }, "buildMode": { "type": "string" }, "buildStatus": { "type": "string" }, "custom": { "type": "boolean" }, "enable": { "type": "boolean" }, "lastError": { "type": "string" }, "loadOrder": { "type": "integer" }, "loadStatus": { "type": "string" }, "name": { "type": "string" }, "packages": { "type": "string" }, "params": { "type": "string" }, "provider": { "type": "string" }, "script": { "type": "string" } }, "type": "object" }, "response.NginxParam": { "properties": { "name": { "type": "string" }, "params": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "response.NginxPathAuthRes": { "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "remark": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "response.NginxProxyCache": { "properties": { "cacheExpire": { "type": "integer" }, "cacheExpireUnit": { "type": "string" }, "cacheLimit": { "type": "number" }, "cacheLimitUnit": { "type": "string" }, "open": { "type": "boolean" }, "shareCache": { "type": "integer" }, "shareCacheUnit": { "type": "string" } }, "type": "object" }, "response.NginxRedirectConfig": { "properties": { "content": { "type": "string" }, "domains": { "items": { "type": "string" }, "type": "array" }, "enable": { "type": "boolean" }, "filePath": { "type": "string" }, "keepPath": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" }, "redirect": { "type": "string" }, "redirectRoot": { "type": "boolean" }, "target": { "type": "string" }, "type": { "type": "string" }, "websiteID": { "type": "integer" } }, "type": "object" }, "response.NginxRewriteRes": { "properties": { "content": { "type": "string" } }, "type": "object" }, "response.NginxStatus": { "properties": { "accepts": { "type": "integer" }, "active": { "type": "integer" }, "handled": { "type": "integer" }, "reading": { "type": "integer" }, "requests": { "type": "integer" }, "waiting": { "type": "integer" }, "writing": { "type": "integer" } }, "type": "object" }, "response.NodeModule": { "properties": { "description": { "type": "string" }, "license": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "response.PHPConfig": { "properties": { "disableFunctions": { "items": { "type": "string" }, "type": "array" }, "maxExecutionTime": { "type": "string" }, "params": { "additionalProperties": { "type": "string" }, "type": "object" }, "uploadMaxSize": { "type": "string" } }, "type": "object" }, "response.PHPExtensionRes": { "properties": { "extensions": { "items": { "type": "string" }, "type": "array" }, "supportExtensions": { "items": { "$ref": "#/definitions/response.SupportExtension" }, "type": "array" } }, "type": "object" }, "response.PackageScripts": { "properties": { "name": { "type": "string" }, "script": { "type": "string" } }, "type": "object" }, "response.ProcessStatus": { "properties": { "PID": { "type": "string" }, "msg": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "uptime": { "type": "string" } }, "type": "object" }, "response.Resource": { "properties": { "detail": {}, "name": { "type": "string" }, "resourceID": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "response.RuntimeDTO": { "properties": { "appDetailID": { "type": "integer" }, "appID": { "type": "integer" }, "appParams": { "items": { "$ref": "#/definitions/response.AppParam" }, "type": "array" }, "codeDir": { "type": "string" }, "container": { "type": "string" }, "containerStatus": { "type": "string" }, "createdAt": { "type": "string" }, "environments": { "items": { "$ref": "#/definitions/request.Environment" }, "type": "array" }, "exposedPorts": { "items": { "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "extraHosts": { "items": { "$ref": "#/definitions/request.ExtraHost" }, "type": "array" }, "id": { "type": "integer" }, "image": { "type": "string" }, "message": { "type": "string" }, "name": { "type": "string" }, "params": { "additionalProperties": true, "type": "object" }, "path": { "type": "string" }, "port": { "type": "string" }, "remark": { "type": "string" }, "resource": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/request.Volume" }, "type": "array" } }, "type": "object" }, "response.SupervisorProcessConfig": { "properties": { "autoRestart": { "type": "string" }, "autoStart": { "type": "string" }, "command": { "type": "string" }, "dir": { "type": "string" }, "environment": { "type": "string" }, "msg": { "type": "string" }, "name": { "type": "string" }, "numprocs": { "type": "string" }, "status": { "items": { "$ref": "#/definitions/response.ProcessStatus" }, "type": "array" }, "user": { "type": "string" } }, "type": "object" }, "response.SupportExtension": { "properties": { "check": { "type": "string" }, "description": { "type": "string" }, "file": { "type": "string" }, "installed": { "type": "boolean" }, "name": { "type": "string" }, "versions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "response.TagDTO": { "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "response.UserGroupResponse": { "properties": { "groups": { "items": { "type": "string" }, "type": "array" }, "users": { "items": { "$ref": "#/definitions/response.UserInfo" }, "type": "array" } }, "type": "object" }, "response.UserInfo": { "properties": { "group": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "response.WebsiteAcmeAccountDTO": { "properties": { "caDirURL": { "type": "string" }, "createdAt": { "type": "string" }, "eabHmacKey": { "type": "string" }, "eabKid": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "integer" }, "keyType": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "url": { "type": "string" }, "useEAB": { "type": "boolean" }, "useProxy": { "type": "boolean" } }, "type": "object" }, "response.WebsiteCADTO": { "properties": { "city": { "type": "string" }, "commonName": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "csr": { "type": "string" }, "id": { "type": "integer" }, "keyType": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "organizationUint": { "type": "string" }, "privateKey": { "type": "string" }, "province": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, "response.WebsiteDNSRes": { "properties": { "domain": { "type": "string" }, "err": { "type": "string" }, "resolve": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "response.WebsiteDTO": { "properties": { "IPV6": { "type": "boolean" }, "accessLog": { "type": "boolean" }, "accessLogPath": { "type": "string" }, "algorithm": { "type": "string" }, "alias": { "type": "string" }, "appInstallId": { "type": "integer" }, "appName": { "type": "string" }, "createdAt": { "type": "string" }, "dbID": { "type": "integer" }, "dbType": { "type": "string" }, "defaultServer": { "type": "boolean" }, "domains": { "items": { "$ref": "#/definitions/model.WebsiteDomain" }, "type": "array" }, "errorLog": { "type": "boolean" }, "errorLogPath": { "type": "string" }, "expireDate": { "type": "string" }, "favorite": { "type": "boolean" }, "ftpId": { "type": "integer" }, "group": { "type": "string" }, "httpConfig": { "type": "string" }, "id": { "type": "integer" }, "openBaseDir": { "type": "boolean" }, "parentWebsiteID": { "type": "integer" }, "primaryDomain": { "type": "string" }, "protocol": { "type": "string" }, "proxy": { "type": "string" }, "proxyType": { "type": "string" }, "remark": { "type": "string" }, "rewrite": { "type": "string" }, "runtimeID": { "type": "integer" }, "runtimeName": { "type": "string" }, "runtimeType": { "type": "string" }, "servers": { "items": { "$ref": "#/definitions/dto.NginxUpstreamServer" }, "type": "array" }, "siteDir": { "type": "string" }, "sitePath": { "type": "string" }, "status": { "type": "string" }, "streamPorts": { "type": "string" }, "type": { "type": "string" }, "udp": { "type": "boolean" }, "updatedAt": { "type": "string" }, "user": { "type": "string" }, "webSiteGroupId": { "type": "integer" }, "webSiteSSL": { "$ref": "#/definitions/model.WebsiteSSL" }, "webSiteSSLId": { "type": "integer" } }, "type": "object" }, "response.WebsiteDirConfig": { "properties": { "dirs": { "items": { "type": "string" }, "type": "array" }, "msg": { "type": "string" }, "user": { "type": "string" }, "userGroup": { "type": "string" } }, "type": "object" }, "response.WebsiteHTTPS": { "properties": { "SSL": { "$ref": "#/definitions/model.WebsiteSSL" }, "SSLProtocol": { "items": { "type": "string" }, "type": "array" }, "algorithm": { "type": "string" }, "enable": { "type": "boolean" }, "hsts": { "type": "boolean" }, "hstsIncludeSubDomains": { "type": "boolean" }, "http3": { "type": "boolean" }, "httpConfig": { "type": "string" }, "httpsPort": { "type": "string" }, "httpsPorts": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "response.WebsiteHtmlRes": { "properties": { "content": { "type": "string" } }, "type": "object" }, "response.WebsiteLog": { "properties": { "content": { "type": "string" }, "enable": { "type": "boolean" }, "end": { "type": "boolean" }, "path": { "type": "string" } }, "type": "object" }, "response.WebsiteNginxConfig": { "properties": { "enable": { "type": "boolean" }, "params": { "items": { "$ref": "#/definitions/response.NginxParam" }, "type": "array" } }, "type": "object" }, "response.WebsiteOption": { "properties": { "alias": { "type": "string" }, "id": { "type": "integer" }, "primaryDomain": { "type": "string" } }, "type": "object" }, "response.WebsitePreInstallCheck": { "properties": { "appName": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "response.WebsitePreviewDTO": { "properties": { "html": { "type": "string" } }, "type": "object" }, "response.WebsiteRealIP": { "properties": { "ipFrom": { "type": "string" }, "ipHeader": { "type": "string" }, "ipOther": { "type": "string" }, "open": { "type": "boolean" }, "websiteID": { "type": "integer" } }, "required": [ "websiteID" ], "type": "object" }, "response.WebsiteSSLDTO": { "properties": { "acmeAccount": { "$ref": "#/definitions/model.WebsiteAcmeAccount" }, "acmeAccountId": { "type": "integer" }, "autoRenew": { "type": "boolean" }, "caId": { "type": "integer" }, "certPath": { "type": "string" }, "certURL": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "dir": { "type": "string" }, "disableCNAME": { "type": "boolean" }, "dnsAccount": { "$ref": "#/definitions/model.WebsiteDnsAccount" }, "dnsAccountId": { "type": "integer" }, "domains": { "type": "string" }, "execShell": { "type": "boolean" }, "expireDate": { "type": "string" }, "id": { "type": "integer" }, "isIP": { "type": "boolean" }, "keyType": { "type": "string" }, "logPath": { "type": "string" }, "masterSslId": { "type": "integer" }, "message": { "type": "string" }, "nameserver1": { "type": "string" }, "nameserver2": { "type": "string" }, "nodes": { "type": "string" }, "organization": { "type": "string" }, "pem": { "type": "string" }, "primaryDomain": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyPath": { "type": "string" }, "provider": { "type": "string" }, "pushDir": { "type": "boolean" }, "pushNode": { "type": "boolean" }, "shell": { "type": "string" }, "skipDNS": { "type": "boolean" }, "startDate": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" }, "websites": { "items": { "$ref": "#/definitions/model.Website" }, "type": "array" } }, "type": "object" }, "response.WebsiteTemplateDTO": { "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "filePath": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "type": { "description": "single | multi", "type": "string" }, "updatedAt": { "type": "string" }, "variables": { "type": "string" } }, "type": "object" }, "response.WebsiteTemplateOutputDTO": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "outputPath": { "type": "string" }, "templateID": { "type": "integer" }, "templateName": { "type": "string" }, "templateType": { "type": "string" }, "updatedAt": { "type": "string" }, "variableValues": { "type": "string" } }, "type": "object" } } }` var SwaggerInfo = &swag.Spec{ Version: "2.0", Host: "localhost", BasePath: "/api/v2", Schemes: []string{}, Title: "1Panel", Description: "Top-Rated Web-based Linux Server Management Tool", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }