EasyXrayAPI 参考
EasyXray 面板的 REST API —— 命名空间、认证、入站、客户端、服务器状态等，依据 OpenAPI 规范生成。
EasyXray 面板提供了一套用于自动化的 REST API。本节页面由面板自身的 OpenAPI 规范生成，因此始终与面板实际提供的 schema 保持一致。
命名空间
面板提供的一切都位于配置的 Web 基础路径（webBasePath）之下，其后紧跟
easyxray：
| 入口 | 路径 |
|---|---|
| 面板界面 | <basePath>/easyxray/… |
| REST API | <basePath>/easyxray/api/v1/… |
| WebSocket | <basePath>/easyxray/ws |
| OpenAPI 规范 | <basePath>/easyxray/api/v1/openapi.json |
使用默认基础路径（/）时，例如：
GET /easyxray/api/v1/inbounds/list
POST /easyxray/api/v1/clients/add
GET /easyxray/api/v1/server/status
GET /easyxray/api/v1/openapi.jsoneasyxray 命名空间没有别名。 上游 X-UI/3x-ui 面板的早期版本在
/panel/api/… 下提供这些端点；EasyXray 不会在该前缀上响应，也没有安装
兼容性重定向。任何针对旧路径编写的脚本、机器人或看板都必须更新为上面的
/easyxray/api/v1/… 路由。
认证
请求通过以下两种方式之一进行认证：会话 Cookie——登录面板时设置，名为
easyxray；或 Bearer 令牌：
Authorization: Bearer <token>在 设置 → 安全 → API 令牌 中创建 API 令牌；它们拥有完整管理员权限，因此请像 保管面板密码一样保管它们。参见 API 令牌。
为本节中的任意端点构建一个已认证请求：
API request builder
Build an authenticated cURL command or fetch() snippet for any EasyXray panel API endpoint under /easyxray/api/v1/*.
curl -X GET 'https://panel.example.com:2053/easyxray/api/v1/inbounds/list' \
-H 'Authorization: Bearer <token>'await fetch('https://panel.example.com:2053/easyxray/api/v1/inbounds/list', {
method: 'GET',
headers: { 'Authorization': 'Bearer <token>' },
});按区域浏览
各区域页面通过 pnpm gen:api 从已提交的 public/openapi.json 规范重新生成
（规范本身由面板仓库的 frontend/scripts/build-openapi.mjs 发布）。不要手工
编辑生成的标签页——请修改规范源并重新生成。