3x-uiAPI Reference
The 3x-ui panel REST API — authentication, inbounds, clients, server stats, and more, generated from the OpenAPI spec.
The 3x-ui panel exposes a REST API for automation. These pages are generated from the panel's OpenAPI specification, so they always match the documented schema.
Authentication
Requests authenticate with either a session cookie (from POST /login) or a
Bearer token:
Authorization: Bearer <token>Create API tokens in the panel; they are full-admin credentials, so store them securely. See API Tokens.
Build an authenticated request for any endpoint below:
API request builder
Build an authenticated cURL command or fetch() snippet for any 3x-ui panel API endpoint under /panel/api/*.
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>' },
});Browse by area
This reference is regenerated from public/openapi.json with pnpm gen:api.
Don't edit the generated tag pages by hand.