🌟 本文档由
麒曦Chish
整理发布,与官方无关,不代表官方立场,仅供参考,请以官方发布为准。
Dashboard
复制页面
1Panel v2 API
1Panel API 接口调用文档
Auth
生成 API 密钥
POST
更新 API 配置
POST
加载验证码
GET
加载当前用户信息
GET
更新当前用户信息
POST
重置系统密码过期
POST
用户登录
POST
用户登出
POST
使用 MFA 登录
POST
使用 Passkey 登录
POST
删除 Passkey
POST
使用 Passkey 登录
POST
列出 Passkey
GET
开始 Passkey 注册
POST
完成 Passkey 注册
POST
获取登录设置
GET
获取欢迎页面
GET
Dashboard
加载应用启动器
GET
加载应用启动器选项
POST
更新应用启动器
POST
加载概览基础信息
GET
加载操作系统信息
GET
加载概览实时信息
GET
加载节点概览实时信息
GET
加载 CPU 占用最高的进程
GET
加载内存占用最高的进程
GET
更新快速跳转
POST
加载快速跳转选项
GET
重启系统
POST
App
通过 key 查询应用
获取应用列表更新
通过 appid 查询应用详情
通过 appkey 和版本查询应用详情
根据 ID 获取应用详情
根据 app_id 获取应用图标
取消忽略应用升级
列出忽略升级应用
安装应用
检查应用是否已安装
根据 key 查询默认配置
更新应用配置
根据 key 查询应用密码
删除前检查
忽略升级应用
获取应用安装信息
列出已安装应用
根据 key 查询应用端口
操作已安装应用
根据 appInstallId 查询参数
修改应用参数
修改应用端口
分页查询已安装应用
更新应用安装排序
同步已安装应用
根据安装 ID 查询应用更新版本
列出应用
根据 key 查询应用服务
同步本地应用列表
同步远程应用列表
获取应用标签
获取应用商店配置
更新应用商店配置
OpenResty
加载 OpenResty 配置
构建 OpenResty
通过上传文件更新 OpenResty 配置
获取默认 HTTPS 状态
操作默认 HTTPS
获取 OpenResty 模块
更新 OpenResty 模块
加载部分 OpenResty 配置
加载 OpenResty 状态信息
更新 OpenResty 配置
Website
SSL
创建网站 SSL
根据 ID 查询网站 SSL
删除网站 SSL
下载 SSL 文件
导入主节点 SSL
列出网站 SSL
申请 SSL
推送 SSL 到节点
解析网站 SSL
分页查询网站 SSL
更新 SSL
上传 SSL
上传 SSL 文件
根据网站 ID 查询网站 SSL
Template
创建网站模板
删除网站模板
获取网站模板
创建网站模板输出
删除网站模板输出
获取网站模板输出
分页查询网站模 板输出
预览网站模板
分页查询网站模板
更新网站模板
上传网站模板 zip
CA
创建网站 CA
删除网站 CA
下载 CA 文件
获取 SSL
获取 SSL
分页查询网站 CA
获取网站 CA
Acme
创建网站 ACME 账号
删除网站 ACME 账号
分页查询网站 ACME 账号
更新网站 ACME 账号
DNS
创建网站 DNS 账号
删除网站 DNS 账号
分页查询网站 DNS 账号
更新网站 DNS 账号
Domain
创建网站域名
根据 websiteId 查询网站域名
删除网站域名
更新网站域名
Nginx
根据 ID 查询网站 Nginx
加载 Nginx 配置
更新 Nginx 配置
更新网站 nginx 配置
HTTPS
加载 HTTPS 配置
更新 HTTPS 配置
PHP
更新 PHP 版本
删除运行环境
删除运行环境
创建网站
根据 ID 查询网站
获取 AuthBasic 配置
获取 AuthBasic 配置
获取 AuthBasic 配置
获取 AuthBasic 配置
批量设置网站分组
批量操作网站
批量设置网站 HTTPS
创建网站前检查
更新 CORS 配置
获取 CORS 配置
操作跨站访问
获取数据库
修改网站数据库
获取默认 HTML
更新默认 HTML
修改默认服务器
删除网站
获取网站目录
更新网站目录权限
更新网站目录
执行 Composer
修改网站分组
创建网站上游
删除网站上游
更新网站上游文件
更新网站上游
获取防盗链配置
更新防盗链
列出网站
操作网站日志
获取网站日志
操作网站
列出网站名称
获取反向代理配置
删除代理配置
更新代理文件
更新代理配置状态
更新代理配置
清除网站代理缓存
更新网站代理缓存配置
获取网站代理缓存配置
设置真实 IP
获取真实 IP 配置
获取重定向配置
更新重定向文件
更新重定向配置
获取网站资源
获取伪静态配置
列出自定义重写规则
操作自定义重写
更新重写配置
分页查询网站
更新 Stream 配置
更新网站
获取网站上游
PHP Extensions
创建扩展
删除扩展
分页查询扩展
更新扩展
AI
创建模型账号
按提供商统计模型账号
删除模型账号
列出模型账号模型
创建模型账号模型
删除模型账号模型
发现自定义提供商模型
更新模型账号模型
获取模型账号提供商
分页查询模型账号
更新模型账号
验证模型账号
创建智能体
绑定智能体角色渠道
从配置文件获取智能体角色渠道
创建智能体角色
删除智能体角色
从配置文件获取已配置的智能体角色
获取智能体角色 Markdown 文件
更新智能体角色 Markdown 文件
解绑智能体角色渠道
批量安装智能体
批量操作智能体
批量安装智能体技能
批量升级智能体
删除智能体渠道配置
获取智能体钉钉渠道配置
更新智能体钉钉渠道配置
获取智能体 Discord 渠道配置
更新智能体 Discord 渠道配置
获取智能体飞书渠道配置
更新智能体飞书渠道配置
批准智能体渠道配对码
获取智能体 QQ 机器人渠道配置
更新智能体 QQ 机器人渠道配置
获取智能体 Telegram 渠道配置
更新智能体 Telegram 渠道配置
获取智能体 QQ 机器人渠道配置
更新智能体企业微信渠道配置
获取智能体微信渠道配置
登录智能体微信渠道
获取智能体配置文件
更新智能体配置文件
删除 智能体
删除前检查智能体
获取 Hermes 会话
删除 Hermes 聊天会话
重命名 Hermes 聊天会话
获取智能体模型配置
更新智能体模型配置
获取智能体其他配置
更新智能体其他配置
获取智能体概览
检查智能体插件安装状态
安装智能体插件
卸载智能体插件
升级智能体插件
安装 OpenClaw 市场插件
列出 OpenClaw 插件
操作 OpenClaw 插件
查询 OpenClaw 插件
更新智能体备注
分页查询智能体
获取智能体安全配置
更新智能体安全配置
安装智能体技能
列出智能体技能
查询智能体技能
卸载智能体技能
更新智能体技能状态
重置智能体 Token
绑定智能体网站
解绑智能体网站
绑定域名
获取绑定域名
更新绑定域名
加载 GPU / XPU 信息
获取 CPU 选项
关闭 Ollama 模型连接
创建 Ollama 模型
删除 Ollama 模型
分页查询 Ollama 模型
重建 Ollama 模型
分页查询 Ollama 模型
同步 Ollama 模型列表
Database
Mysql
创建 MySQL 数据库
修改 MySQL root 访问权限
修改 MySQL root 密码
删除 MySQL 数据库
删除 MySQL 数据库前检查
更新 MySQL 数据库描述
列出 MySQL 数据库格式排序规则选项
授权 MySQL 用户
撤销 MySQL 授权
列出 MySQL 授权
列出 MySQL 授权概要
从远程加载 MySQL 数据库
加载 MySQL 远程访问
分页查询 MySQL 数据库
加载 MySQL 状态信息
创建 MySQL 用户
删除 MySQL 用户
修改 MySQL 用户密码
保存 MySQL 用户密码到本地
列出 MySQL 用户
更新 MySQL 用户
加载 MySQL 变量信息
更新 MySQL 变量
PostgreSQL
创建 PostgreSQL 数据库
从远程加载 PostgreSQL 数据库
绑定 PostgreSQL 用户
删除 PostgreSQL 数据库
删除 PostgreSQL 数据库前检查
更新 PostgreSQL 数据库描述
修改 PostgreSQL 密码
修改 PostgreSQL 权限
分页查询 PostgreSQL 数据库
Mongodb
创建 MongoDB 数据库
绑定 MongoDB 数据库用户信息
删除 MongoDB 数据库
删除 MongoDB 数据库前检查
更新 MongoDB 数据库描述
从远程加载 MongoDB 数据库
修改 MongoDB 数据库密码
加载 MongoDB 权限
修改 MongoDB 权限
修改 MongoDB root 密码
分页查询 MongoDB 数据库
Redis
检查是否存在 CLI
加载 Redis 配置
更新 Redis 配置
安装 redis-cli
修改 Redis 密码
加载 Redis 持久化配置
更新 Redis 持久化配置
加载 Redis 状态信息
Common
加载基础信息
加载数据库配置
上传文件更新配置
创建数据库
获取数据库
检查数据库
删除数据库
删除远程数 据库前检查
列出数据库
列出数据库
分页查询数据库
更新数据库
Container
Image
加载镜像选项
列出所有镜像
构建镜像
加载镜像
拉取镜像
推送镜像
删除镜像
保存镜像
分页查询镜像
标记镜像
Docker
加载 Docker daemon.json
加载 Docker daemon.json
更新 Docker daemon.json
上传文件更新 Docker daemon.json
操作 Docker
加载 Docker 状态
更新 Docker daemon.json IPv6 配置
更新 Docker daemon.json 日志配置
Compose
创建编排
加载编排环境变量
操作编排
置顶编排
分页查询编排
测试编排
更新编排
Compose-template
列出编排模板
创建编排模板
批量创建编排模板
删除编排模板
分页查询编排模板
更新编排模板
Image-repo
列出镜像仓库
创建镜像仓库
删除镜像仓库
分页查询镜像仓库
加载仓库状态
更新镜像仓库
Network
列出网络
创建网络
删除网络
分页查询网络
Volume
列出存储卷
创建存储卷
删除存储卷
分页查询存储卷
创建容器
清理容器日志
提交容器
清理编排日志
下载容器日志
获取容器文件内容
删除容器文件
下载容器文件
列出容器文件
获取容器文件大小
上传容器文件
加载容器信息
容器详情
加载容器监控数据大小
加载容器资源限制
列出容器
按镜像列出容器
加载容器监控数据
操作容器
清理容器
重命名容器
分页查询容器
容器日志
容器统计
加载容器状态
更新容器
升级容器
加载容器用户
File
创建文件
文件搜索:内容 grep + 可选 AI 摘要
批量检查文件是否存在
批量删除文件
批量修改文件权限和所有者
检查文件是否存在
分块下载文件
分块上传文件
压缩文件
停止压缩任务
加载文件内容
转换文件
转换文件
解压文件
停止解压任务
删除文件
多文件大小
下载文件
创建收藏夹
删除收藏夹
列出收藏夹
加载文件历史内容
删除文件历史记录
恢复文件历史记录
加载文件历史列表
修改文件权限
加载系统挂载信息
移动文件
停止文件移动任务
修改文件所有者
预览文件内容
按行读取文件
清除回收站文件
缩减回收站文件
列出回收站文件
获取回收站状态
设置文件备注
批量获取文件备注
修改文件名
更新文件内容
列出文件
检查文件分享码 (免登录)
创建临时文件分享链接
根据路径删除文件分享
根据路径获取文件分享详情
通过分享码下载文件(免登录)
根据提取码获取文件分享详情(免登录)
获取文件分享二维码图片
列出文件分享
加载文件大小
加载文件树
上传文件
分页查询文件
系统用户和用户组
Wget 文件
Wget 进程
处理密钥
停止 wget 文件下载
Monitor
加载监控数据
清理监控数据
获取 IO 选项
获取网络选项
加载监控数据
加载监控设置
更新监控设置
Firewall
加载防火墙基础信息
操作 Docker 端口防护
批量新增或更新 Docker 端口防护策略
删除 Docker 端口防护策略
列出 Docker 端口防护状态和策略
同步 Docker 端口防护规则
应用/卸载/初始化防火墙过滤链
加载端口转发基础信息
启用转发
操作转发规则
分页查询转发规则
操作防火墙
排队创建防火墙规则
接管外部防火墙规则
排队删除防火墙规则
加载云厂商原生防火墙对象定义
调整受管统一防火墙 v2 规则顺序
列出统一防火墙 v2 规则
更新受管统一防火墙 v2 规则
加载防火墙设置
操作防火墙后端
创建防火墙端口白名单规则
删除防火墙端口白名单规则
更新防火墙端口白名单规则
Process
获取监听进程
停止进程
处理 WebSocket 请求
根据 PID 获取进程信息
SSH
生成主机 SSH 密钥
删除主机 SSH 密钥
加载主机 SSH 密钥
同步主机 SSH 密钥
更 新主机 SSH 密钥
加载主机 SSH 配置
通过文件更新主机 SSH 设置
加载主机 SSH 日志
清理主机 SSH 日志
导出主机 SSH 日志
操作 SSH
加载主机 SSH 设置信息
更新主机 SSH 设置
Disk Management
获取完整磁盘信息
挂载磁盘
磁盘分区
卸载磁盘
Terminal
WebSocket 容器终端
WebSocket 本地终端
获取主机 SSH 的 WebSocket 地址
Cronjob
创建计划任务
删除计划任务
导出计划任务列表
更新计划任务分组
手动执行一次计划任务
导入计划任务列表
加载计划任务信息
加载计划任务执行时间
清理计划任务记录
加载计划任务记录日志
加载脚本选项
分页查询计划任务
分页查询任务记录
更新计划任务状态
停止任务
更新计划任务
ScriptLibrary
添加脚本
删除脚本
运行脚本
分页查询脚本
从远程同步脚本
更新脚本
Host
创建主机
检查系统组件是否存在
删除主机
根据 ID 获取主机
查询主机
根据 ID 测试
根据信息测试
主机树
更新主机
更新主机分组
System Setting
加载 MFA 信息
绑定 MFA
关闭 MFA
更新系统绑定信息
加载系统地址
加载概览备忘录
更新概览页备忘录
更新系统设置
更新系统端口
更新代理设置
加载系统设置信息
加载系统可用状态
加载基础系统设置信息
下载系统证书
加载系统证书信息
重载 SSL
更新系统 SSL
加载系统终端设置信息
更新系统终端设置
更新系统设置
加载升级信息
升级
按版本加载发布说明
加载升级说明
加载本地备份目录
保存通用描述
加载文件历史设置信息
更新文件历史设置
获取文件管理 AI 设置信息
更新文件管理 AI 设置
加载系统设置信息
加载系统可用状态
创建系统快照
删除系统备份
更新快照描述
导入系统快照
加载系统快照数据
恢复系统备份
重建系统快照
回滚系统备份
分页查询系统快照
保存本地连接信息
检查本地连接
检查本地连接信息
加载本地连接
更新本地连接
获取终端 AI 设置信息
更新终端 AI 设置
更新系统设置
加载网站目录
Backup Account
创建备份账号
备份系统数据
列出存储桶
检查备份是否已使用
检查备份账号
删除备份账号
获取本地备份目录
加载备份账号选项
删除备份记录
更新备份记录描述
下载备份记录
分页查询备份记录
分页查询计划任务备份记录
加载备份记录大小
恢复系统数据
通过上传恢复系统数据
刷新 Token
分页查询备份账号
列出备份账号中的文件
更新备份账号
上传恢复文件
创建备份账号
加载备份账号基础信息
删除备份账号
刷新 Token
更新备份账号
Runtime
创建运行环境
获取运行环境
获取 Node 模块
操作 Node 模块
获取 Node 包脚本
操作运行环境
获取 PHP 运行环境扩展
更新运行环境 PHP 配置
加载 PHP 运行配置
获取 PHP 容器配置
更新 PHP 容器配置
安装 PHP 扩展
卸载 PHP 扩展
获取 PHP 配置文件
更新 FPM 配置
获取 FPM 配置
获取 PHP 运行状态
更新 PHP 配置文件
更新 运行环境备注
列出运行环境
操作 Supervisor 进程
获取 Supervisor 进程
操作 Supervisor 进程文件
同步运行环境状态
更新运行环境
Alert
创建告警
获取 Clam 列表
删除告警配置
获取告警配置
分页查询告警配置
测试告警配置
更新告警配置
获取计划任务
删除告警
获取磁盘
清理告警日志
分页查询告警日志
分页查询告警
更新告警状态
更新告警
Clam
创建 Clam
加载 Clam 基础信息
删除 Clam
加载 Clam 文件
更新 Clam 文件
执行 Clam 扫描
操作 Clam
清理 Clam 记录
分页查询 Clam 记录
分页查询 Clam
更新 Clam 状态
更新 Clam
Device
清理系统
加载设备基础信息
检查设备 DNS 配置
加载配置
通过文件更新设备配置
更新设备
更新设备 hosts
更新设备密码
更新设备 Swap
加载用户列表
列出时区选项
扫描系统
McpServer
为 MCP 服务器绑定域名
获取 MCP 服务绑定域名
更新 MCP 服务器绑定域名
列出 MCP 服务器
创建 MCP 服务器
测试 MCP 服务器连接
删除 MCP 服务器
加载 MCP 服务器详情
操作 MCP 服务
同步 MCP 服务器状态
更新 MCP 服务器
Command
创建命令
删除命令
导出命令
导入命令
列出命令
分页查询命令
查询命令树
更新命令
上传命令 csv 列表
Host tool
获取工具配置
更新工具配置
创建主机工具配置
操作工具
获取工具状态
获取 Supervisor 进程配置
创建 Supervisor 进程
操作 Supervisor 进程配置文件
获取 Supervisor 进程配置文件
FTP
创建 FTP 用户
加载 FTP 基础信息
删除 FTP 用户
加载 FTP 操作日志
操作 FTP
分页查询 FTP 用户