v1

func (*BaseApi) ApplyWebsiteSSL ¶ added in v1.9.0

func (b *BaseApi) ApplyWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Apply ssl @Description 申请证书 @Accept json @Param request body request.WebsiteSSLApply true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/obtain [post] @x-panel-log {"bodyKeys":["ID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ID","isList":false,"db":"website_ssls","output_column":"primary_domain","output_value":"domain"}],"formatZH":"申请证书 [domain]","formatEN":"apply ssl [domain]"}

func (*BaseApi) Backup ¶

func (b *BaseApi) Backup(c *gin.Context)

@Tags Backup Account @Summary Backup system data @Description 备份系统数据 @Accept json @Param request body dto.CommonBackup true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/backup [post] @x-panel-log {"bodyKeys":["type","name","detailName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"备份 [type] 数据 [name][detailName]","formatEN":"backup [type] data [name][detailName]"}

func (*BaseApi) BatchChangeModeAndOwner ¶ added in v1.8.0

func (b *BaseApi) BatchChangeModeAndOwner(c *gin.Context)

@Tags File @Summary Batch change file mode and owner @Description 批量修改文件权限和用户/组 @Accept json @Param request body request.FileRoleReq true "request" @Success 200 @Security ApiKeyAuth @Router /files/batch/role [post] @x-panel-log {"bodyKeys":["paths","mode","user","group"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"批量修改文件权限和用户/组 [paths] => [mode]/[user]/[group]","formatEN":"Batch change file mode and owner [paths] => [mode]/[user]/[group]"}

func (*BaseApi) BatchDeleteFile ¶

func (b *BaseApi) BatchDeleteFile(c *gin.Context)

@Tags File @Summary Batch delete file @Description 批量删除文件/文件夹 @Accept json @Param request body request.FileBatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /files/batch/del [post] @x-panel-log {"bodyKeys":["paths"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"批量删除文件/文件夹 [paths]","formatEN":"Batch delete dir or file [paths]"}

func (*BaseApi) BatchOperateRule ¶ added in v1.1.0

func (b *BaseApi) BatchOperateRule(c *gin.Context)

@Tags Firewall @Summary Create group @Description 批量删除防火墙规则 @Accept json @Param request body dto.BatchRuleOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/batch [post]

func (*BaseApi) BindPostgresqlUser ¶ added in v1.9.3

func (b *BaseApi) BindPostgresqlUser(c *gin.Context)

@Tags Database Postgresql @Summary Bind postgresql user @Description 绑定 postgresql 数据库用户 @Accept json @Param request body dto.PostgresqlBindUser true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg/bind [post] @x-panel-log {"bodyKeys":["name", "username"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"绑定 postgresql 数据库 [name] 用户 [username]","formatEN":"bind postgresql database [name] user [username]"}

func (*BaseApi) BindUser ¶ added in v1.9.3

func (b *BaseApi) BindUser(c *gin.Context)

@Tags Database Mysql @Summary Bind user of mysql database @Description 绑定 mysql 数据库用户 @Accept json @Param request body dto.BindUser true "request" @Success 200 @Security ApiKeyAuth @Router /databases/bind [post] @x-panel-log {"bodyKeys":["database", "username"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"绑定 mysql 数据库名 [database] [username]","formatEN":"bind mysql database [database] [username]"}

func (*BaseApi) Captcha ¶

func (b *BaseApi) Captcha(c *gin.Context)

@Tags Auth @Summary Load captcha @Description 加载验证码 @Success 200 {object} dto.CaptchaResponse @Router /auth/captcha [get]

func (*BaseApi) ChangeAppPort ¶

func (b *BaseApi) ChangeAppPort(c *gin.Context)

@Tags App @Summary Change app port @Description 修改应用端口 @Accept json @Param request body request.PortUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /apps/installed/port/change [post] @x-panel-log {"bodyKeys":["key","name","port"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用端口修改 [key]-[name] => [port]","formatEN":"Application port update [key]-[name] => [port]"}

func (*BaseApi) ChangeDefaultServer ¶

func (b *BaseApi) ChangeDefaultServer(c *gin.Context)

@Tags Website @Summary Change default server @Description 操作网站日志 @Accept json @Param request body request.WebsiteDefaultUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/default/server [post] @x-panel-log {"bodyKeys":["id", "operate"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"修改默认 server => [domain]","formatEN":"Change default server => [domain]"}

func (*BaseApi) ChangeFileMode ¶

func (b *BaseApi) ChangeFileMode(c *gin.Context)

@Tags File @Summary Change file mode @Description 修改文件权限 @Accept json @Param request body request.FileCreate true "request" @Success 200 @Security ApiKeyAuth @Router /files/mode [post] @x-panel-log {"bodyKeys":["path","mode"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改权限 [paths] => [mode]","formatEN":"Change mode [paths] => [mode]"}

func (*BaseApi) ChangeFileName ¶

func (b *BaseApi) ChangeFileName(c *gin.Context)

@Tags File @Summary Change file name @Description 修改文件名称 @Accept json @Param request body request.FileRename true "request" @Success 200 @Security ApiKeyAuth @Router /files/rename [post] @x-panel-log {"bodyKeys":["oldName","newName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"重命名 [oldName] => [newName]","formatEN":"Rename [oldName] => [newName]"}

func (*BaseApi) ChangeFileOwner ¶ added in v1.2.0

func (b *BaseApi) ChangeFileOwner(c *gin.Context)

@Tags File @Summary Change file owner @Description 修改文件用户/组 @Accept json @Param request body request.FileRoleUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /files/owner [post] @x-panel-log {"bodyKeys":["path","user","group"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改用户/组 [paths] => [user]/[group]","formatEN":"Change owner [paths] => [user]/[group]"}

func (*BaseApi) ChangeMysqlAccess ¶

func (b *BaseApi) ChangeMysqlAccess(c *gin.Context)

@Tags Database Mysql @Summary Change mysql access @Description 修改 mysql 访问权限 @Accept json @Param request body dto.ChangeDBInfo true "request" @Success 200 @Security ApiKeyAuth @Router /databases/change/access [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_mysqls","output_column":"name","output_value":"name"}],"formatZH":"更新数据库 [name] 访问权限","formatEN":"Update database [name] access"}

func (*BaseApi) ChangeMysqlPassword ¶

func (b *BaseApi) ChangeMysqlPassword(c *gin.Context)

@Tags Database Mysql @Summary Change mysql password @Description 修改 mysql 密码 @Accept json @Param request body dto.ChangeDBInfo true "request" @Success 200 @Security ApiKeyAuth @Router /databases/change/password [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_mysqls","output_column":"name","output_value":"name"}],"formatZH":"更新数据库 [name] 密码","formatEN":"Update database [name] password"}

func (*BaseApi) ChangePHPVersion ¶ added in v1.5.0

func (b *BaseApi) ChangePHPVersion(c *gin.Context)

@Tags Website PHP @Summary Update php version @Description 变更 php 版本 @Accept json @Param request body request.WebsitePHPVersionReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/php/version [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"php 版本变更 [domain]","formatEN":"php version update [domain]"}

func (*BaseApi) ChangePostgresqlPassword ¶ added in v1.9.3

func (b *BaseApi) ChangePostgresqlPassword(c *gin.Context)

@Tags Database Postgresql @Summary Change postgresql password @Description 修改 postgresql 密码 @Accept json @Param request body dto.ChangeDBInfo true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg/password [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_postgresqls","output_column":"name","output_value":"name"}],"formatZH":"更新数据库 [name] 密码","formatEN":"Update database [name] password"}

func (*BaseApi) ChangePostgresqlPrivileges ¶ added in v1.9.3

func (b *BaseApi) ChangePostgresqlPrivileges(c *gin.Context)

@Tags Database Postgresql @Summary Change postgresql privileges @Description 修改 postgresql 用户权限 @Accept json @Param request body dto.ChangeDBInfo true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg/privileges [post] @x-panel-log {"bodyKeys":["database", "username"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新数据库 [database] 用户 [username] 权限","formatEN":"Update [user] privileges of database [database]"}

func (*BaseApi) ChangeRedisPassword ¶

func (b *BaseApi) ChangeRedisPassword(c *gin.Context)

@Tags Database Redis @Summary Change redis password @Description 更新 redis 密码 @Accept json @Param request body dto.ChangeRedisPass true "request" @Success 200 @Security ApiKeyAuth @Router /databases/redis/password [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改 redis 数据库密码","formatEN":"change the password of the redis database"}

func (*BaseApi) CheckAppInstalled ¶

func (b *BaseApi) CheckAppInstalled(c *gin.Context)

@Tags App @Summary Check app installed @Description 检查应用安装情况 @Accept json @Param request body request.AppInstalledInfo true "request" @Success 200 {object} response.AppInstalledCheck @Security ApiKeyAuth @Router /apps/installed/check [post]

func (*BaseApi) CheckDNS ¶ added in v1.9.0

func (b *BaseApi) CheckDNS(c *gin.Context)

@Tags Device @Summary Check device DNS conf @Description 检查系统 DNS 配置可用性 @Accept json @Param request body dto.SettingUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/check/dns [post]

func (*BaseApi) CheckDatabase ¶ added in v1.6.0

func (b *BaseApi) CheckDatabase(c *gin.Context)

@Tags Database @Summary Check database @Description 检测远程数据库连接性 @Accept json @Param request body dto.DatabaseCreate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/db/check [post] @x-panel-log {"bodyKeys":["name", "type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"检测远程数据库 [name][type] 连接性","formatEN":"check if database [name][type] is connectable"}

func (*BaseApi) CheckFile ¶

func (b *BaseApi) CheckFile(c *gin.Context)

@Tags File @Summary Check file exist @Description 检测文件是否存在 @Accept json @Param request body request.FilePathCheck true "request" @Success 200 @Security ApiKeyAuth @Router /files/check [post]

func (*BaseApi) CheckIsDemo ¶ added in v1.0.1

func (b *BaseApi) CheckIsDemo(c *gin.Context)

@Tags Auth @Summary Check System isDemo @Description 判断是否为demo环境 @Success 200 @Router /auth/demo [get]

func (*BaseApi) CheckIsSafety ¶ added in v1.2.0

func (b *BaseApi) CheckIsSafety(c *gin.Context)

@Tags Auth @Summary Load safety status @Description 获取系统安全登录状态 @Success 200 @Router /auth/issafety [get]

func (*BaseApi) CheckRepoStatus ¶

func (b *BaseApi) CheckRepoStatus(c *gin.Context)

@Tags Container Image-repo @Summary Load repo status @Description 获取 docker 仓库状态 @Accept json @Param request body dto.OperateByID true "request" @Produce json @Success 200 @Security ApiKeyAuth @Router /containers/repo/status [get]

func (*BaseApi) CleanContainerLog ¶ added in v1.3.0

func (b *BaseApi) CleanContainerLog(c *gin.Context)

@Tags Container @Summary Clean container log @Description 清理容器日志 @Accept json @Param request body dto.OperationWithName true "request" @Success 200 @Security ApiKeyAuth @Router /containers/clean/log [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清理容器 [name] 日志","formatEN":"clean container [name] logs"}

func (*BaseApi) CleanLogs ¶

func (b *BaseApi) CleanLogs(c *gin.Context)

@Tags Logs @Summary Clean operation logs @Description 清空操作日志 @Accept json @Param request body dto.CleanLog true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /logs/clean [post] @x-panel-log {"bodyKeys":["logType"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清空 [logType] 日志信息","formatEN":"Clean the [logType] log information"}

func (*BaseApi) CleanMonitor ¶

func (b *BaseApi) CleanMonitor(c *gin.Context)

@Tags System Setting @Summary Clean monitor datas @Description 清空监控数据 @Success 200 @Security ApiKeyAuth @Router /settings/monitor/clean [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清空监控数据","formatEN":"clean monitor datas"}

func (*BaseApi) CleanRecord ¶ added in v1.1.0

func (b *BaseApi) CleanRecord(c *gin.Context)

@Tags Cronjob @Summary Clean job records @Description 清空计划任务记录 @Accept json @Param request body dto.CronjobClean true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/records/clean [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"cronjobs","output_column":"name","output_value":"name"}],"formatZH":"清空计划任务记录 [name]","formatEN":"clean cronjob [name] records"}

func (*BaseApi) ClearNginxProxyCache ¶ added in v1.9.3

func (b *BaseApi) ClearNginxProxyCache(c *gin.Context)

@Tags OpenResty @Summary Clear OpenResty proxy cache @Description 清理 OpenResty 代理缓存 @Success 200 @Security ApiKeyAuth @Router /openresty/clear [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清理 Openresty 代理缓存","formatEN":"Clear nginx proxy cache"}

func (*BaseApi) ClearRecycleBinFile ¶ added in v1.8.0

func (b *BaseApi) ClearRecycleBinFile(c *gin.Context)

@Tags File @Summary Clear RecycleBin files @Description 清空回收站文件 @Accept json @Success 200 @Security ApiKeyAuth @Router /files/recycle/clear [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清空回收站","formatEN":"清空回收站"}

func (*BaseApi) ComposeLogs ¶ added in v1.7.0

func (b *BaseApi) ComposeLogs(c *gin.Context)

@Tags Container Compose @Summary Container Compose logs @Description docker-compose 日志 @Param compose query string false "compose 文件地址" @Param since query string false "时间筛选" @Param follow query string false "是否追踪" @Param tail query string false "显示行号" @Security ApiKeyAuth @Router /containers/compose/search/log [get]

func (*BaseApi) ComposeUpdate ¶

func (b *BaseApi) ComposeUpdate(c *gin.Context)

@Tags Container Compose @Summary Update compose @Description 更新容器编排 @Accept json @Param request body dto.ComposeUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/compose/update [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 compose [name]","formatEN":"update compose information [name]"}

func (*BaseApi) CompressFile ¶

func (b *BaseApi) CompressFile(c *gin.Context)

@Tags File @Summary Compress file @Description 压缩文件 @Accept json @Param request body request.FileCompress true "request" @Success 200 @Security ApiKeyAuth @Router /files/compress [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"压缩文件 [name]","formatEN":"Compress file [name]"}

func (*BaseApi) ContainerCreate ¶

func (b *BaseApi) ContainerCreate(c *gin.Context)

@Tags Container @Summary Create container @Description 创建容器 @Accept json @Param request body dto.ContainerOperate true "request" @Success 200 @Security ApiKeyAuth @Router /containers [post] @x-panel-log {"bodyKeys":["name","image"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建容器 [name]image","formatEN":"create container [name]image"}

func (*BaseApi) ContainerInfo ¶ added in v1.4.0

func (b *BaseApi) ContainerInfo(c *gin.Context)

@Tags Container @Summary Load container info @Description 获取容器表单信息 @Accept json @Param request body dto.OperationWithName true "request" @Success 200 {object} dto.ContainerOperate @Security ApiKeyAuth @Router /containers/info [post]

func (*BaseApi) ContainerListStats ¶ added in v1.4.0

func (b *BaseApi) ContainerListStats(c *gin.Context)

@Summary Load container stats @Description 获取容器列表资源占用 @Success 200 {array} dto.ContainerListStats @Security ApiKeyAuth @Router /containers/list/stats [get]

func (*BaseApi) ContainerLogs ¶

func (b *BaseApi) ContainerLogs(c *gin.Context)

@Tags Container @Summary Container logs @Description 容器日志 @Param container query string false "容器名称" @Param since query string false "时间筛选" @Param follow query string false "是否追踪" @Param tail query string false "显示行号" @Security ApiKeyAuth @Router /containers/search/log [post]

func (*BaseApi) ContainerOperation ¶

func (b *BaseApi) ContainerOperation(c *gin.Context)

@Tags Container @Summary Operate Container @Description 容器操作 @Accept json @Param request body dto.ContainerOperation true "request" @Success 200 @Security ApiKeyAuth @Router /containers/operate [post] @x-panel-log {"bodyKeys":["names","operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"容器 [names] 执行 [operation]","formatEN":"container [operation] [names]"}

func (*BaseApi) ContainerPrune ¶ added in v1.3.0

func (b *BaseApi) ContainerPrune(c *gin.Context)

@Tags Container @Summary Clean container @Description 容器清理 @Accept json @Param request body dto.ContainerPrune true "request" @Success 200 {object} dto.ContainerPruneReport @Security ApiKeyAuth @Router /containers/prune [post] @x-panel-log {"bodyKeys":["pruneType"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清理容器 [pruneType]","formatEN":"clean container [pruneType]"}

func (*BaseApi) ContainerRename ¶ added in v1.8.0

func (b *BaseApi) ContainerRename(c *gin.Context)

@Tags Container @Summary Rename Container @Description 容器重命名 @Accept json @Param request body dto.ContainerRename true "request" @Success 200 @Security ApiKeyAuth @Router /containers/rename [post] @x-panel-log {"bodyKeys":["name","newName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"容器重命名 [name] => [newName]","formatEN":"rename container [name] => [newName]"}

func (*BaseApi) ContainerStats ¶

func (b *BaseApi) ContainerStats(c *gin.Context)

@Tags Container @Summary Container stats @Description 容器监控信息 @Param id path integer true "容器id" @Success 200 {object} dto.ContainerStats @Security ApiKeyAuth @Router /containers/stats/:id [get]

func (*BaseApi) ContainerUpdate ¶ added in v1.4.0

func (b *BaseApi) ContainerUpdate(c *gin.Context)

@Tags Container @Summary Update container @Description 更新容器 @Accept json @Param request body dto.ContainerOperate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/update [post] @x-panel-log {"bodyKeys":["name","image"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新容器 [name]image","formatEN":"update container [name]image"}

func (*BaseApi) ContainerUpgrade ¶ added in v1.4.0

func (b *BaseApi) ContainerUpgrade(c *gin.Context)

@Tags Container @Summary Upgrade container @Description 更新容器镜像 @Accept json @Param request body dto.ContainerUpgrade true "request" @Success 200 @Security ApiKeyAuth @Router /containers/upgrade [post] @x-panel-log {"bodyKeys":["name","image"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新容器镜像 [name]image","formatEN":"upgrade container image [name]image"}

func (*BaseApi) ContainerWsSsh ¶

func (b *BaseApi) ContainerWsSsh(c *gin.Context)

func (*BaseApi) CreateBackup ¶

func (b *BaseApi) CreateBackup(c *gin.Context)

@Tags Backup Account @Summary Create backup account @Description 创建备份账号 @Accept json @Param request body dto.BackupOperate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup [post] @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建备份账号 [type]","formatEN":"create backup account [type]"}

func (*BaseApi) CreateCommand ¶

func (b *BaseApi) CreateCommand(c *gin.Context)

@Tags Command @Summary Create command @Description 创建快速命令 @Accept json @Param request body dto.CommandOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/command [post] @x-panel-log {"bodyKeys":["name","command"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建快捷命令 [name][command]","formatEN":"create quick command [name][command]"}

func (*BaseApi) CreateCompose ¶

func (b *BaseApi) CreateCompose(c *gin.Context)

@Tags Container Compose @Summary Create compose @Description 创建容器编排 @Accept json @Param request body dto.ComposeCreate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/compose [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建 compose [name]","formatEN":"create compose [name]"}

func (*BaseApi) CreateComposeTemplate ¶

func (b *BaseApi) CreateComposeTemplate(c *gin.Context)

@Tags Container Compose-template @Summary Create compose template @Description 创建容器编排模版 @Accept json @Param request body dto.ComposeTemplateCreate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/template [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建 compose 模版 [name]","formatEN":"create compose template [name]"}

func (*BaseApi) CreateCronjob ¶

func (b *BaseApi) CreateCronjob(c *gin.Context)

@Tags Cronjob @Summary Create cronjob @Description 创建计划任务 @Accept json @Param request body dto.CronjobCreate true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs [post] @x-panel-log {"bodyKeys":["type","name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建计划任务 [type][name]","formatEN":"create cronjob [type][name]"}

func (*BaseApi) CreateDatabase ¶ added in v1.6.0

func (b *BaseApi) CreateDatabase(c *gin.Context)

@Tags Database @Summary Create database @Description 创建远程数据库 @Accept json @Param request body dto.DatabaseCreate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/db [post] @x-panel-log {"bodyKeys":["name", "type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建远程数据库 [name][type]","formatEN":"create database [name][type]"}

func (*BaseApi) CreateFavorite ¶ added in v1.8.0

func (b *BaseApi) CreateFavorite(c *gin.Context)

@Tags File @Summary Create favorite @Description 创建收藏 @Accept json @Param request body request.FavoriteCreate true "request" @Success 200 @Security ApiKeyAuth @Router /files/favorite [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"收藏文件/文件夹 path","formatEN":"收藏文件/文件夹 path"}

func (*BaseApi) CreateFile ¶

func (b *BaseApi) CreateFile(c *gin.Context)

@Tags File @Summary Create file @Description 创建文件/文件夹 @Accept json @Param request body request.FileCreate true "request" @Success 200 @Security ApiKeyAuth @Router /files [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建文件/文件夹 path","formatEN":"Create dir or file path"}

func (*BaseApi) CreateGroup ¶

func (b *BaseApi) CreateGroup(c *gin.Context)

@Tags System Group @Summary Create group @Description 创建系统组 @Accept json @Param request body dto.GroupCreate true "request" @Success 200 @Security ApiKeyAuth @Router /groups [post] @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建组 [name][type]","formatEN":"create group [name][type]"}

func (*BaseApi) CreateHost ¶

func (b *BaseApi) CreateHost(c *gin.Context)

@Tags Host @Summary Create host @Description 创建主机 @Accept json @Param request body dto.HostOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts [post] @x-panel-log {"bodyKeys":["name","addr"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建主机 [name][addr]","formatEN":"create host [name][addr]"}

func (*BaseApi) CreateMysql ¶

func (b *BaseApi) CreateMysql(c *gin.Context)

@Tags Database Mysql @Summary Create mysql database @Description 创建 mysql 数据库 @Accept json @Param request body dto.MysqlDBCreate true "request" @Success 200 @Security ApiKeyAuth @Router /databases [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建 mysql 数据库 [name]","formatEN":"create mysql database [name]"}

func (*BaseApi) CreateNetwork ¶

func (b *BaseApi) CreateNetwork(c *gin.Context)

@Tags Container Network @Summary Create network @Description 创建容器网络 @Accept json @Param request body dto.NetworkCreate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/network [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建容器网络 name","formatEN":"create container network [name]"}

func (*BaseApi) CreatePHPExtensions ¶ added in v1.9.3

func (b *BaseApi) CreatePHPExtensions(c *gin.Context)

@Tags PHP Extensions @Summary Create Extensions @Description Create Extensions @Accept json @Param request body request.PHPExtensionsCreate true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/php/extensions [post]

func (*BaseApi) CreatePostgresql ¶ added in v1.9.3

func (b *BaseApi) CreatePostgresql(c *gin.Context)

@Tags Database Postgresql @Summary Create postgresql database @Description 创建 postgresql 数据库 @Accept json @Param request body dto.PostgresqlDBCreate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建 postgresql 数据库 [name]","formatEN":"create postgresql database [name]"}

func (*BaseApi) CreateRepo ¶

func (b *BaseApi) CreateRepo(c *gin.Context)

@Tags Container Image-repo @Summary Create image repo @Description 创建镜像仓库 @Accept json @Param request body dto.ImageRepoDelete true "request" @Produce json @Success 200 @Security ApiKeyAuth @Router /containers/repo [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建镜像仓库 [name]","formatEN":"create image repo [name]"}

func (*BaseApi) CreateRuntime ¶ added in v1.1.0

func (b *BaseApi) CreateRuntime(c *gin.Context)

@Tags Runtime @Summary Create runtime @Description 创建运行环境 @Accept json @Param request body request.RuntimeCreate true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建运行环境 [name]","formatEN":"Create runtime [name]"}

func (*BaseApi) CreateSnapshot ¶

func (b *BaseApi) CreateSnapshot(c *gin.Context)

@Tags System Setting @Summary Create system snapshot @Description 创建系统快照 @Accept json @Param request body dto.SnapshotCreate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot [post] @x-panel-log {"bodyKeys":["from", "description"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建系统快照 [description] 到 [from]","formatEN":"Create system backup [description] to [from]"}

func (*BaseApi) CreateVolume ¶

func (b *BaseApi) CreateVolume(c *gin.Context)

@Tags Container Volume @Summary Create volume @Description 创建容器存储卷 @Accept json @Param request body dto.VolumeCreate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/volume [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建容器存储卷 [name]","formatEN":"create container volume [name]"}

func (*BaseApi) CreateWebDomain ¶

func (b *BaseApi) CreateWebDomain(c *gin.Context)

@Tags Website Domain @Summary Create website domain @Description 创建网站域名 @Accept json @Param request body request.WebsiteDomainCreate true "request" @Success 200 {object} model.WebsiteDomain @Security ApiKeyAuth @Router /websites/domains [post] @x-panel-log {"bodyKeys":["domain"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建域名 [domain]","formatEN":"Create domain [domain]"}

func (*BaseApi) CreateWebsite ¶

func (b *BaseApi) CreateWebsite(c *gin.Context)

@Tags Website @Summary Create website @Description 创建网站 @Accept json @Param request body request.WebsiteCreate true "request" @Success 200 @Security ApiKeyAuth @Router /websites [post] @x-panel-log {"bodyKeys":["primaryDomain"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建网站 [primaryDomain]","formatEN":"Create website [primaryDomain]"}

func (*BaseApi) CreateWebsiteAcmeAccount ¶

func (b *BaseApi) CreateWebsiteAcmeAccount(c *gin.Context)

@Tags Website Acme @Summary Create website acme account @Description 创建网站 acme @Accept json @Param request body request.WebsiteAcmeAccountCreate true "request" @Success 200 {object} response.WebsiteAcmeAccountDTO @Security ApiKeyAuth @Router /websites/acme [post] @x-panel-log {"bodyKeys":["email"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建网站 acme [email]","formatEN":"Create website acme [email]"}

func (*BaseApi) CreateWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) CreateWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Create website ca @Description 创建网站 ca @Accept json @Param request body request.WebsiteCACreate true "request" @Success 200 {object} request.WebsiteCACreate @Security ApiKeyAuth @Router /websites/ca [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建网站 ca [name]","formatEN":"Create website ca [name]"}

func (*BaseApi) CreateWebsiteCheck ¶

func (b *BaseApi) CreateWebsiteCheck(c *gin.Context)

@Tags Website @Summary Check before create website @Description 网站创建前检查 @Accept json @Param request body request.WebsiteInstallCheckReq true "request" @Success 200 {array} response.WebsitePreInstallCheck @Security ApiKeyAuth @Router /websites/check [post]

func (*BaseApi) CreateWebsiteDnsAccount ¶

func (b *BaseApi) CreateWebsiteDnsAccount(c *gin.Context)

@Tags Website DNS @Summary Create website dns account @Description 创建网站 dns @Accept json @Param request body request.WebsiteDnsAccountCreate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dns [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建网站 dns [name]","formatEN":"Create website dns [name]"}

func (*BaseApi) CreateWebsiteSSL ¶

func (b *BaseApi) CreateWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Create website ssl @Description 创建网站 ssl @Accept json @Param request body request.WebsiteSSLCreate true "request" @Success 200 {object} request.WebsiteSSLCreate @Security ApiKeyAuth @Router /websites/ssl [post] @x-panel-log {"bodyKeys":["primaryDomain"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建网站 ssl [primaryDomain]","formatEN":"Create website ssl [primaryDomain]"}

func (*BaseApi) DeCompressFile ¶

func (b *BaseApi) DeCompressFile(c *gin.Context)

@Tags File @Summary Decompress file @Description 解压文件 @Accept json @Param request body request.FileDeCompress true "request" @Success 200 @Security ApiKeyAuth @Router /files/decompress [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"解压 path","formatEN":"Decompress file path"}

func (*BaseApi) DeleteBackup ¶

func (b *BaseApi) DeleteBackup(c *gin.Context)

@Tags Backup Account @Summary Delete backup account @Description 删除备份账号 @Accept json @Param request body dto.BatchDeleteReq true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":true,"db":"backup_accounts","output_column":"type","output_value":"types"}],"formatZH":"删除备份账号 [types]","formatEN":"delete backup account [types]"}

func (*BaseApi) DeleteBackupRecord ¶

func (b *BaseApi) DeleteBackupRecord(c *gin.Context)

@Tags Backup Account @Summary Delete backup record @Description 删除备份记录 @Accept json @Param request body dto.BatchDeleteReq true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/record/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"backup_records","output_column":"file_name","output_value":"files"}],"formatZH":"删除备份记录 files","formatEN":"delete backup records files"}

func (*BaseApi) DeleteCheck ¶

func (b *BaseApi) DeleteCheck(c *gin.Context)

@Tags App @Summary Check before delete @Description 删除前检查 @Accept json @Param appInstallId path integer true "App install id" @Success 200 {array} dto.AppResource @Security ApiKeyAuth @Router /apps/installed/delete/check/:appInstallId [get]

func (*BaseApi) DeleteCheckDatabase ¶ added in v1.7.0

func (b *BaseApi) DeleteCheckDatabase(c *gin.Context)

@Tags Database @Summary Check before delete remote database @Description Mysql 远程数据库删除前检查 @Accept json @Param request body dto.OperateByID true "request" @Success 200 {array} string @Security ApiKeyAuth @Router /db/remote/del/check [post]

func (*BaseApi) DeleteCheckMysql ¶

func (b *BaseApi) DeleteCheckMysql(c *gin.Context)

@Tags Database Mysql @Summary Check before delete mysql database @Description Mysql 数据库删除前检查 @Accept json @Param request body dto.MysqlDBDeleteCheck true "request" @Success 200 {array} string @Security ApiKeyAuth @Router /databases/del/check [post]

func (*BaseApi) DeleteCheckPostgresql ¶ added in v1.9.3

func (b *BaseApi) DeleteCheckPostgresql(c *gin.Context)

@Tags Database Postgresql @Summary Check before delete postgresql database @Description Postgresql 数据库删除前检查 @Accept json @Param request body dto.PostgresqlDBDeleteCheck true "request" @Success 200 {array} string @Security ApiKeyAuth @Router /databases/pg/del/check [post]

func (*BaseApi) DeleteCommand ¶

func (b *BaseApi) DeleteCommand(c *gin.Context)

@Tags Command @Summary Delete command @Description 删除快速命令 @Accept json @Param request body dto.BatchDeleteReq true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/command/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"commands","output_column":"name","output_value":"names"}],"formatZH":"删除快捷命令 [names]","formatEN":"delete quick command [names]"}

func (*BaseApi) DeleteComposeTemplate ¶

func (b *BaseApi) DeleteComposeTemplate(c *gin.Context)

@Tags Container Compose-template @Summary Delete compose template @Description 删除容器编排模版 @Accept json @Param request body dto.BatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /containers/template/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"compose_templates","output_column":"name","output_value":"names"}],"formatZH":"删除 compose 模版 [names]","formatEN":"delete compose template [names]"}

func (*BaseApi) DeleteCronjob ¶

func (b *BaseApi) DeleteCronjob(c *gin.Context)

@Tags Cronjob @Summary Delete cronjob @Description 删除计划任务 @Accept json @Param request body dto.CronjobBatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"cronjobs","output_column":"name","output_value":"names"}],"formatZH":"删除计划任务 [names]","formatEN":"delete cronjob [names]"}

func (*BaseApi) DeleteDatabase ¶ added in v1.6.0

func (b *BaseApi) DeleteDatabase(c *gin.Context)

@Tags Database @Summary Delete database @Description 删除远程数据库 @Accept json @Param request body dto.DatabaseDelete true "request" @Success 200 @Security ApiKeyAuth @Router /databases/db/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"databases","output_column":"name","output_value":"names"}],"formatZH":"删除远程数据库 [names]","formatEN":"delete database [names]"}

func (*BaseApi) DeleteFavorite ¶ added in v1.8.0

func (b *BaseApi) DeleteFavorite(c *gin.Context)

@Tags File @Summary Delete favorite @Description 删除收藏 @Accept json @Param request body request.FavoriteDelete true "request" @Success 200 @Security ApiKeyAuth @Router /files/favorite/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"favorites","output_column":"path","output_value":"path"}],"formatZH":"删除收藏 path","formatEN":"delete avorite path"}

func (*BaseApi) DeleteFile ¶

func (b *BaseApi) DeleteFile(c *gin.Context)

@Tags File @Summary Delete file @Description 删除文件/文件夹 @Accept json @Param request body request.FileDelete true "request" @Success 200 @Security ApiKeyAuth @Router /files/del [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"删除文件/文件夹 path","formatEN":"Delete dir or file path"}

func (*BaseApi) DeleteGroup ¶

func (b *BaseApi) DeleteGroup(c *gin.Context)

@Tags System Group @Summary Delete group @Description 删除系统组 @Accept json @Param request body dto.OperateByID true "request" @Success 200 @Security ApiKeyAuth @Router /groups/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"name","output_value":"name"},{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"type","output_value":"type"}],"formatZH":"删除组 [type][name]","formatEN":"delete group [type][name]"}

func (*BaseApi) DeleteHost ¶

func (b *BaseApi) DeleteHost(c *gin.Context)

@Tags Host @Summary Delete host @Description 删除主机 @Accept json @Param request body dto.BatchDeleteReq true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"hosts","output_column":"addr","output_value":"addrs"}],"formatZH":"删除主机 [addrs]","formatEN":"delete host [addrs]"}

func (*BaseApi) DeleteMysql ¶

func (b *BaseApi) DeleteMysql(c *gin.Context)

@Tags Database Mysql @Summary Delete mysql database @Description 删除 mysql 数据库 @Accept json @Param request body dto.MysqlDBDelete true "request" @Success 200 @Security ApiKeyAuth @Router /databases/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_mysqls","output_column":"name","output_value":"name"}],"formatZH":"删除 mysql 数据库 [name]","formatEN":"delete mysql database [name]"}

func (*BaseApi) DeleteNetwork ¶

func (b *BaseApi) DeleteNetwork(c *gin.Context)

@Tags Container Network @Summary Delete network @Description 删除容器网络 @Accept json @Param request body dto.BatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /containers/network/del [post] @x-panel-log {"bodyKeys":["names"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"删除容器网络 [names]","formatEN":"delete container network [names]"}

func (*BaseApi) DeletePHPExtensions ¶ added in v1.9.3

func (b *BaseApi) DeletePHPExtensions(c *gin.Context)

@Tags PHP Extensions @Summary Delete Extensions @Description Delete Extensions @Accept json @Param request body request.PHPExtensionsDelete true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/php/extensions/del [post]

func (*BaseApi) DeletePostgresql ¶ added in v1.9.3

func (b *BaseApi) DeletePostgresql(c *gin.Context)

@Tags Database Postgresql @Summary Delete postgresql database @Description 删除 postgresql 数据库 @Accept json @Param request body dto.PostgresqlDBDelete true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_postgresqls","output_column":"name","output_value":"name"}],"formatZH":"删除 postgresql 数据库 [name]","formatEN":"delete postgresql database [name]"}

func (*BaseApi) DeleteRepo ¶

func (b *BaseApi) DeleteRepo(c *gin.Context)

@Tags Container Image-repo @Summary Delete image repo @Description 删除镜像仓库 @Accept json @Param request body dto.ImageRepoDelete true "request" @Produce json @Success 200 @Security ApiKeyAuth @Router /containers/repo/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"image_repos","output_column":"name","output_value":"names"}],"formatZH":"删除镜像仓库 [names]","formatEN":"delete image repo [names]"}

func (*BaseApi) DeleteRuntime ¶ added in v1.1.0

func (b *BaseApi) DeleteRuntime(c *gin.Context)

@Tags Website @Summary Delete runtime @Description 删除运行环境 @Accept json @Param request body request.RuntimeDelete true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"删除网站 [name]","formatEN":"Delete website [name]"}

func (*BaseApi) DeleteSnapshot ¶

func (b *BaseApi) DeleteSnapshot(c *gin.Context)

@Tags System Setting @Summary Delete system backup @Description 删除系统快照 @Accept json @Param request body dto.BatchDeleteReq true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"snapshots","output_column":"name","output_value":"name"}],"formatZH":"删除系统快照 [name]","formatEN":"Delete system backup [name]"}

func (*BaseApi) DeleteVolume ¶

func (b *BaseApi) DeleteVolume(c *gin.Context)

@Tags Container Volume @Summary Delete volume @Description 删除容器存储卷 @Accept json @Param request body dto.BatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /containers/volume/del [post] @x-panel-log {"bodyKeys":["names"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"删除容器存储卷 [names]","formatEN":"delete container volume [names]"}

func (*BaseApi) DeleteWebDomain ¶

func (b *BaseApi) DeleteWebDomain(c *gin.Context)

@Tags Website Domain @Summary Delete website domain @Description 删除网站域名 @Accept json @Param request body request.WebsiteDomainDelete true "request" @Success 200 @Security ApiKeyAuth @Router /websites/domains/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_domains","output_column":"domain","output_value":"domain"}],"formatZH":"删除域名 [domain]","formatEN":"Delete domain [domain]"}

func (*BaseApi) DeleteWebsite ¶

func (b *BaseApi) DeleteWebsite(c *gin.Context)

@Tags Website @Summary Delete website @Description 删除网站 @Accept json @Param request body request.WebsiteDelete true "request" @Success 200 @Security ApiKeyAuth @Router /websites/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"删除网站 [domain]","formatEN":"Delete website [domain]"}

func (*BaseApi) DeleteWebsiteAcmeAccount ¶

func (b *BaseApi) DeleteWebsiteAcmeAccount(c *gin.Context)

@Tags Website Acme @Summary Delete website acme account @Description 删除网站 acme @Accept json @Param request body request.WebsiteResourceReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/acme/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_acme_accounts","output_column":"email","output_value":"email"}],"formatZH":"删除网站 acme [email]","formatEN":"Delete website acme [email]"}

func (*BaseApi) DeleteWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) DeleteWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Delete website ca @Description 删除网站 ca @Accept json @Param request body request.WebsiteCommonReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ca/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_cas","output_column":"name","output_value":"name"}],"formatZH":"删除网站 ca [name]","formatEN":"Delete website ca [name]"}

func (*BaseApi) DeleteWebsiteDnsAccount ¶

func (b *BaseApi) DeleteWebsiteDnsAccount(c *gin.Context)

@Tags Website DNS @Summary Delete website dns account @Description 删除网站 dns @Accept json @Param request body request.WebsiteResourceReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dns/del [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_dns_accounts","output_column":"name","output_value":"name"}],"formatZH":"删除网站 dns [name]","formatEN":"Delete website dns [name]"}

func (*BaseApi) DeleteWebsiteSSL ¶

func (b *BaseApi) DeleteWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Delete website ssl @Description 删除网站 ssl @Accept json @Param request body request.WebsiteBatchDelReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/del [post] @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"website_ssls","output_column":"primary_domain","output_value":"domain"}],"formatZH":"删除 ssl [domain]","formatEN":"Delete ssl [domain]"}

func (*BaseApi) Download ¶

func (b *BaseApi) Download(c *gin.Context)

@Tags File @Summary Download file @Description 下载文件 @Accept json @Success 200 @Security ApiKeyAuth @Router /files/download [get]

func (*BaseApi) DownloadChunkFiles ¶ added in v1.3.0

func (b *BaseApi) DownloadChunkFiles(c *gin.Context)

@Tags File @Summary Chunk Download file @Description 分片下载下载文件 @Accept json @Param request body request.FileDownload true "request" @Success 200 @Security ApiKeyAuth @Router /files/chunkdownload [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"下载文件 [name]","formatEN":"Download file [name]"}

func (*BaseApi) DownloadRecord ¶

func (b *BaseApi) DownloadRecord(c *gin.Context)

@Tags Backup Account @Summary Download backup record @Description 下载备份记录 @Accept json @Param request body dto.DownloadRecord true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/record/download [post] @x-panel-log {"bodyKeys":["source","fileName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"下载备份记录 [source][fileName]","formatEN":"download backup records [source][fileName]"}

func (*BaseApi) DownloadSSL ¶ added in v1.5.0

func (b *BaseApi) DownloadSSL(c *gin.Context)

@Tags System Setting @Summary Download system cert @Description 下载证书 @Success 200 @Security ApiKeyAuth @Router /settings/ssl/download [post]

func (*BaseApi) DownloadWebsiteSSL ¶ added in v1.9.0

func (b *BaseApi) DownloadWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Download SSL file @Description 下载证书文件 @Accept json @Param request body request.WebsiteResourceReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/download [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_ssls","output_column":"primary_domain","output_value":"domain"}],"formatZH":"下载证书文件 [domain]","formatEN":"download ssl file [domain]"}

func (*BaseApi) GenerateSSH ¶ added in v1.3.0

func (b *BaseApi) GenerateSSH(c *gin.Context)

@Tags SSH @Summary Generate host SSH secret @Description 生成 SSH 密钥 @Accept json @Param request body dto.GenerateSSH true "request" @Success 200 @Security ApiKeyAuth @Router /host/ssh/generate [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"生成 SSH 密钥 ","formatEN":"generate SSH secret"}

func (*BaseApi) GetAntiLeech ¶ added in v1.3.0

func (b *BaseApi) GetAntiLeech(c *gin.Context)

@Tags Website @Summary Get AntiLeech conf @Description 获取防盗链配置 @Accept json @Param request body request.NginxCommonReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/leech [post]

func (*BaseApi) GetApp ¶

func (b *BaseApi) GetApp(c *gin.Context)

@Tags App @Summary Search app by key @Description 通过 key 获取应用信息 @Accept json @Param key path string true "app key" @Success 200 {object} response.AppDTO @Security ApiKeyAuth @Router /apps/:key [get]

func (*BaseApi) GetAppDetail ¶

func (b *BaseApi) GetAppDetail(c *gin.Context)

@Tags App @Summary Search app detail by appid @Description 通过 appid 获取应用详情 @Accept json @Param appId path integer true "app id" @Param version path string true "app 版本" @Param version path string true "app 类型" @Success 200 {object} response.AppDetailDTO @Security ApiKeyAuth @Router /apps/detail/:appId/:version/:type [get]

func (*BaseApi) GetAppDetailByID ¶ added in v1.1.0

func (b *BaseApi) GetAppDetailByID(c *gin.Context)

@Tags App @Summary Get app detail by id @Description 通过 id 获取应用详情 @Accept json @Param appId path integer true "id" @Success 200 {object} response.AppDetailDTO @Security ApiKeyAuth @Router /apps/details/:id [get]

func (*BaseApi) GetAppListUpdate ¶ added in v1.0.1

func (b *BaseApi) GetAppListUpdate(c *gin.Context)

@Tags App @Summary Get app list update @Description 获取应用更新版本 @Success 200 @Security ApiKeyAuth @Router /apps/checkupdate [get]

func (*BaseApi) GetAppTags ¶

func (b *BaseApi) GetAppTags(c *gin.Context)

func (*BaseApi) GetAuthConfig ¶ added in v1.2.0

func (b *BaseApi) GetAuthConfig(c *gin.Context)

@Tags Website @Summary Get AuthBasic conf @Description 获取密码访问配置 @Accept json @Param request body request.NginxAuthReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/auths [post]

func (*BaseApi) GetContent ¶

func (b *BaseApi) GetContent(c *gin.Context)

@Tags File @Summary Load file content @Description 获取文件内容 @Accept json @Param request body request.FileContentReq true "request" @Success 200 {object} response.FileInfo @Security ApiKeyAuth @Router /files/content [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"获取文件内容 path","formatEN":"Load file content path"}

func (*BaseApi) GetDNSResolve ¶

func (b *BaseApi) GetDNSResolve(c *gin.Context)

@Tags Website SSL @Summary Resolve website ssl @Description 解析网站 ssl @Accept json @Param request body request.WebsiteDNSReq true "request" @Success 200 {array} response.WebsiteDNSRes @Security ApiKeyAuth @Router /websites/ssl/resolve [post]

func (*BaseApi) GetDatabase ¶ added in v1.6.0

func (b *BaseApi) GetDatabase(c *gin.Context)

@Tags Database @Summary Get databases @Description 获取远程数据库 @Success 200 {object} dto.DatabaseInfo @Security ApiKeyAuth @Router /databases/db/:name [get]

func (*BaseApi) GetDefaultConfig ¶

func (b *BaseApi) GetDefaultConfig(c *gin.Context)

@Tags App @Summary Search default config by key @Description 通过 key 获取应用默认配置 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {string} content @Security ApiKeyAuth @Router /apps/installed/conf [post]

func (*BaseApi) GetDirConfig ¶ added in v1.6.0

func (b *BaseApi) GetDirConfig(c *gin.Context)

@Tags Website @Summary Get website dir @Description 获取网站目录配置 @Accept json @Param request body request.WebsiteCommonReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dir [post]

func (*BaseApi) GetFileTree ¶

func (b *BaseApi) GetFileTree(c *gin.Context)

@Tags File @Summary Load files tree @Description 加载文件树 @Accept json @Param request body request.FileOption true "request" @Success 200 {array} response.FileTree @Security ApiKeyAuth @Router /files/tree [post]

func (*BaseApi) GetHTTPSConfig ¶

func (b *BaseApi) GetHTTPSConfig(c *gin.Context)

@Tags Website HTTPS @Summary Load https conf @Description 获取 https 配置 @Accept json @Param id path integer true "request" @Success 200 {object} response.WebsiteHTTPS @Security ApiKeyAuth @Router /websites/:id/https [get]

func (*BaseApi) GetIOOptions ¶

func (b *BaseApi) GetIOOptions(c *gin.Context)

func (*BaseApi) GetIgnoredApp ¶ added in v1.4.0

func (b *BaseApi) GetIgnoredApp(c *gin.Context)

@Tags App @Summary Get Ignore App @Description 获取忽略的应用版本 @Accept json @Success 200 {object} response.IgnoredApp @Security ApiKeyAuth @Router /apps/ingored [get]

func (*BaseApi) GetLanguage ¶ added in v1.5.0

func (b *BaseApi) GetLanguage(c *gin.Context)

@Tags Auth @Summary Load System Language @Description 获取系统语言设置 @Success 200 @Router /auth/language [get]

func (*BaseApi) GetLoginLogs ¶

func (b *BaseApi) GetLoginLogs(c *gin.Context)

@Tags Logs @Summary Page login logs @Description 获取系统登录日志列表分页 @Accept json @Param request body dto.SearchLgLogWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /logs/login [post]

func (*BaseApi) GetNetworkOptions ¶

func (b *BaseApi) GetNetworkOptions(c *gin.Context)

func (*BaseApi) GetNginx ¶

func (b *BaseApi) GetNginx(c *gin.Context)

@Tags OpenResty @Summary Load OpenResty conf @Description 获取 OpenResty 配置信息 @Success 200 {object} response.FileInfo @Security ApiKeyAuth @Router /openresty [get]

func (*BaseApi) GetNginxConfig ¶

func (b *BaseApi) GetNginxConfig(c *gin.Context)

@Tags Website Nginx @Summary Load nginx conf @Description 获取 nginx 配置 @Accept json @Param request body request.NginxScopeReq true "request" @Success 200 {object} response.WebsiteNginxConfig @Security ApiKeyAuth @Router /websites/config [post]

func (*BaseApi) GetNginxConfigByScope ¶

func (b *BaseApi) GetNginxConfigByScope(c *gin.Context)

@Tags OpenResty @Summary Load partial OpenResty conf @Description 获取部分 OpenResty 配置信息 @Accept json @Param request body request.NginxScopeReq true "request" @Success 200 {array} response.NginxParam @Security ApiKeyAuth @Router /openresty/scope [post]

func (*BaseApi) GetNginxStatus ¶

func (b *BaseApi) GetNginxStatus(c *gin.Context)

@Tags OpenResty @Summary Load OpenResty status info @Description 获取 OpenResty 状态信息 @Success 200 {object} response.NginxStatus @Security ApiKeyAuth @Router /openresty/status [get]

func (*BaseApi) GetNodeModules ¶ added in v1.7.0

func (b *BaseApi) GetNodeModules(c *gin.Context)

@Tags Runtime @Summary Get Node modules @Description 获取 Node 项目的 modules @Accept json @Param request body request.NodeModuleReq true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/node/modules [post]

func (*BaseApi) GetNodePackageRunScript ¶ added in v1.7.0

func (b *BaseApi) GetNodePackageRunScript(c *gin.Context)

@Tags Runtime @Summary Get Node package scripts @Description 获取 Node 项目的 scripts @Accept json @Param request body request.NodePackageReq true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/node/package [post]

func (*BaseApi) GetNotesByVersion ¶ added in v1.0.3

func (b *BaseApi) GetNotesByVersion(c *gin.Context)

@Tags System Setting @Summary Load release notes by version @Description 获取版本 release notes @Accept json @Param request body dto.Upgrade true "request" @Success 200 @Security ApiKeyAuth @Router /settings/upgrade [get]

func (*BaseApi) GetOperationLogs ¶

func (b *BaseApi) GetOperationLogs(c *gin.Context)

@Tags Logs @Summary Page operation logs @Description 获取系统操作日志列表分页 @Accept json @Param request body dto.SearchOpLogWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /logs/operation [post]

func (*BaseApi) GetParams ¶

func (b *BaseApi) GetParams(c *gin.Context)

@Tags App @Summary Search params by appInstallId @Description 通过 install id 获取应用参数 @Accept json @Param appInstallId path string true "request" @Success 200 {object} response.AppParam @Security ApiKeyAuth @Router /apps/installed/params/:appInstallId [get]

func (*BaseApi) GetProcess ¶ added in v1.5.0

func (b *BaseApi) GetProcess(c *gin.Context)

@Tags Host tool @Summary Get Supervisor process config @Description 获取 Supervisor 进程配置 @Accept json @Success 200 @Security ApiKeyAuth @Router /host/tool/supervisor/process [get]

func (*BaseApi) GetProcessFile ¶ added in v1.5.0

func (b *BaseApi) GetProcessFile(c *gin.Context)

@Tags Host tool @Summary Get Supervisor process config @Description 操作 Supervisor 进程文件 @Accept json @Param request body request.SupervisorProcessFileReq true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/supervisor/process/file [post] @x-panel-log {"bodyKeys":["operate"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operate] Supervisor 进程文件 ","formatEN":"[operate] Supervisor Process Config file"}

func (*BaseApi) GetProxyConfig ¶ added in v1.2.0

func (b *BaseApi) GetProxyConfig(c *gin.Context)

@Tags Website @Summary Get proxy conf @Description 获取反向代理配置 @Accept json @Param request body request.WebsiteProxyReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/proxies [post]

func (*BaseApi) GetRecycleStatus ¶ added in v1.9.0

func (b *BaseApi) GetRecycleStatus(c *gin.Context)

@Tags File @Summary Get RecycleBin status @Description 获取回收站状态 @Accept json @Success 200 @Security ApiKeyAuth @Router /files/recycle/status [get]

func (*BaseApi) GetRedirectConfig ¶ added in v1.5.0

func (b *BaseApi) GetRedirectConfig(c *gin.Context)

@Tags Website @Summary Get redirect conf @Description 获取重定向配置 @Accept json @Param request body request.WebsiteProxyReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/redirect [post]

func (*BaseApi) GetRewriteConfig ¶ added in v1.1.1

func (b *BaseApi) GetRewriteConfig(c *gin.Context)

@Tags Website @Summary Get rewrite conf @Description 获取伪静态配置 @Accept json @Param request body request.NginxRewriteReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/rewrite [post]

func (*BaseApi) GetRuntime ¶ added in v1.1.0

func (b *BaseApi) GetRuntime(c *gin.Context)

@Tags Runtime @Summary Get runtime @Description 获取运行环境 @Accept json @Param id path string true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/:id [get]

func (*BaseApi) GetSSHInfo ¶ added in v1.3.0

func (b *BaseApi) GetSSHInfo(c *gin.Context)

@Tags SSH @Summary Load host SSH setting info @Description 加载 SSH 配置信息 @Success 200 {object} dto.SSHInfo @Security ApiKeyAuth @Router /host/ssh/search [post]

func (*BaseApi) GetServices ¶

func (b *BaseApi) GetServices(c *gin.Context)

@Tags App @Summary Search app service by key @Description 通过 key 获取应用 service @Accept json @Param key path string true "request" @Success 200 {array} response.AppService @Security ApiKeyAuth @Router /apps/services/:key [get]

func (*BaseApi) GetSettingInfo ¶

func (b *BaseApi) GetSettingInfo(c *gin.Context)

@Tags System Setting @Summary Load system setting info @Description 加载系统配置信息 @Success 200 {object} dto.SettingInfo @Security ApiKeyAuth @Router /settings/search [post]

func (*BaseApi) GetSystemAvailable ¶

func (b *BaseApi) GetSystemAvailable(c *gin.Context)

@Tags System Setting @Summary Load system available status @Description 获取系统可用状态 @Success 200 @Security ApiKeyAuth @Router /settings/search/available [get]

func (*BaseApi) GetSystemFiles ¶ added in v1.7.0

func (b *BaseApi) GetSystemFiles(c *gin.Context)

@Tags Logs @Summary Load system log files @Description 获取系统日志文件列表 @Success 200 @Security ApiKeyAuth @Router /logs/system/files [get]

func (*BaseApi) GetSystemLogs ¶ added in v1.5.0

func (b *BaseApi) GetSystemLogs(c *gin.Context)

@Tags Logs @Summary Load system logs @Description 获取系统日志 @Success 200 @Security ApiKeyAuth @Router /logs/system [post]

func (*BaseApi) GetToolLog ¶ added in v1.5.0

func (b *BaseApi) GetToolLog(c *gin.Context)

@Tags Host tool @Summary Get tool @Description 获取主机工具日志 @Accept json @Param request body request.HostToolLogReq true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/log [post]

func (*BaseApi) GetToolStatus ¶ added in v1.5.0

func (b *BaseApi) GetToolStatus(c *gin.Context)

@Tags Host tool @Summary Get tool @Description 获取主机工具状态 @Accept json @Param request body request.HostToolReq true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool [post]

func (*BaseApi) GetUpdateVersions ¶

func (b *BaseApi) GetUpdateVersions(c *gin.Context)

@Tags App @Summary Search app update version by install id @Description 通过 install id 获取应用更新版本 @Accept json @Param appInstallId path integer true "request" @Success 200 {array} dto.AppVersion @Security ApiKeyAuth @Router /apps/installed/:appInstallId/versions [get]

func (*BaseApi) GetUpgradeInfo ¶

func (b *BaseApi) GetUpgradeInfo(c *gin.Context)

@Tags System Setting @Summary Load upgrade info @Description 系统更新信息 @Success 200 {object} dto.UpgradeInfo @Security ApiKeyAuth @Router /settings/upgrade [get]

func (*BaseApi) GetWebDomains ¶

func (b *BaseApi) GetWebDomains(c *gin.Context)

@Tags Website Domain @Summary Search website domains by websiteId @Description 通过网站 id 查询域名 @Accept json @Param websiteId path integer true "request" @Success 200 {array} model.WebsiteDomain @Security ApiKeyAuth @Router /websites/domains/:websiteId [get]

func (*BaseApi) GetWebsite ¶

func (b *BaseApi) GetWebsite(c *gin.Context)

@Tags Website @Summary Search website by id @Description 通过 id 查询网站 @Accept json @Param id path integer true "request" @Success 200 {object} response.WebsiteDTO @Security ApiKeyAuth @Router /websites/:id [get]

func (*BaseApi) GetWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) GetWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Get website ca @Description 获取网站 ca @Accept json @Param id path int true "id" @Success 200 {object} response.WebsiteCADTO @Security ApiKeyAuth @Router /websites/ca/{id} [get]

func (*BaseApi) GetWebsiteNginx ¶

func (b *BaseApi) GetWebsiteNginx(c *gin.Context)

@Tags Website Nginx @Summary Search website nginx by id @Description 通过 id 查询网站 nginx @Accept json @Param id path integer true "request" @Success 200 {object} response.FileInfo @Security ApiKeyAuth @Router /websites/:id/config/:type [get]

func (*BaseApi) GetWebsiteOptions ¶

func (b *BaseApi) GetWebsiteOptions(c *gin.Context)

@Tags Website @Summary List website names @Description 获取网站列表 @Success 200 {array} string @Security ApiKeyAuth @Router /websites/options [get]

func (*BaseApi) GetWebsitePHPConfig ¶ added in v1.1.0

func (b *BaseApi) GetWebsitePHPConfig(c *gin.Context)

@Tags Website @Summary Load websit php conf @Description 获取网站 php 配置 @Accept json @Param id path integer true "request" @Success 200 {object} response.PHPConfig @Security ApiKeyAuth @Router /websites/php/config/:id [get]

func (*BaseApi) GetWebsiteSSLById ¶

func (b *BaseApi) GetWebsiteSSLById(c *gin.Context)

@Tags Website SSL @Summary Search website ssl by id @Description 通过 id 查询 ssl @Accept json @Param id path integer true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/:id [get]

func (*BaseApi) GetWebsiteSSLByWebsiteId ¶

func (b *BaseApi) GetWebsiteSSLByWebsiteId(c *gin.Context)

@Tags Website SSL @Summary Search website ssl by website id @Description 通过网站 id 查询 ssl @Accept json @Param websiteId path integer true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/website/:websiteId [get]

func (*BaseApi) GetWebsiteWafConfig ¶

func (b *BaseApi) GetWebsiteWafConfig(c *gin.Context)

@Tags Website WAF @Summary Load websit waf conf @Description 获取网站 waf 配置 @Accept json @Param request body request.WebsiteWafReq true "request" @Success 200 {object} response.WebsiteWafConfig @Security ApiKeyAuth @Router /websites/waf/config [post]

func (*BaseApi) GetWebsites ¶

func (b *BaseApi) GetWebsites(c *gin.Context)

@Tags Website @Summary List websites @Description 获取网站列表 @Success 200 {array} response.WebsiteDTO @Security ApiKeyAuth @Router /websites/list [get]

func (*BaseApi) HandleOnce ¶

func (b *BaseApi) HandleOnce(c *gin.Context)

@Tags Cronjob @Summary Handle cronjob once @Description 手动执行计划任务 @Accept json @Param request body dto.OperateByID true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/handle [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"cronjobs","output_column":"name","output_value":"name"}],"formatZH":"手动执行计划任务 [name]","formatEN":"manually execute the cronjob [name]"}

func (*BaseApi) HandlePasswordExpired ¶

func (b *BaseApi) HandlePasswordExpired(c *gin.Context)

@Tags System Setting @Summary Reset system password expired @Description 重置过期系统登录密码 @Accept json @Param request body dto.PasswordUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/expired/handle [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"重置过期密码","formatEN":"reset an expired Password"}

func (*BaseApi) HostTree ¶

func (b *BaseApi) HostTree(c *gin.Context)

@Tags Host @Summary Load host tree @Description 加载主机树 @Accept json @Param request body dto.SearchForTree true "request" @Success 200 {array} dto.HostTree @Security ApiKeyAuth @Router /hosts/tree [post]

func (*BaseApi) IgnoreUpgrade ¶ added in v1.4.0

func (b *BaseApi) IgnoreUpgrade(c *gin.Context)

@Tags App @Summary ignore App Update @Description 忽略应用升级版本 @Accept json @Param request body request.AppInstalledIgnoreUpgrade true "request" @Success 200 @Security ApiKeyAuth @Router /apps/installed/ignore [post] @x-panel-log {"bodyKeys":["installId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"忽略应用 [installId] 版本升级","formatEN":"Application param update [installId]"}

func (*BaseApi) ImageBuild ¶

func (b *BaseApi) ImageBuild(c *gin.Context)

@Tags Container Image @Summary Build image @Description 构建镜像 @Accept json @Param request body dto.ImageBuild true "request" @Success 200 {string} log @Security ApiKeyAuth @Router /containers/image/build [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"构建镜像 [name]","formatEN":"build image [name]"}

func (*BaseApi) ImageLoad ¶

func (b *BaseApi) ImageLoad(c *gin.Context)

@Tags Container Image @Summary Load image @Description 导入镜像 @Accept json @Param request body dto.ImageLoad true "request" @Success 200 @Security ApiKeyAuth @Router /containers/image/load [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 path 加载镜像","formatEN":"load image from path"}

func (*BaseApi) ImagePull ¶

func (b *BaseApi) ImagePull(c *gin.Context)

@Tags Container Image @Summary Pull image @Description 拉取镜像 @Accept json @Param request body dto.ImagePull true "request" @Success 200 {string} log @Security ApiKeyAuth @Router /containers/image/pull [post] @x-panel-log {"bodyKeys":["repoID","imageName"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"repoID","isList":false,"db":"image_repos","output_column":"name","output_value":"reponame"}],"formatZH":"镜像拉取 [reponame][imageName]","formatEN":"image pull [reponame][imageName]"}

func (*BaseApi) ImagePush ¶

func (b *BaseApi) ImagePush(c *gin.Context)

@Tags Container Image @Summary Push image @Description 推送镜像 @Accept json @Param request body dto.ImagePush true "request" @Success 200 {string} log @Security ApiKeyAuth @Router /containers/image/push [post] @x-panel-log {"bodyKeys":["repoID","tagName","name"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"repoID","isList":false,"db":"image_repos","output_column":"name","output_value":"reponame"}],"formatZH":"[tagName] 推送到 [reponame][name]","formatEN":"push [tagName] to [reponame][name]"}

func (*BaseApi) ImageRemove ¶

func (b *BaseApi) ImageRemove(c *gin.Context)

@Tags Container Image @Summary Delete image @Description 删除镜像 @Accept json @Param request body dto.BatchDelete true "request" @Success 200 @Security ApiKeyAuth @Router /containers/image/remove [post] @x-panel-log {"bodyKeys":["names"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"移除镜像 [names]","formatEN":"remove image [names]"}

func (*BaseApi) ImageSave ¶

func (b *BaseApi) ImageSave(c *gin.Context)

@Tags Container Image @Summary Save image @Description 导出镜像 @Accept json @Param request body dto.ImageSave true "request" @Success 200 @Security ApiKeyAuth @Router /containers/image/save [post] @x-panel-log {"bodyKeys":["tagName","path","name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"保留 [tagName] 为 path/[name]","formatEN":"save [tagName] as path/[name]"}

func (*BaseApi) ImageTag ¶

func (b *BaseApi) ImageTag(c *gin.Context)

@Tags Container Image @Summary Tag image @Description Tag 镜像 @Accept json @Param request body dto.ImageTag true "request" @Success 200 @Security ApiKeyAuth @Router /containers/image/tag [post] @x-panel-log {"bodyKeys":["repoID","targetName"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"repoID","isList":false,"db":"image_repos","output_column":"name","output_value":"reponame"}],"formatZH":"tag 镜像 [reponame][targetName]","formatEN":"tag image [reponame][targetName]"}

func (*BaseApi) ImportSnapshot ¶

func (b *BaseApi) ImportSnapshot(c *gin.Context)

@Tags System Setting @Summary Import system snapshot @Description 导入已有快照 @Accept json @Param request body dto.SnapshotImport true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/import [post] @x-panel-log {"bodyKeys":["from", "names"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 [from] 同步系统快照 [names]","formatEN":"Sync system snapshots [names] from [from]"}

func (*BaseApi) InitToolConfig ¶ added in v1.5.0

func (b *BaseApi) InitToolConfig(c *gin.Context)

@Tags Host tool @Summary Create Host tool Config @Description 创建主机工具配置 @Accept json @Param request body request.HostToolCreate true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/create [post] @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建 [type] 配置","formatEN":"create [type] config"}

func (*BaseApi) Inspect ¶

func (b *BaseApi) Inspect(c *gin.Context)

@Tags Container @Summary Container inspect @Description 容器详情 @Accept json @Param request body dto.InspectReq true "request" @Success 200 {string} result @Security ApiKeyAuth @Router /containers/inspect [post]

func (*BaseApi) InstallApp ¶

func (b *BaseApi) InstallApp(c *gin.Context)

@Tags App @Summary Install app @Description 安装应用 @Accept json @Param request body request.AppInstallCreate true "request" @Success 200 {object} model.AppInstall @Security ApiKeyAuth @Router /apps/install [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[{"input_column":"name","input_value":"name","isList":false,"db":"app_installs","output_column":"app_id","output_value":"appId"},{"info":"appId","isList":false,"db":"apps","output_column":"key","output_value":"appKey"}],"formatZH":"安装应用 [appKey]-[name]","formatEN":"Install app [appKey]-[name]"}

func (*BaseApi) Keys ¶

func (b *BaseApi) Keys(c *gin.Context)

func (*BaseApi) ListAllImage ¶ added in v1.9.3

func (b *BaseApi) ListAllImage(c *gin.Context)

@Tags Container Image @Summary List all images @Description 获取所有镜像列表 @Produce json @Success 200 {array} dto.ImageInfo @Security ApiKeyAuth @Router /containers/image/all [get]

func (*BaseApi) ListAppInstalled ¶ added in v1.6.0

func (b *BaseApi) ListAppInstalled(c *gin.Context)

@Tags App @Summary List app installed @Description 获取已安装应用列表 @Accept json @Success 200 array dto.AppInstallInfo @Security ApiKeyAuth @Router /apps/installed/list [get]

func (*BaseApi) ListBackup ¶

func (b *BaseApi) ListBackup(c *gin.Context)

@Tags Backup Account @Summary List backup accounts @Description 获取备份账号列表 @Success 200 {array} dto.BackupInfo @Security ApiKeyAuth @Router /settings/backup/search [get]

func (*BaseApi) ListBuckets ¶

func (b *BaseApi) ListBuckets(c *gin.Context)

@Tags Backup Account @Summary List buckets @Description 获取 bucket 列表 @Accept json @Param request body dto.ForBuckets true "request" @Success 200 {array} string @Security ApiKeyAuth @Router /settings/backup/search [post]

func (*BaseApi) ListCommand ¶

func (b *BaseApi) ListCommand(c *gin.Context)

@Tags Command @Summary List commands @Description 获取快速命令列表 @Success 200 {object} dto.CommandInfo @Security ApiKeyAuth @Router /hosts/command [get]

func (*BaseApi) ListComposeTemplate ¶

func (b *BaseApi) ListComposeTemplate(c *gin.Context)

@Tags Container Compose-template @Summary List compose templates @Description 获取容器编排模版列表 @Produce json @Success 200 {array} dto.ComposeTemplateInfo @Security ApiKeyAuth @Router /containers/template [get]

func (*BaseApi) ListContainer ¶ added in v1.4.0

func (b *BaseApi) ListContainer(c *gin.Context)

@Tags Container @Summary List containers @Description 获取容器名称 @Accept json @Produce json @Success 200 @Security ApiKeyAuth @Router /containers/list [post]

func (*BaseApi) ListDBName ¶

func (b *BaseApi) ListDBName(c *gin.Context)

@Tags Database Mysql @Summary List mysql database names @Description 获取 mysql 数据库列表 @Accept json @Param request body dto.PageInfo true "request" @Success 200 {array} dto.MysqlOption @Security ApiKeyAuth @Router /databases/options [get]

func (*BaseApi) ListDatabase ¶ added in v1.6.0

func (b *BaseApi) ListDatabase(c *gin.Context)

@Tags Database @Summary List databases @Description 获取远程数据库列表 @Success 200 {array} dto.DatabaseOption @Security ApiKeyAuth @Router /databases/db/list/:type [get]

func (*BaseApi) ListFiles ¶

func (b *BaseApi) ListFiles(c *gin.Context)

@Tags File @Summary List files @Description 获取文件列表 @Accept json @Param request body request.FileOption true "request" @Success 200 {object} response.FileInfo @Security ApiKeyAuth @Router /files/search [post]

func (*BaseApi) ListGroup ¶

func (b *BaseApi) ListGroup(c *gin.Context)

@Tags System Group @Summary List groups @Description 查询系统组 @Accept json @Param request body dto.GroupSearch true "request" @Success 200 {array} dto.GroupInfo @Security ApiKeyAuth @Router /groups/search [post]

func (*BaseApi) ListImage ¶

func (b *BaseApi) ListImage(c *gin.Context)

@Tags Container Image @Summary load images options @Description 获取镜像名称列表 @Produce json @Success 200 {array} dto.Options @Security ApiKeyAuth @Router /containers/image [get]

func (*BaseApi) ListNetwork ¶ added in v1.4.0

func (b *BaseApi) ListNetwork(c *gin.Context)

@Tags Container Network @Summary List networks @Description 获取容器网络列表 @Accept json @Produce json @Success 200 {array} dto.Options @Security ApiKeyAuth @Router /containers/network [get]

func (*BaseApi) ListPostgresqlDBName ¶ added in v1.9.3

func (b *BaseApi) ListPostgresqlDBName(c *gin.Context)

@Tags Database Postgresql @Summary List postgresql database names @Description 获取 postgresql 数据库列表 @Accept json @Param request body dto.PageInfo true "request" @Success 200 {array} dto.PostgresqlOption @Security ApiKeyAuth @Router /databases/pg/options [get]

func (*BaseApi) ListRepo ¶

func (b *BaseApi) ListRepo(c *gin.Context)

@Tags Container Image-repo @Summary List image repos @Description 获取镜像仓库列表 @Produce json @Success 200 {array} dto.ImageRepoOption @Security ApiKeyAuth @Router /containers/repo [get]

func (*BaseApi) ListVolume ¶

func (b *BaseApi) ListVolume(c *gin.Context)

@Tags Container Volume @Summary List volumes @Description 获取容器存储卷列表 @Accept json @Produce json @Success 200 {array} dto.Options @Security ApiKeyAuth @Router /containers/volume [get]

func (*BaseApi) LoadBaseDir ¶

func (b *BaseApi) LoadBaseDir(c *gin.Context)

@Tags System Setting @Summary Load local backup dir @Description 获取安装根目录 @Success 200 {string} path @Security ApiKeyAuth @Router /settings/basedir [get]

func (*BaseApi) LoadConnInfo ¶ added in v1.1.0

func (b *BaseApi) LoadConnInfo(c *gin.Context)

@Tags App @Summary Search app password by key @Description 获取应用连接信息 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {string} response.DatabaseConn @Security ApiKeyAuth @Router /apps/installed/conninfo/:key [get]

func (*BaseApi) LoadContainerLog ¶ added in v1.5.0

func (b *BaseApi) LoadContainerLog(c *gin.Context)

@Tags Container @Summary Load container log @Description 获取容器操作日志 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 @Security ApiKeyAuth @Router /containers/load/log [post]

func (*BaseApi) LoadDBBaseInfo ¶ added in v1.9.3

func (b *BaseApi) LoadDBBaseInfo(c *gin.Context)

@Tags Database Common @Summary Load base info @Description 获取数据库基础信息 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {object} dto.DBBaseInfo @Security ApiKeyAuth @Router /databases/common/info [post]

func (*BaseApi) LoadDBFile ¶ added in v1.9.3

func (b *BaseApi) LoadDBFile(c *gin.Context)

@Tags Database Common @Summary Load Database conf @Description 获取数据库配置文件 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 @Security ApiKeyAuth @Router /databases/common/load/file [post]

func (*BaseApi) LoadDBFromRemote ¶ added in v1.5.0

func (b *BaseApi) LoadDBFromRemote(c *gin.Context)

@Tags Database Mysql @Summary Load mysql database from remote @Description 从服务器获取 @Accept json @Param request body dto.MysqlLoadDB true "request" @Security ApiKeyAuth @Router /databases/load [post]

func (*BaseApi) LoadDaemonJson ¶

func (b *BaseApi) LoadDaemonJson(c *gin.Context)

@Tags Container Docker @Summary Load docker daemon.json @Description 获取 docker 配置信息 @Produce json @Success 200 {object} dto.DaemonJsonConf @Security ApiKeyAuth @Router /containers/daemonjson [get]

func (*BaseApi) LoadDaemonJsonFile ¶

func (b *BaseApi) LoadDaemonJsonFile(c *gin.Context)

@Tags Container Docker @Summary Load docker daemon.json @Description 获取 docker 配置信息(表单) @Produce json @Success 200 {object} string @Security ApiKeyAuth @Router /containers/daemonjson/file [get]

func (*BaseApi) LoadDashboardBaseInfo ¶

func (b *BaseApi) LoadDashboardBaseInfo(c *gin.Context)

@Tags Dashboard @Summary Load dashboard base info @Description 获取首页基础数据 @Accept json @Param ioOption path string true "request" @Param netOption path string true "request" @Success 200 {object} dto.DashboardBase @Security ApiKeyAuth @Router /dashboard/base/:ioOption/:netOption [get]

func (*BaseApi) LoadDashboardCurrentInfo ¶

func (b *BaseApi) LoadDashboardCurrentInfo(c *gin.Context)

@Tags Dashboard @Summary Load dashboard current info @Description 获取首页实时数据 @Accept json @Param ioOption path string true "request" @Param netOption path string true "request" @Success 200 {object} dto.DashboardCurrent @Security ApiKeyAuth @Router /dashboard/current/:ioOption/:netOption [get]

func (*BaseApi) LoadDatabaseItems ¶ added in v1.9.3

func (b *BaseApi) LoadDatabaseItems(c *gin.Context)

@Tags Database @Summary List databases @Description 获取数据库列表 @Success 200 {array} dto.DatabaseItem @Security ApiKeyAuth @Router /databases/db/item/:type [get]

func (*BaseApi) LoadDeviceBaseInfo ¶ added in v1.9.0

func (b *BaseApi) LoadDeviceBaseInfo(c *gin.Context)

@Tags Device @Summary Load device base info @Description 获取设备基础信息 @Success 200 {object} dto.DeviceBaseInfo @Security ApiKeyAuth @Router /toolbox/device/base [post]

func (*BaseApi) LoadDeviceConf ¶ added in v1.9.0

func (b *BaseApi) LoadDeviceConf(c *gin.Context)

@Tags Device @Summary load conf @Description 获取系统配置文件 @Accept json @Param request body dto.OperationWithName true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/conf [post]

func (*BaseApi) LoadDockerStatus ¶

func (b *BaseApi) LoadDockerStatus(c *gin.Context)

@Tags Container Docker @Summary Load docker status @Description 获取 docker 服务状态 @Produce json @Success 200 {string} status @Security ApiKeyAuth @Router /containers/docker/status [get]

func (*BaseApi) LoadFail2BanBaseInfo ¶ added in v1.9.0

func (b *BaseApi) LoadFail2BanBaseInfo(c *gin.Context)

@Tags Fail2ban @Summary Load fail2ban base info @Description 获取 Fail2ban 基础信息 @Success 200 {object} dto.Fail2BanBaseInfo @Security ApiKeyAuth @Router /toolbox/fail2ban/base [get]

func (*BaseApi) LoadFail2BanConf ¶ added in v1.9.0

func (b *BaseApi) LoadFail2BanConf(c *gin.Context)

@Tags Fail2ban @Summary Load fail2ban conf @Description 获取 fail2ban 配置文件 @Accept json @Success 200 @Security ApiKeyAuth @Router /toolbox/fail2ban/load/conf [get]

func (*BaseApi) LoadFilesFromBackup ¶

func (b *BaseApi) LoadFilesFromBackup(c *gin.Context)

@Tags Backup Account @Summary List files from backup accounts @Description 获取备份账号内文件列表 @Accept json @Param request body dto.BackupSearchFile true "request" @Success 200 {array} string @Security ApiKeyAuth @Router /settings/backup/search/files [post]

func (*BaseApi) LoadFirewallBaseInfo ¶ added in v1.1.0

func (b *BaseApi) LoadFirewallBaseInfo(c *gin.Context)

@Tags Firewall @Summary Load firewall base info @Description 获取防火墙基础信息 @Success 200 {object} dto.FirewallBaseInfo @Security ApiKeyAuth @Router /hosts/firewall/base [get]

func (*BaseApi) LoadFromCert ¶ added in v1.2.0

func (b *BaseApi) LoadFromCert(c *gin.Context)

@Tags System Setting @Summary Load system cert info @Description 获取证书信息 @Success 200 {object} dto.SettingInfo @Security ApiKeyAuth @Router /settings/ssl/info [get]

func (*BaseApi) LoadInterfaceAddr ¶ added in v1.8.0

func (b *BaseApi) LoadInterfaceAddr(c *gin.Context)

@Tags System Setting @Summary Load system address @Description 获取系统地址信息 @Accept json @Success 200 @Security ApiKeyAuth @Router /settings/interface [get]

func (*BaseApi) LoadMFA ¶ added in v1.7.0

func (b *BaseApi) LoadMFA(c *gin.Context)

@Tags System Setting @Summary Load mfa info @Description 获取 mfa 信息 @Accept json @Param request body dto.MfaCredential true "request" @Success 200 {object} mfa.Otp @Security ApiKeyAuth @Router /settings/mfa [post]

func (*BaseApi) LoadMonitor ¶

func (b *BaseApi) LoadMonitor(c *gin.Context)

func (*BaseApi) LoadOneDriveInfo ¶ added in v1.4.0

func (b *BaseApi) LoadOneDriveInfo(c *gin.Context)

@Tags Backup Account @Summary Load OneDrive info @Description 获取 OneDrive 信息 @Accept json @Success 200 {object} dto.OneDriveInfo @Security ApiKeyAuth @Router /settings/backup/onedrive [get]

func (*BaseApi) LoadPersistenceConf ¶

func (b *BaseApi) LoadPersistenceConf(c *gin.Context)

@Tags Database Redis @Summary Load redis persistence conf @Description 获取 redis 持久化配置 @Success 200 {object} dto.RedisPersistence @Security ApiKeyAuth @Router /databases/redis/persistence/conf [get]

func (*BaseApi) LoadPort ¶

func (b *BaseApi) LoadPort(c *gin.Context)

@Tags App @Summary Search app port by key @Description 获取应用端口 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {integer} port @Security ApiKeyAuth @Router /apps/installed/loadport [post]

func (*BaseApi) LoadPostgresqlDBFromRemote ¶ added in v1.9.3

func (b *BaseApi) LoadPostgresqlDBFromRemote(c *gin.Context)

@Tags Database Postgresql @Summary Load postgresql database from remote @Description 从服务器获取 @Accept json @Param request body dto.PostgresqlLoadDB true "request" @Security ApiKeyAuth @Router /databases/pg/:database/load [post]

func (*BaseApi) LoadRecordLog ¶ added in v1.5.0

func (b *BaseApi) LoadRecordLog(c *gin.Context)

@Tags Cronjob @Summary Load Cronjob record log @Description 获取计划任务记录日志 @Accept json @Param request body dto.OperateByID true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/records/log [post]

func (*BaseApi) LoadRedisConf ¶

func (b *BaseApi) LoadRedisConf(c *gin.Context)

@Tags Database Redis @Summary Load redis conf @Description 获取 redis 配置信息 @Success 200 {object} dto.RedisConf @Security ApiKeyAuth @Router /databases/redis/conf [get]

func (*BaseApi) LoadRedisStatus ¶

func (b *BaseApi) LoadRedisStatus(c *gin.Context)

@Tags Database Redis @Summary Load redis status info @Description 获取 redis 状态信息 @Success 200 {object} dto.RedisStatus @Security ApiKeyAuth @Router /databases/redis/status [get]

func (*BaseApi) LoadRemoteAccess ¶

func (b *BaseApi) LoadRemoteAccess(c *gin.Context)

@Tags Database Mysql @Summary Load mysql remote access @Description 获取 mysql 远程访问权限 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {boolean} isRemote @Security ApiKeyAuth @Router /databases/remote [post]

func (*BaseApi) LoadResourceLimit ¶ added in v1.7.0

func (b *BaseApi) LoadResourceLimit(c *gin.Context)

@Summary Load container limits @Description 获取容器限制 @Success 200 {object} dto.ResourceLimit @Security ApiKeyAuth @Router /containers/limit [get]

func (*BaseApi) LoadSSHConf ¶ added in v1.5.0

func (b *BaseApi) LoadSSHConf(c *gin.Context)

@Tags SSH @Summary Load host SSH conf @Description 获取 SSH 配置文件 @Success 200 @Security ApiKeyAuth @Router /host/ssh/conf [get]

func (*BaseApi) LoadSSHLogs ¶ added in v1.3.0

func (b *BaseApi) LoadSSHLogs(c *gin.Context)

@Tags SSH @Summary Load host SSH logs @Description 获取 SSH 登录日志 @Accept json @Param request body dto.SearchSSHLog true "request" @Success 200 {object} dto.SSHLog @Security ApiKeyAuth @Router /host/ssh/log [post]

func (*BaseApi) LoadSSHSecret ¶ added in v1.3.0

func (b *BaseApi) LoadSSHSecret(c *gin.Context)

@Tags SSH @Summary Load host SSH secret @Description 获取 SSH 密钥 @Accept json @Param request body dto.GenerateLoad true "request" @Success 200 @Security ApiKeyAuth @Router /host/ssh/secret [post]

func (*BaseApi) LoadSnapShotStatus ¶ added in v1.6.0

func (b *BaseApi) LoadSnapShotStatus(c *gin.Context)

@Tags System Setting @Summary Load Snapshot status @Description 获取快照状态 @Accept json @Param request body dto.OperateByID true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/status [post]

func (*BaseApi) LoadStatus ¶

func (b *BaseApi) LoadStatus(c *gin.Context)

@Tags Database Mysql @Summary Load mysql status info @Description 获取 mysql 状态信息 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {object} dto.MysqlStatus @Security ApiKeyAuth @Router /databases/status [post]

func (*BaseApi) LoadTimeOption ¶ added in v1.9.0

func (b *BaseApi) LoadTimeOption(c *gin.Context)

@Tags Device @Summary list time zone options @Description 获取系统可用时区选项 @Accept json @Success 200 {Array} string @Security ApiKeyAuth @Router /toolbox/device/zone/options [get]

func (*BaseApi) LoadVariables ¶

func (b *BaseApi) LoadVariables(c *gin.Context)

@Tags Database Mysql @Summary Load mysql variables info @Description 获取 mysql 性能参数信息 @Accept json @Param request body dto.OperationWithNameAndType true "request" @Success 200 {object} dto.MysqlVariables @Security ApiKeyAuth @Router /databases/variables [post]

func (*BaseApi) LogOut ¶

func (b *BaseApi) LogOut(c *gin.Context)

@Tags Auth @Summary User logout @Description 用户登出 @Success 200 @Security ApiKeyAuth @Router /auth/logout [post]

func (*BaseApi) Login ¶

func (b *BaseApi) Login(c *gin.Context)

@Tags Auth @Summary User login @Description 用户登录 @Accept json @Param EntranceCode header string true "安全入口 base64 加密串" @Param request body dto.Login true "request" @Success 200 {object} dto.UserLoginInfo @Router /auth/login [post]

func (*BaseApi) MFABind ¶

func (b *BaseApi) MFABind(c *gin.Context)

@Tags System Setting @Summary Bind mfa @Description Mfa 绑定 @Accept json @Param request body dto.MfaCredential true "request" @Success 200 @Security ApiKeyAuth @Router /settings/mfa/bind [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"mfa 绑定","formatEN":"bind mfa"}

func (*BaseApi) MFALogin ¶

func (b *BaseApi) MFALogin(c *gin.Context)

@Tags Auth @Summary User login with mfa @Description 用户 mfa 登录 @Accept json @Param request body dto.MFALogin true "request" @Success 200 {object} dto.UserLoginInfo @Router /auth/mfalogin [post] @Header 200 {string} EntranceCode "安全入口"

func (*BaseApi) MoveFile ¶

func (b *BaseApi) MoveFile(c *gin.Context)

@Tags File @Summary Move file @Description 移动文件 @Accept json @Param request body request.FileMove true "request" @Success 200 @Security ApiKeyAuth @Router /files/move [post] @x-panel-log {"bodyKeys":["oldPaths","newPath"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"移动文件 [oldPaths] => [newPath]","formatEN":"Move [oldPaths] => [newPath]"}

func (*BaseApi) ObtainWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) ObtainWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Obtain SSL @Description 自签 SSL 证书 @Accept json @Param request body request.WebsiteCAObtain true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ca/obtain [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_cas","output_column":"name","output_value":"name"}],"formatZH":"自签 SSL 证书 [name]","formatEN":"Obtain SSL [name]"}

func (*BaseApi) OpWebsite ¶

func (b *BaseApi) OpWebsite(c *gin.Context)

@Tags Website @Summary Operate website @Description 操作网站 @Accept json @Param request body request.WebsiteOp true "request" @Success 200 @Security ApiKeyAuth @Router /websites/operate [post] @x-panel-log {"bodyKeys":["id", "operate"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"[operate] 网站 [domain]","formatEN":"[operate] website [domain]"}

func (*BaseApi) OpWebsiteLog ¶

func (b *BaseApi) OpWebsiteLog(c *gin.Context)

@Tags Website @Summary Operate website log @Description 操作网站日志 @Accept json @Param request body request.WebsiteLogReq true "request" @Success 200 {object} response.WebsiteLog @Security ApiKeyAuth @Router /websites/log [post] @x-panel-log {"bodyKeys":["id", "operate"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"[domain][operate] 日志","formatEN":"[domain][operate] logs"}

func (*BaseApi) OperateDocker ¶

func (b *BaseApi) OperateDocker(c *gin.Context)

@Tags Container Docker @Summary Operate docker @Description Docker 操作 @Accept json @Param request body dto.DockerOperation true "request" @Success 200 @Security ApiKeyAuth @Router /containers/docker/operate [post] @x-panel-log {"bodyKeys":["operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"docker 服务 [operation]","formatEN":"[operation] docker service"}

func (*BaseApi) OperateFail2Ban ¶ added in v1.9.0

func (b *BaseApi) OperateFail2Ban(c *gin.Context)

@Tags Fail2ban @Summary Operate fail2ban @Description 修改 Fail2ban 状态 @Accept json @Param request body dto.Operate true "request" @Security ApiKeyAuth @Router /toolbox/fail2ban/operate [post] @x-panel-log {"bodyKeys":["operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operation] Fail2ban","formatEN":"[operation] Fail2ban"}

func (*BaseApi) OperateFirewall ¶ added in v1.1.0

func (b *BaseApi) OperateFirewall(c *gin.Context)

@Tags Firewall @Summary Page firewall status @Description 修改防火墙状态 @Accept json @Param request body dto.FirewallOperation true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /hosts/firewall/operate [post] @x-panel-log {"bodyKeys":["operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operation] 防火墙","formatEN":"[operation] firewall"}

func (*BaseApi) OperateIPRule ¶ added in v1.1.0

func (b *BaseApi) OperateIPRule(c *gin.Context)

@Tags Firewall @Summary Create group @Description 创建防火墙 IP 规则 @Accept json @Param request body dto.AddrRuleOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/ip [post] @x-panel-log {"bodyKeys":["strategy","address"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"添加 ip 规则 [strategy] [address]","formatEN":"create address rules [strategy][address]"}

func (*BaseApi) OperateInstalled ¶

func (b *BaseApi) OperateInstalled(c *gin.Context)

@Tags App @Summary Operate installed app @Description 操作已安装应用 @Accept json @Param request body request.AppInstalledOperate true "request" @Success 200 @Security ApiKeyAuth @Router /apps/installed/op [post] @x-panel-log {"bodyKeys":["installId","operate"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"installId","isList":false,"db":"app_installs","output_column":"app_id","output_value":"appId"},{"input_column":"id","input_value":"installId","isList":false,"db":"app_installs","output_column":"name","output_value":"appName"},{"input_column":"id","input_value":"appId","isList":false,"db":"apps","output_column":"key","output_value":"appKey"}],"formatZH":"[operate] 应用 [appKey][appName]","formatEN":"[operate] App [appKey][appName]"}

func (*BaseApi) OperateNodeModules ¶ added in v1.7.0

func (b *BaseApi) OperateNodeModules(c *gin.Context)

@Tags Runtime @Summary Operate Node modules @Description 操作 Node 项目 modules @Accept json @Param request body request.NodeModuleReq true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/node/modules/operate [post]

func (*BaseApi) OperatePortRule ¶ added in v1.1.0

func (b *BaseApi) OperatePortRule(c *gin.Context)

@Tags Firewall @Summary Create group @Description 创建防火墙端口规则 @Accept json @Param request body dto.PortRuleOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/port [post] @x-panel-log {"bodyKeys":["port","strategy"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"添加端口规则 [strategy] [port]","formatEN":"create port rules [strategy][port]"}

func (*BaseApi) OperateProcess ¶ added in v1.5.0

func (b *BaseApi) OperateProcess(c *gin.Context)

@Tags Host tool @Summary Create Supervisor process @Description 操作守护进程 @Accept json @Param request body request.SupervisorProcessConfig true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/supervisor/process [post] @x-panel-log {"bodyKeys":["operate"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operate] 守护进程 ","formatEN":"[operate] process"}

func (*BaseApi) OperateRuntime ¶ added in v1.7.0

func (b *BaseApi) OperateRuntime(c *gin.Context)

@Tags Runtime @Summary Operate runtime @Description 操作运行环境 @Accept json @Param request body request.RuntimeOperate true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/operate [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"操作运行环境 [name]","formatEN":"Operate runtime [name]"}

func (*BaseApi) OperateSSH ¶ added in v1.3.0

func (b *BaseApi) OperateSSH(c *gin.Context)

@Tags SSH @Summary Operate SSH @Description 修改 SSH 服务状态 @Accept json @Param request body dto.Operate true "request" @Security ApiKeyAuth @Router /host/ssh/operate [post] @x-panel-log {"bodyKeys":["operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operation] SSH ","formatEN":"[operation] SSH"}

func (*BaseApi) OperateSSHD ¶ added in v1.9.0

func (b *BaseApi) OperateSSHD(c *gin.Context)

@Tags Fail2ban @Summary Operate sshd of fail2ban @Description 配置 sshd @Accept json @Param request body dto.Operate true "request" @Security ApiKeyAuth @Router /toolbox/fail2ban/operate/sshd [post]

func (*BaseApi) OperateTool ¶ added in v1.5.0

func (b *BaseApi) OperateTool(c *gin.Context)

@Tags Host tool @Summary Operate tool @Description 操作主机工具 @Accept json @Param request body request.HostToolReq true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/operate [post] @x-panel-log {"bodyKeys":["operate","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operate] [type] ","formatEN":"[operate] [type]"}

func (*BaseApi) OperateToolConfig ¶ added in v1.5.0

func (b *BaseApi) OperateToolConfig(c *gin.Context)

@Tags Host tool @Summary Get tool config @Description 操作主机工具配置文件 @Accept json @Param request body request.HostToolConfig true "request" @Success 200 @Security ApiKeyAuth @Router /host/tool/config [post] @x-panel-log {"bodyKeys":["operate"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operate] 主机工具配置文件 ","formatEN":"[operate] tool config"}

func (*BaseApi) OperatorCompose ¶

func (b *BaseApi) OperatorCompose(c *gin.Context)

@Tags Container Compose @Summary Operate compose @Description 容器编排操作 @Accept json @Param request body dto.ComposeOperation true "request" @Success 200 @Security ApiKeyAuth @Router /containers/compose/operate [post] @x-panel-log {"bodyKeys":["name","operation"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"compose [operation] [name]","formatEN":"compose [operation] [name]"}

func (*BaseApi) PagePHPExtensions ¶ added in v1.9.3

func (b *BaseApi) PagePHPExtensions(c *gin.Context)

@Tags PHP Extensions @Summary Page Extensions @Description Page Extensions @Accept json @Param request body request.PHPExtensionsSearch true "request" @Success 200 {array} response.PHPExtensionsDTO @Security ApiKeyAuth @Router /runtimes/php/extensions/search [post]

func (*BaseApi) PageWebsite ¶

func (b *BaseApi) PageWebsite(c *gin.Context)

@Tags Website @Summary Page websites @Description 获取网站列表分页 @Accept json @Param request body request.WebsiteSearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /websites/search [post]

func (*BaseApi) PageWebsiteAcmeAccount ¶

func (b *BaseApi) PageWebsiteAcmeAccount(c *gin.Context)

@Tags Website Acme @Summary Page website acme accounts @Description 获取网站 acme 列表分页 @Accept json @Param request body dto.PageInfo true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /websites/acme/search [post]

func (*BaseApi) PageWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) PageWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Page website ca @Description 获取网站 ca 列表分页 @Accept json @Param request body request.WebsiteCASearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /websites/ca/search [post]

func (*BaseApi) PageWebsiteDnsAccount ¶

func (b *BaseApi) PageWebsiteDnsAccount(c *gin.Context)

@Tags Website DNS @Summary Page website dns accounts @Description 获取网站 dns 列表分页 @Accept json @Param request body dto.PageInfo true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /websites/dns/search [post]

func (*BaseApi) PageWebsiteSSL ¶

func (b *BaseApi) PageWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Page website ssl @Description 获取网站 ssl 列表分页 @Accept json @Param request body request.WebsiteSSLSearch true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/search [post]

func (*BaseApi) ProcessWs ¶ added in v1.4.0

func (b *BaseApi) ProcessWs(c *gin.Context)

func (*BaseApi) ReadFileByLine ¶ added in v1.8.0

func (b *BaseApi) ReadFileByLine(c *gin.Context)

@Tags File @Summary Read file by Line @Description 按行读取日志文件 @Param request body request.FileReadByLineReq true "request" @Success 200 @Security ApiKeyAuth @Router /files/read [post]

func (*BaseApi) Recover ¶

func (b *BaseApi) Recover(c *gin.Context)

@Tags Backup Account @Summary Recover system data @Description 恢复系统数据 @Accept json @Param request body dto.CommonRecover true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/recover [post] @x-panel-log {"bodyKeys":["type","name","detailName","file"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 [file] 恢复 [type] 数据 [name][detailName]","formatEN":"recover [type] data [name][detailName] from [file]"}

func (*BaseApi) RecoverByUpload ¶

func (b *BaseApi) RecoverByUpload(c *gin.Context)

@Tags Backup Account @Summary Recover system data by upload @Description 从上传恢复系统数据 @Accept json @Param request body dto.CommonRecover true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/recover/byupload [post] @x-panel-log {"bodyKeys":["type","name","detailName","file"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 [file] 恢复 [type] 数据 [name][detailName]","formatEN":"recover [type] data [name][detailName] from [file]"}

func (*BaseApi) RecoverSnapshot ¶

func (b *BaseApi) RecoverSnapshot(c *gin.Context)

@Tags System Setting @Summary Recover system backup @Description 从系统快照恢复 @Accept json @Param request body dto.SnapshotRecover true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/recover [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"snapshots","output_column":"name","output_value":"name"}],"formatZH":"从系统快照 [name] 恢复","formatEN":"Recover from system backup [name]"}

func (*BaseApi) RedisBackupList ¶

func (b *BaseApi) RedisBackupList(c *gin.Context)

@Tags Database Redis @Summary Page redis backups @Description 获取 redis 备份记录分页 @Accept json @Param request body dto.PageInfo true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /databases/redis/backup/search [post]

func (*BaseApi) RedisWsSsh ¶

func (b *BaseApi) RedisWsSsh(c *gin.Context)

func (*BaseApi) ReduceRecycleBinFile ¶ added in v1.8.0

func (b *BaseApi) ReduceRecycleBinFile(c *gin.Context)

@Tags File @Summary Reduce RecycleBin files @Description 还原回收站文件 @Accept json @Param request body request.RecycleBinReduce true "request" @Success 200 @Security ApiKeyAuth @Router /files/recycle/reduce [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"还原回收站文件 [name]","formatEN":"Reduce RecycleBin file [name]"}

func (*BaseApi) RefreshOneDriveToken ¶ added in v1.9.5

func (b *BaseApi) RefreshOneDriveToken(c *gin.Context)

@Tags Backup Account @Summary Refresh OneDrive token @Description 刷新 OneDrive token @Success 200 @Security ApiKeyAuth @Router /settings/backup/refresh/onedrive [post]

func (*BaseApi) RenewWebsiteCA ¶ added in v1.9.0

func (b *BaseApi) RenewWebsiteCA(c *gin.Context)

@Tags Website CA @Summary Obtain SSL @Description 续签 SSL 证书 @Accept json @Param request body request.WebsiteCAObtain true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ca/renew [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_cas","output_column":"name","output_value":"name"}],"formatZH":"自签 SSL 证书 [name]","formatEN":"Obtain SSL [name]"}

func (*BaseApi) RollbackSnapshot ¶

func (b *BaseApi) RollbackSnapshot(c *gin.Context)

@Tags System Setting @Summary Rollback system backup @Description 从系统快照回滚 @Accept json @Param request body dto.SnapshotRecover true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/rollback [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"snapshots","output_column":"name","output_value":"name"}],"formatZH":"从系统快照 [name] 回滚","formatEN":"Rollback from system backup [name]"}

func (*BaseApi) SaveContent ¶

func (b *BaseApi) SaveContent(c *gin.Context)

@Tags File @Summary Update file content @Description 更新文件内容 @Accept json @Param request body request.FileEdit true "request" @Success 200 @Security ApiKeyAuth @Router /files/save [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新文件内容 path","formatEN":"Update file content path"}

func (*BaseApi) ScanSystem ¶ added in v1.7.0

func (b *BaseApi) ScanSystem(c *gin.Context)

@Tags Device @Summary Scan system @Description 扫描系统垃圾文件 @Success 200 @Security ApiKeyAuth @Router /toolbox/scan [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"扫描系统垃圾文件","formatEN":"scan System Junk Files"}

func (*BaseApi) SearchApp ¶

func (b *BaseApi) SearchApp(c *gin.Context)

@Tags App @Summary List apps @Description 获取应用列表 @Accept json @Param request body request.AppSearch true "request" @Success 200 @Security ApiKeyAuth @Router /apps/search [post]

func (*BaseApi) SearchAppInstalled ¶

func (b *BaseApi) SearchAppInstalled(c *gin.Context)

@Tags App @Summary Page app installed @Description 分页获取已安装应用列表 @Accept json @Param request body request.AppInstalledSearch true "request" @Success 200 @Security ApiKeyAuth @Router /apps/installed/search [post]

func (*BaseApi) SearchBackupRecords ¶

func (b *BaseApi) SearchBackupRecords(c *gin.Context)

@Tags Backup Account @Summary Page backup records @Description 获取备份记录列表分页 @Accept json @Param request body dto.RecordSearch true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/record/search [post]

func (*BaseApi) SearchBackupRecordsByCronjob ¶ added in v1.9.5

func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context)

@Tags Backup Account @Summary Page backup records by cronjob @Description 通过计划任务获取备份记录列表分页 @Accept json @Param request body dto.RecordSearchByCronjob true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/record/search/bycronjob [post]

func (*BaseApi) SearchCommand ¶

func (b *BaseApi) SearchCommand(c *gin.Context)

@Tags Command @Summary Page commands @Description 获取快速命令列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /hosts/command/search [post]

func (*BaseApi) SearchCommandTree ¶ added in v1.8.0

func (b *BaseApi) SearchCommandTree(c *gin.Context)

@Tags Command @Summary Tree commands @Description 获取快速命令树 @Accept json @Success 200 {Array} dto.CommandTree @Security ApiKeyAuth @Router /hosts/command/tree [get]

func (*BaseApi) SearchCompose ¶

func (b *BaseApi) SearchCompose(c *gin.Context)

@Tags Container Compose @Summary Page composes @Description 获取编排列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/compose/search [post]

func (*BaseApi) SearchComposeTemplate ¶

func (b *BaseApi) SearchComposeTemplate(c *gin.Context)

@Tags Container Compose-template @Summary Page compose templates @Description 获取容器编排模版列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/template/search [post]

func (*BaseApi) SearchContainer ¶

func (b *BaseApi) SearchContainer(c *gin.Context)

@Tags Container @Summary Page containers @Description 获取容器列表分页 @Accept json @Param request body dto.PageContainer true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/search [post]

func (*BaseApi) SearchCronjob ¶

func (b *BaseApi) SearchCronjob(c *gin.Context)

@Tags Cronjob @Summary Page cronjobs @Description 获取计划任务分页 @Accept json @Param request body dto.SearchWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /cronjobs/search [post]

func (*BaseApi) SearchDatabase ¶ added in v1.6.0

func (b *BaseApi) SearchDatabase(c *gin.Context)

@Tags Database @Summary Page databases @Description 获取远程数据库列表分页 @Accept json @Param request body dto.DatabaseSearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /databases/db/search [post]

func (*BaseApi) SearchFail2Ban ¶ added in v1.9.0

func (b *BaseApi) SearchFail2Ban(c *gin.Context)

@Tags Fail2ban @Summary Page fail2ban ip list @Description 获取 Fail2ban ip @Accept json @Param request body dto.Fail2BanSearch true "request" @Success 200 {Array} string @Security ApiKeyAuth @Router /toolbox/fail2ban/search [post]

func (*BaseApi) SearchFavorite ¶ added in v1.8.0

func (b *BaseApi) SearchFavorite(c *gin.Context)

@Tags File @Summary List favorites @Description 获取收藏列表 @Accept json @Param request body dto.PageInfo true "request" @Success 200 @Security ApiKeyAuth @Router /files/favorite/search [post]

func (*BaseApi) SearchFirewallRule ¶ added in v1.1.0

func (b *BaseApi) SearchFirewallRule(c *gin.Context)

@Tags Firewall @Summary Page firewall rules @Description 获取防火墙规则列表分页 @Accept json @Param request body dto.RuleSearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /hosts/firewall/search [post]

func (*BaseApi) SearchHost ¶

func (b *BaseApi) SearchHost(c *gin.Context)

@Tags Host @Summary Page host @Description 获取主机列表分页 @Accept json @Param request body dto.SearchHostWithPage true "request" @Success 200 {array} dto.HostTree @Security ApiKeyAuth @Router /hosts/search [post]

func (*BaseApi) SearchImage ¶

func (b *BaseApi) SearchImage(c *gin.Context)

@Tags Container Image @Summary Page images @Description 获取镜像列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/image/search [post]

func (*BaseApi) SearchJobRecords ¶

func (b *BaseApi) SearchJobRecords(c *gin.Context)

@Tags Cronjob @Summary Page job records @Description 获取计划任务记录 @Accept json @Param request body dto.SearchRecord true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /cronjobs/search/records [post]

func (*BaseApi) SearchMysql ¶

func (b *BaseApi) SearchMysql(c *gin.Context)

@Tags Database Mysql @Summary Page mysql databases @Description 获取 mysql 数据库列表分页 @Accept json @Param request body dto.MysqlDBSearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /databases/search [post]

func (*BaseApi) SearchNetwork ¶

func (b *BaseApi) SearchNetwork(c *gin.Context)

@Tags Container Network @Summary Page networks @Description 获取容器网络列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/network/search [post]

func (*BaseApi) SearchPostgresql ¶ added in v1.9.3

func (b *BaseApi) SearchPostgresql(c *gin.Context)

@Tags Database Postgresql @Summary Page postgresql databases @Description 获取 postgresql 数据库列表分页 @Accept json @Param request body dto.PostgresqlDBSearch true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /databases/pg/search [post]

func (*BaseApi) SearchRecycleBinFile ¶ added in v1.8.0

func (b *BaseApi) SearchRecycleBinFile(c *gin.Context)

@Tags File @Summary List RecycleBin files @Description 获取回收站文件列表 @Accept json @Param request body dto.PageInfo true "request" @Success 200 @Security ApiKeyAuth @Router /files/recycle/search [post]

func (*BaseApi) SearchRepo ¶

func (b *BaseApi) SearchRepo(c *gin.Context)

@Tags Container Image-repo @Summary Page image repos @Description 获取镜像仓库列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/repo/search [post]

func (*BaseApi) SearchRuntimes ¶ added in v1.1.0

func (b *BaseApi) SearchRuntimes(c *gin.Context)

@Tags Runtime @Summary List runtimes @Description 获取运行环境列表 @Accept json @Param request body request.RuntimeSearch true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/search [post]

func (*BaseApi) SearchSnapshot ¶

func (b *BaseApi) SearchSnapshot(c *gin.Context)

@Tags System Setting @Summary Page system snapshot @Description 获取系统快照列表分页 @Accept json @Param request body dto.SearchWithPage true "request" @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /settings/snapshot/search [post]

func (*BaseApi) SearchUploadWithPage ¶

func (b *BaseApi) SearchUploadWithPage(c *gin.Context)

@Tags File @Summary Page file @Description 分页获取上传文件 @Accept json @Param request body request.SearchUploadWithPage true "request" @Success 200 {array} response.FileInfo @Security ApiKeyAuth @Router /files/upload/search [post]

func (*BaseApi) SearchVolume ¶

func (b *BaseApi) SearchVolume(c *gin.Context)

@Tags Container Volume @Summary Page volumes @Description 获取容器存储卷分页 @Accept json @Param request body dto.SearchWithPage true "request" @Produce json @Success 200 {object} dto.PageResult @Security ApiKeyAuth @Router /containers/volume/search [post]

func (*BaseApi) Size ¶

func (b *BaseApi) Size(c *gin.Context)

@Tags File @Summary Load file size @Description 获取文件夹大小 @Accept json @Param request body request.DirSizeReq true "request" @Success 200 @Security ApiKeyAuth @Router /files/size [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"获取文件夹大小 path","formatEN":"Load file size path"}

func (*BaseApi) StopProcess ¶ added in v1.4.0

func (b *BaseApi) StopProcess(c *gin.Context)

@Tags Process @Summary Stop Process @Description 停止进程 @Param request body request.ProcessReq true "request" @Success 200 @Security ApiKeyAuth @Router /process/stop [post] @x-panel-log {"bodyKeys":["PID"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"结束进程 [PID]","formatEN":"结束进程 [PID]"}

func (*BaseApi) SyncApp ¶

func (b *BaseApi) SyncApp(c *gin.Context)

@Tags App @Summary Sync app list @Description 同步应用列表 @Success 200 @Security ApiKeyAuth @Router /apps/sync [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用商店同步","formatEN":"App store synchronization"}

func (*BaseApi) SyncInstalled ¶

func (b *BaseApi) SyncInstalled(c *gin.Context)

Sync app installed @Tags App @Summary Sync app installed @Description 同步已安装应用列表 @Success 200 @Security ApiKeyAuth @Router /apps/installed/sync [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"同步已安装应用列表","formatEN":"Sync the list of installed apps"}

func (*BaseApi) SystemClean ¶ added in v1.7.0

func (b *BaseApi) SystemClean(c *gin.Context)

@Tags Device @Summary Clean system @Description 清理系统垃圾文件 @Accept json @Param request body []dto.Clean true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/clean [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"清理系统垃圾文件","formatEN":"Clean system junk files"}

func (*BaseApi) SystemRestart ¶ added in v1.8.0

func (b *BaseApi) SystemRestart(c *gin.Context)

@Tags Dashboard @Summary System restart @Description 重启服务器/面板 @Accept json @Param operation path string true "request" @Success 200 @Security ApiKeyAuth @Router /dashboard/system/restart/:operation [post]

func (*BaseApi) TargetDownload ¶

func (b *BaseApi) TargetDownload(c *gin.Context)

@Tags Cronjob @Summary Download cronjob records @Description 下载计划任务记录 @Accept json @Param request body dto.CronjobDownload true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/download [post] @x-panel-log {"bodyKeys":["recordID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"recordID","isList":false,"db":"job_records","output_column":"file","output_value":"file"}],"formatZH":"下载计划任务记录 [file]","formatEN":"download the cronjob record [file]"}

func (*BaseApi) TestByID ¶

func (b *BaseApi) TestByID(c *gin.Context)

@Tags Host @Summary Test host conn by host id @Description 测试主机连接 @Accept json @Param id path integer true "request" @Success 200 {boolean} connStatus @Security ApiKeyAuth @Router /hosts/test/byid/:id [post]

func (*BaseApi) TestByInfo ¶

func (b *BaseApi) TestByInfo(c *gin.Context)

@Tags Host @Summary Test host conn by info @Description 测试主机连接 @Accept json @Param request body dto.HostConnTest true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/test/byinfo [post]

func (*BaseApi) TestCompose ¶ added in v1.0.3

func (b *BaseApi) TestCompose(c *gin.Context)

@Tags Container Compose @Summary Test compose @Description 测试 compose 是否可用 @Accept json @Param request body dto.ComposeCreate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/compose/test [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"检测 compose [name] 格式","formatEN":"check compose [name]"}

func (*BaseApi) UpdateAddrRule ¶ added in v1.1.0

func (b *BaseApi) UpdateAddrRule(c *gin.Context)

@Tags Firewall @Summary Create group @Description 更新 ip 防火墙规则 @Accept json @Param request body dto.AddrRuleUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/update/addr [post]

func (*BaseApi) UpdateAntiLeech ¶ added in v1.3.0

func (b *BaseApi) UpdateAntiLeech(c *gin.Context)

@Tags Website @Summary Update AntiLeech @Description 更新防盗链配置 @Accept json @Param request body request.NginxAntiLeechUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/leech/update [post]

func (*BaseApi) UpdateAuthConfig ¶ added in v1.2.0

func (b *BaseApi) UpdateAuthConfig(c *gin.Context)

@Tags Website @Summary Get AuthBasic conf @Description 更新密码访问配置 @Accept json @Param request body request.NginxAuthUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/auths/update [post]

func (*BaseApi) UpdateBackup ¶

func (b *BaseApi) UpdateBackup(c *gin.Context)

@Tags Backup Account @Summary Update backup account @Description 更新备份账号信息 @Accept json @Param request body dto.BackupOperate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/backup/update [post] @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新备份账号 [types]","formatEN":"update backup account [types]"}

func (*BaseApi) UpdateBindInfo ¶ added in v1.8.0

func (b *BaseApi) UpdateBindInfo(c *gin.Context)

@Tags System Setting @Summary Update system bind info @Description 更新系统监听信息 @Accept json @Param request body dto.BindInfo true "request" @Success 200 @Security ApiKeyAuth @Router /settings/bind/update [post] @x-panel-log {"bodyKeys":["ipv6", "bindAddress"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统监听信息 => ipv6: [ipv6], 监听 IP: [bindAddress]","formatEN":"update system bind info => ipv6: [ipv6], 监听 IP: [bindAddress]"}

func (*BaseApi) UpdateCommand ¶

func (b *BaseApi) UpdateCommand(c *gin.Context)

@Tags Command @Summary Update command @Description 更新快速命令 @Accept json @Param request body dto.CommandOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/command/update [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新快捷命令 [name]","formatEN":"update quick command [name]"}

func (*BaseApi) UpdateComposeTemplate ¶

func (b *BaseApi) UpdateComposeTemplate(c *gin.Context)

@Tags Container Compose-template @Summary Update compose template @Description 更新容器编排模版 @Accept json @Param request body dto.ComposeTemplateUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/template/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"compose_templates","output_column":"name","output_value":"name"}],"formatZH":"更新 compose 模版 [name]","formatEN":"update compose template information [name]"}

func (*BaseApi) UpdateCronjob ¶

func (b *BaseApi) UpdateCronjob(c *gin.Context)

@Tags Cronjob @Summary Update cronjob @Description 更新计划任务 @Accept json @Param request body dto.CronjobUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"cronjobs","output_column":"name","output_value":"name"}],"formatZH":"更新计划任务 [name]","formatEN":"update cronjob [name]"}

func (*BaseApi) UpdateCronjobStatus ¶

func (b *BaseApi) UpdateCronjobStatus(c *gin.Context)

@Tags Cronjob @Summary Update cronjob status @Description 更新计划任务状态 @Accept json @Param request body dto.CronjobUpdateStatus true "request" @Success 200 @Security ApiKeyAuth @Router /cronjobs/status [post] @x-panel-log {"bodyKeys":["id","status"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"cronjobs","output_column":"name","output_value":"name"}],"formatZH":"修改计划任务 [name] 状态为 [status]","formatEN":"change the status of cronjob [name] to [status]."}

func (*BaseApi) UpdateDBConfByFile ¶ added in v1.9.3

func (b *BaseApi) UpdateDBConfByFile(c *gin.Context)

@Tags Database Common @Summary Update conf by upload file @Description 上传替换配置文件 @Accept json @Param request body dto.DBConfUpdateByFile true "request" @Success 200 @Security ApiKeyAuth @Router /databases/common/update/conf [post] @x-panel-log {"bodyKeys":["type","database"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 [type] 数据库 [database] 配置信息","formatEN":"update the [type] [database] database configuration information"}

func (*BaseApi) UpdateDaemonJson ¶

func (b *BaseApi) UpdateDaemonJson(c *gin.Context)

@Tags Container Docker @Summary Update docker daemon.json @Description 修改 docker 配置信息 @Accept json @Param request body dto.SettingUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /containers/daemonjson/update [post] @x-panel-log {"bodyKeys":["key", "value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 docker daemon.json 配置 [key]=>[value]","formatEN":"Updated the docker daemon.json configuration [key]=>[value]"}

func (*BaseApi) UpdateDaemonJsonByFile ¶

func (b *BaseApi) UpdateDaemonJsonByFile(c *gin.Context)

@Tags Container Docker @Summary Update docker daemon.json by upload file @Description 上传替换 docker 配置文件 @Accept json @Param request body dto.DaemonJsonUpdateByFile true "request" @Success 200 @Security ApiKeyAuth @Router /containers/daemonjson/update/byfile [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 docker daemon.json 配置","formatEN":"Updated the docker daemon.json configuration"}

func (*BaseApi) UpdateDatabase ¶ added in v1.6.0

func (b *BaseApi) UpdateDatabase(c *gin.Context)

@Tags Database @Summary Update database @Description 更新远程数据库 @Accept json @Param request body dto.DatabaseUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/db/update [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新远程数据库 [name]","formatEN":"update database [name]"}

func (*BaseApi) UpdateDeviceByFile ¶ added in v1.9.0

func (b *BaseApi) UpdateDeviceByFile(c *gin.Context)

@Tags Device @Summary Update device conf by file @Description 通过文件修改配置 @Accept json @Param request body dto.UpdateByNameAndFile true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/update/byconf [post]

func (*BaseApi) UpdateDeviceConf ¶ added in v1.9.0

func (b *BaseApi) UpdateDeviceConf(c *gin.Context)

@Tags Device @Summary Update device @Description 修改系统参数 @Accept json @Param request body dto.SettingUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/update/conf [post] @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改主机参数 [key] => [value]","formatEN":"update device conf [key] => [value]"}

func (*BaseApi) UpdateDeviceHost ¶ added in v1.9.0

func (b *BaseApi) UpdateDeviceHost(c *gin.Context)

@Tags Device @Summary Update device hosts @Description 修改系统 hosts @Success 200 @Security ApiKeyAuth @Router /toolbox/device/update/host [post] @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改主机 Host [key] => [value]","formatEN":"update device host [key] => [value]"}

func (*BaseApi) UpdateDevicePasswd ¶ added in v1.9.0

func (b *BaseApi) UpdateDevicePasswd(c *gin.Context)

@Tags Device @Summary Update device passwd @Description 修改系统密码 @Accept json @Param request body dto.ChangePasswd true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/update/passwd [post]

func (*BaseApi) UpdateDeviceSwap ¶ added in v1.9.0

func (b *BaseApi) UpdateDeviceSwap(c *gin.Context)

@Tags Device @Summary Update device swap @Description 修改系统 Swap @Accept json @Param request body dto.SwapHelper true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/device/update/swap [post] @x-panel-log {"bodyKeys":["operate","path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"[operate] 主机 swap path","formatEN":"[operate] device swap path"}

func (*BaseApi) UpdateFail2BanConf ¶ added in v1.9.0

func (b *BaseApi) UpdateFail2BanConf(c *gin.Context)

@Tags Fail2ban @Summary Update fail2ban conf @Description 修改 Fail2ban 配置 @Accept json @Param request body dto.Fail2BanUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/fail2ban/update [post] @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改 Fail2ban 配置 [key] => [value]","formatEN":"update fail2ban conf [key] => [value]"}

func (*BaseApi) UpdateFail2BanConfByFile ¶ added in v1.9.0

func (b *BaseApi) UpdateFail2BanConfByFile(c *gin.Context)

@Tags Fail2ban @Summary Update fail2ban conf by file @Description 通过文件修改 fail2ban 配置 @Accept json @Param request body dto.UpdateByFile true "request" @Success 200 @Security ApiKeyAuth @Router /toolbox/fail2ban/update/byconf [post]

func (*BaseApi) UpdateFirewallDescription ¶ added in v1.6.0

func (b *BaseApi) UpdateFirewallDescription(c *gin.Context)

@Tags Firewall @Summary Update rule description @Description 更新防火墙描述 @Accept json @Param request body dto.UpdateFirewallDescription true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/update/description [post]

func (*BaseApi) UpdateGroup ¶

func (b *BaseApi) UpdateGroup(c *gin.Context)

@Tags System Group @Summary Update group @Description 更新系统组 @Accept json @Param request body dto.GroupUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /groups/update [post] @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新组 [name][type]","formatEN":"update group [name][type]"}

func (*BaseApi) UpdateHTTPSConfig ¶

func (b *BaseApi) UpdateHTTPSConfig(c *gin.Context)

@Tags Website HTTPS @Summary Update https conf @Description 更新 https 配置 @Accept json @Param request body request.WebsiteHTTPSOp true "request" @Success 200 {object} response.WebsiteHTTPS @Security ApiKeyAuth @Router /websites/:id/https [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新网站 [domain] https 配置","formatEN":"Update website https [domain] conf"}

func (*BaseApi) UpdateHost ¶

func (b *BaseApi) UpdateHost(c *gin.Context)

@Tags Host @Summary Update host @Description 更新主机 @Accept json @Param request body dto.HostOperate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/update [post] @x-panel-log {"bodyKeys":["name","addr"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新主机信息 [name][addr]","formatEN":"update host [name][addr]"}

func (*BaseApi) UpdateHostGroup ¶

func (b *BaseApi) UpdateHostGroup(c *gin.Context)

@Tags Host @Summary Update host group @Description 切换分组 @Accept json @Param request body dto.ChangeHostGroup true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/update/group [post] @x-panel-log {"bodyKeys":["id","group"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"hosts","output_column":"addr","output_value":"addr"}],"formatZH":"切换主机[addr]分组 => [group]","formatEN":"change host [addr] group => [group]"}

func (*BaseApi) UpdateInstalled ¶

func (b *BaseApi) UpdateInstalled(c *gin.Context)

@Tags App @Summary Change app params @Description 修改应用参数 @Accept json @Param request body request.AppInstalledUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /apps/installed/params/update [post] @x-panel-log {"bodyKeys":["installId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用参数修改 [installId]","formatEN":"Application param update [installId]"}

func (*BaseApi) UpdateIpv6Option ¶ added in v1.9.0

func (b *BaseApi) UpdateIpv6Option(c *gin.Context)

@Tags Container Docker @Summary Update docker daemon.json ipv6 option @Description 修改 docker ipv6 配置 @Accept json @Param request body dto.LogOption true "request" @Success 200 @Security ApiKeyAuth @Router /containers/ipv6option/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 docker daemon.json ipv6 配置","formatEN":"Updated the docker daemon.json ipv6 option"}

func (*BaseApi) UpdateLogOption ¶ added in v1.3.0

func (b *BaseApi) UpdateLogOption(c *gin.Context)

@Tags Container Docker @Summary Update docker daemon.json log option @Description 修改 docker 日志配置 @Accept json @Param request body dto.LogOption true "request" @Success 200 @Security ApiKeyAuth @Router /containers/logoption/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 docker daemon.json 日志配置","formatEN":"Updated the docker daemon.json log option"}

func (*BaseApi) UpdateMysqlDescription ¶

func (b *BaseApi) UpdateMysqlDescription(c *gin.Context)

@Tags Database Mysql @Summary Update mysql database description @Description 更新 mysql 数据库库描述信息 @Accept json @Param request body dto.UpdateDescription true "request" @Success 200 @Security ApiKeyAuth @Router /databases/description/update [post] @x-panel-log {"bodyKeys":["id","description"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_mysqls","output_column":"name","output_value":"name"}],"formatZH":"mysql 数据库 [name] 描述信息修改 [description]","formatEN":"The description of the mysql database [name] is modified => [description]"}

func (*BaseApi) UpdateMysqlVariables ¶

func (b *BaseApi) UpdateMysqlVariables(c *gin.Context)

@Tags Database Mysql @Summary Update mysql variables @Description mysql 性能调优 @Accept json @Param request body dto.MysqlVariablesUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/variables/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"调整 mysql 数据库性能参数","formatEN":"adjust mysql database performance parameters"}

func (*BaseApi) UpdateNginxConfig ¶

func (b *BaseApi) UpdateNginxConfig(c *gin.Context)

@Tags Website Nginx @Summary Update nginx conf @Description 更新 nginx 配置 @Accept json @Param request body request.NginxConfigUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/config/update [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"nginx 配置修改 [domain]","formatEN":"Nginx conf update [domain]"}

func (*BaseApi) UpdateNginxConfigByScope ¶

func (b *BaseApi) UpdateNginxConfigByScope(c *gin.Context)

@Tags OpenResty @Summary Update OpenResty conf @Description 更新 OpenResty 配置信息 @Accept json @Param request body request.NginxConfigUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /openresty/update [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新 nginx 配置 [domain]","formatEN":"Update nginx conf [domain]"}

func (*BaseApi) UpdateNginxFile ¶

func (b *BaseApi) UpdateNginxFile(c *gin.Context)

@Tags OpenResty @Summary Update OpenResty conf by upload file @Description 上传更新 OpenResty 配置文件 @Accept json @Param request body request.NginxConfigFileUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /openresty/file [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 nginx 配置","formatEN":"Update nginx conf"}

func (*BaseApi) UpdatePHPExtensions ¶ added in v1.9.3

func (b *BaseApi) UpdatePHPExtensions(c *gin.Context)

@Tags PHP Extensions @Summary Update Extensions @Description Update Extensions @Accept json @Param request body request.PHPExtensionsUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/php/extensions/update [post]

func (*BaseApi) UpdatePHPFile ¶ added in v1.1.0

func (b *BaseApi) UpdatePHPFile(c *gin.Context)

@Tags Website PHP @Summary Update php conf @Description 更新 php 配置文件 @Accept json @Param request body request.WebsitePHPFileUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/php/update [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"php 配置修改 [domain]","formatEN":"Nginx conf update [domain]"}

func (*BaseApi) UpdatePassword ¶

func (b *BaseApi) UpdatePassword(c *gin.Context)

@Tags System Setting @Summary Update system password @Description 更新系统登录密码 @Accept json @Param request body dto.PasswordUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/password/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统密码","formatEN":"update system password"}

func (*BaseApi) UpdatePort ¶

func (b *BaseApi) UpdatePort(c *gin.Context)

@Tags System Setting @Summary Update system port @Description 更新系统端口 @Accept json @Param request body dto.PortUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/port/update [post] @x-panel-log {"bodyKeys":["serverPort"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统端口 => [serverPort]","formatEN":"update system port => [serverPort]"}

func (*BaseApi) UpdatePortRule ¶ added in v1.1.0

func (b *BaseApi) UpdatePortRule(c *gin.Context)

@Tags Firewall @Summary Create group @Description 更新端口防火墙规则 @Accept json @Param request body dto.PortRuleUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /hosts/firewall/update/port [post]

func (*BaseApi) UpdatePostgresqlDescription ¶ added in v1.9.3

func (b *BaseApi) UpdatePostgresqlDescription(c *gin.Context)

@Tags Database Postgresql @Summary Update postgresql database description @Description 更新 postgresql 数据库库描述信息 @Accept json @Param request body dto.UpdateDescription true "request" @Success 200 @Security ApiKeyAuth @Router /databases/pg/description [post] @x-panel-log {"bodyKeys":["id","description"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"database_postgresqls","output_column":"name","output_value":"name"}],"formatZH":"postgresql 数据库 [name] 描述信息修改 [description]","formatEN":"The description of the postgresql database [name] is modified => [description]"}

func (*BaseApi) UpdateProxyConfig ¶ added in v1.2.0

func (b *BaseApi) UpdateProxyConfig(c *gin.Context)

@Tags Website @Summary Update proxy conf @Description 修改反向代理配置 @Accept json @Param request body request.WebsiteProxyConfig true "request" @Success 200 @Security ApiKeyAuth @Router /websites/proxies/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"修改网站 [domain] 反向代理配置 ","formatEN":"Update domain [domain] proxy config"}

func (*BaseApi) UpdateProxyConfigFile ¶ added in v1.2.0

func (b *BaseApi) UpdateProxyConfigFile(c *gin.Context)

@Tags Website @Summary Update proxy file @Description 更新反向代理文件 @Accept json @Param request body request.NginxProxyUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/proxy/file [post] @x-panel-log {"bodyKeys":["websiteID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteID","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新反向代理文件 [domain]","formatEN":"Nginx conf proxy file update [domain]"}

func (*BaseApi) UpdateRedirectConfig ¶ added in v1.5.0

func (b *BaseApi) UpdateRedirectConfig(c *gin.Context)

@Tags Website @Summary Update redirect conf @Description 修改重定向配置 @Accept json @Param request body request.NginxRedirectReq true "request" @Success 200 @Security ApiKeyAuth @Router /websites/redirect/update [post] @x-panel-log {"bodyKeys":["websiteID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteID","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"修改网站 [domain] 重定向理配置 ","formatEN":"Update domain [domain] redirect config"}

func (*BaseApi) UpdateRedirectConfigFile ¶ added in v1.5.0

func (b *BaseApi) UpdateRedirectConfigFile(c *gin.Context)

@Tags Website @Summary Update redirect file @Description 更新重定向文件 @Accept json @Param request body request.NginxRedirectUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/redirect/file [post] @x-panel-log {"bodyKeys":["websiteID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteID","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新重定向文件 [domain]","formatEN":"Nginx conf redirect file update [domain]"}

func (*BaseApi) UpdateRedisConf ¶

func (b *BaseApi) UpdateRedisConf(c *gin.Context)

@Tags Database Redis @Summary Update redis conf @Description 更新 redis 配置信息 @Accept json @Param request body dto.RedisConfUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/redis/conf/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 redis 数据库配置信息","formatEN":"update the redis database configuration information"}

func (*BaseApi) UpdateRedisPersistenceConf ¶

func (b *BaseApi) UpdateRedisPersistenceConf(c *gin.Context)

@Tags Database Redis @Summary Update redis persistence conf @Description 更新 redis 持久化配置 @Accept json @Param request body dto.RedisConfPersistenceUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /databases/redis/persistence/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"redis 数据库持久化配置更新","formatEN":"redis database persistence configuration update"}

func (*BaseApi) UpdateRepo ¶

func (b *BaseApi) UpdateRepo(c *gin.Context)

@Tags Container Image-repo @Summary Update image repo @Description 更新镜像仓库 @Accept json @Param request body dto.ImageRepoUpdate true "request" @Produce json @Success 200 @Security ApiKeyAuth @Router /containers/repo/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"image_repos","output_column":"name","output_value":"name"}],"formatZH":"更新镜像仓库 [name]","formatEN":"update image repo information [name]"}

func (*BaseApi) UpdateRewriteConfig ¶ added in v1.1.1

func (b *BaseApi) UpdateRewriteConfig(c *gin.Context)

@Tags Website @Summary Update rewrite conf @Description 更新伪静态配置 @Accept json @Param request body request.NginxRewriteUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/rewrite/update [post] @x-panel-log {"bodyKeys":["websiteID"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteID","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"伪静态配置修改 [domain]","formatEN":"Nginx conf rewrite update [domain]"}

func (*BaseApi) UpdateRuntime ¶ added in v1.1.0

func (b *BaseApi) UpdateRuntime(c *gin.Context)

@Tags Runtime @Summary Update runtime @Description 更新运行环境 @Accept json @Param request body request.RuntimeUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /runtimes/update [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新运行环境 [name]","formatEN":"Update runtime [name]"}

func (*BaseApi) UpdateSSH ¶ added in v1.3.0

func (b *BaseApi) UpdateSSH(c *gin.Context)

@Tags SSH @Summary Update host SSH setting @Description 更新 SSH 配置 @Accept json @Param request body dto.SSHUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /host/ssh/update [post] @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改 SSH 配置 [key] => [value]","formatEN":"update SSH setting [key] => [value]"}

func (*BaseApi) UpdateSSHByfile ¶ added in v1.3.0

func (b *BaseApi) UpdateSSHByfile(c *gin.Context)

@Tags SSH @Summary Update host SSH setting by file @Description 上传文件更新 SSH 配置 @Accept json @Param request body dto.SSHConf true "request" @Success 200 @Security ApiKeyAuth @Router /host/conffile/update [post] @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改 SSH 配置文件","formatEN":"update SSH conf"}

func (*BaseApi) UpdateSSL ¶ added in v1.2.0

func (b *BaseApi) UpdateSSL(c *gin.Context)

@Tags System Setting @Summary Update system ssl @Description 修改系统 ssl 登录 @Accept json @Param request body dto.SSLUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/ssl/update [post] @x-panel-log {"bodyKeys":["ssl"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统 ssl => [ssl]","formatEN":"update system ssl => [ssl]"}

func (*BaseApi) UpdateSetting ¶

func (b *BaseApi) UpdateSetting(c *gin.Context)

@Tags System Setting @Summary Update system setting @Description 更新系统配置 @Accept json @Param request body dto.SettingUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /settings/update [post] @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统配置 [key] => [value]","formatEN":"update system setting [key] => [value]"}

func (*BaseApi) UpdateSiteDir ¶ added in v1.1.1

func (b *BaseApi) UpdateSiteDir(c *gin.Context)

@Tags Website @Summary Update Site Dir @Description 更新网站目录 @Accept json @Param request body request.WebsiteUpdateDir true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dir/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新网站 [domain] 目录","formatEN":"Update domain [domain] dir"}

func (*BaseApi) UpdateSiteDirPermission ¶ added in v1.1.1

func (b *BaseApi) UpdateSiteDirPermission(c *gin.Context)

@Tags Website @Summary Update Site Dir permission @Description 更新网站目录权限 @Accept json @Param request body request.WebsiteUpdateDirPermission true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dir/permission [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新网站 [domain] 目录权限","formatEN":"Update domain [domain] dir permission"}

func (*BaseApi) UpdateSnapDescription ¶

func (b *BaseApi) UpdateSnapDescription(c *gin.Context)

@Tags System Setting @Summary Update snapshot description @Description 更新快照描述信息 @Accept json @Param request body dto.UpdateDescription true "request" @Success 200 @Security ApiKeyAuth @Router /settings/snapshot/description/update [post] @x-panel-log {"bodyKeys":["id","description"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"snapshots","output_column":"name","output_value":"name"}],"formatZH":"快照 [name] 描述信息修改 [description]","formatEN":"The description of the snapshot [name] is modified => [description]"}

func (*BaseApi) UpdateWebsite ¶

func (b *BaseApi) UpdateWebsite(c *gin.Context)

@Tags Website @Summary Update website @Description 更新网站 @Accept json @Param request body request.WebsiteUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/update [post] @x-panel-log {"bodyKeys":["primaryDomain"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新网站 [primaryDomain]","formatEN":"Update website [primaryDomain]"}

func (*BaseApi) UpdateWebsiteDnsAccount ¶

func (b *BaseApi) UpdateWebsiteDnsAccount(c *gin.Context)

@Tags Website DNS @Summary Update website dns account @Description 更新网站 dns @Accept json @Param request body request.WebsiteDnsAccountUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/dns/update [post] @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新网站 dns [name]","formatEN":"Update website dns [name]"}

func (*BaseApi) UpdateWebsiteNginxConfig ¶

func (b *BaseApi) UpdateWebsiteNginxConfig(c *gin.Context)

@Tags Website Nginx @Summary Update website nginx conf @Description 更新 网站 nginx 配置 @Accept json @Param request body request.WebsiteNginxUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/nginx/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"[domain] Nginx 配置修改","formatEN":"[domain] Nginx conf update"}

func (*BaseApi) UpdateWebsitePHPConfig ¶ added in v1.1.0

func (b *BaseApi) UpdateWebsitePHPConfig(c *gin.Context)

@Tags Website PHP @Summary Update website php conf @Description 更新 网站 PHP 配置 @Accept json @Param request body request.WebsitePHPConfigUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/php/config [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"[domain] PHP 配置修改","formatEN":"[domain] PHP conf update"}

func (*BaseApi) UpdateWebsiteSSL ¶ added in v1.0.3

func (b *BaseApi) UpdateWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Update ssl @Description 更新 ssl @Accept json @Param request body request.WebsiteSSLUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/update [post] @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"website_ssls","output_column":"primary_domain","output_value":"domain"}],"formatZH":"更新证书设置 [domain]","formatEN":"Update ssl config [domain]"}

func (*BaseApi) UpdateWebsiteWafConfig ¶

func (b *BaseApi) UpdateWebsiteWafConfig(c *gin.Context)

@Tags Website WAF @Summary Update website waf conf @Description 更新 网站 waf 配置 @Accept json @Param request body request.WebsiteWafUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/waf/update [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"WAF 配置修改 [domain]","formatEN":"WAF conf update [domain]"}

func (*BaseApi) UpdateWebsiteWafFile ¶ added in v1.5.0

func (b *BaseApi) UpdateWebsiteWafFile(c *gin.Context)

@Tags Website WAF @Summary Update website waf file @Description 更新 网站 waf 配置文件 @Accept json @Param request body request.WebsiteWafUpdate true "request" @Success 200 @Security ApiKeyAuth @Router /websites/waf/file/update [post] @x-panel-log {"bodyKeys":["websiteId"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"websiteId","isList":false,"db":"websites","output_column":"primary_domain","output_value":"domain"}],"formatZH":"WAF 配置文件修改 [domain]","formatEN":"WAF conf file update [domain]"}

func (*BaseApi) Upgrade ¶

func (b *BaseApi) Upgrade(c *gin.Context)

@Tags System Setting @Summary Upgrade @Description 系统更新 @Accept json @Param request body dto.Upgrade true "request" @Success 200 @Security ApiKeyAuth @Router /settings/upgrade [post] @x-panel-log {"bodyKeys":["version"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新系统 => [version]","formatEN":"upgrade system => [version]"}

func (*BaseApi) UploadChunkFiles ¶

func (b *BaseApi) UploadChunkFiles(c *gin.Context)

@Tags File @Summary ChunkUpload file @Description 分片上传文件 @Param file formData file true "request" @Success 200 @Security ApiKeyAuth @Router /files/chunkupload [post]

func (*BaseApi) UploadFiles ¶

func (b *BaseApi) UploadFiles(c *gin.Context)

@Tags File @Summary Upload file @Description 上传文件 @Param file formData file true "request" @Success 200 @Security ApiKeyAuth @Router /files/upload [post] @x-panel-log {"bodyKeys":["path"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"上传文件 path","formatEN":"Upload file path"}

func (*BaseApi) UploadWebsiteSSL ¶ added in v1.8.0

func (b *BaseApi) UploadWebsiteSSL(c *gin.Context)

@Tags Website SSL @Summary Upload ssl @Description 上传 ssl @Accept json @Param request body request.WebsiteSSLUpload true "request" @Success 200 @Security ApiKeyAuth @Router /websites/ssl/upload [post] @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"上传 ssl [type]","formatEN":"Upload ssl [type]"}

func (*BaseApi) WgetFile ¶

func (b *BaseApi) WgetFile(c *gin.Context)

@Tags File @Summary Wget file @Description 下载远端文件 @Accept json @Param request body request.FileWget true "request" @Success 200 @Security ApiKeyAuth @Router /files/wget [post] @x-panel-log {"bodyKeys":["url","path","name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"下载 url => path/[name]","formatEN":"Download url => path/[name]"}

func (*BaseApi) Ws ¶

func (b *BaseApi) Ws(c *gin.Context)

func (*BaseApi) WsSsh ¶

func (b *BaseApi) WsSsh(c *gin.Context)