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

WebSocket

دریافت به‌روزرسانی‌های وضعیت در لحظه از طریق WebSocket. تنها یک‌بار به <code>ws://<panel>/ws</code> متصل شوید تا بدون نیاز به polling، جریانی از پیام‌های JSON دریافت کنید. به یک کوکی نشست احرازهویت‌شده نیاز دارد (احرازهویت با توکن Bearer پشتیبانی نمی‌شود). هر پیام دارای یک فیلد <code>type</code> است که شکل داده‌ی آن را مشخص می‌کند.

GET
/ws

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X GET "https://example.com/ws"
{  "success": true,  "msg": "string",  "obj": null}