API 参考

3x-ui 面板的 REST API —— 涵盖认证、入站、客户端、服务器状态等，依据 OpenAPI 规范自动生成。

3x-ui 面板提供了一套用于自动化的 REST API。以下页面根据面板的 OpenAPI 规范自动生成，因此始终与所记录的 schema 保持一致。

认证

请求可使用 会话 Cookie（来自 POST /login）或 Bearer token 进行认证：

Authorization: Bearer <token>

在面板中创建 API token；它们拥有完整的管理员权限，因此请妥善保管。参见 API Tokens。

为下方任意端点构建一个已认证的请求：

Build an authenticated cURL command or fetch() snippet for any 3x-ui panel API endpoint under /panel/api/*.

Panel base URL

API token (Bearer)

Endpoint path

Method

cURL

curl -X GET 'https://panel.example.com:2053/panel/api/inbounds/list' \
  -H 'Authorization: Bearer <token>'

fetch()

await fetch('https://panel.example.com:2053/panel/api/inbounds/list', {
  method: 'GET',
  headers: { 'Authorization': 'Bearer <token>' },
});

本参考文档由 public/openapi.json 通过 pnpm gen:api 重新生成。请勿手动编辑自动生成的标签页面。