3x-ui3x-ui
مرجعمرجع API

سرور اشتراک

یک سرور HTTP/HTTPS جداگانه که لینک‌های اشتراک پراکسی (استاندارد، JSON و Clash) را به کلاینت‌ها ارائه می‌دهد. این سرور روی پورت اختصاصی خودش (به‌صورت پیش‌فرض 2096) گوش می‌دهد و در بخش Settings ← Subscription پیکربندی می‌شود. پنل‌های جدید برای هر قالب پیشوند مسیر تصادفی تولید می‌کنند و همه‌ی مسیرها قابل پیکربندی می‌مانند. همه‌ی نقاط پایانی اشتراک، هدرهای پاسخ را برای خواندن اطلاعات ترافیک/انقضا توسط برنامه‌های کلاینت تنظیم می‌کنند.

Return base64-encoded subscription links for all enabled clients matching the subscription ID. When the request has an Accept: text/html header or ?html=1, renders a styled info page instead. With ?format=info, returns the page view-model as JSON (traffic, expiry, online status; no links) for live polling. The path prefix is configured by subPath.

GET
/{subPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

subPath*string

Query Parameters

format?string

Set to "info" to get the subscription status view-model as JSON instead of the links.

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

Return subscription as a JSON array of proxy configs (one per enabled client). Only when JSON subscription is enabled in settings. The path prefix is configured by subJsonPath.

GET
/{jsonPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

jsonPath*string

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

Return subscription as a Clash/Mihomo-compatible YAML config, including configured global Clash routing rules. Only when Clash subscription is enabled in settings. The path prefix is configured by subClashPath.

GET
/{clashPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

clashPath*string

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

تنظیمات Xray

قالب پیکربندی Xray، مدیریت outboundها، یکپارچه‌سازی Warp/Nord و آزمایش پیکربندی. همه‌ی نقاط پایانی زیر /panel/api/xray قرار دارند.

هاست‌ها

نقاط پایانی بازنویسی به ازای هر inbound. هر host فعال یک لینک اشتراک/پراکسی اضافی با آدرس/پورت/TLS مخصوص خودش ارائه می‌دهد و جایگزین آرایه‌ی قدیمی externalProxy می‌شود. همه‌ی نقاط پایانی زیر /panel/api/hosts قرار دارند.