Skip to content

API ​

هر کاری که در داشبورد انجام می‌شود، با REST API هم قابل انجام است. آدرس پایه: https://YOUR_DOMAIN:8000/api

مستندات تعاملی ​

در .env متغیر DOCS=True را فعال کنید و ری‌استارت کنید. سپس:

  • Swagger: https://YOUR_DOMAIN:8000/docs
  • ReDoc: https://YOUR_DOMAIN:8000/redoc

WARNING

روی سرورهای عمومی، بعد از استفاده DOCS را دوباره غیرفعال کنید.

احراز هویت ​

اول توکن بگیرید:

bash
curl -X POST https://YOUR_DOMAIN:8000/api/admin/token \
  -d "username=admin&password=YOUR_PASSWORD"

پاسخ:

json
{ "access_token": "eyJhbGciOi...", "token_type": "bearer" }

سپس توکن را در هدر همه‌ی درخواست‌ها بفرستید:

bash
curl https://YOUR_DOMAIN:8000/api/users \
  -H "Authorization: Bearer eyJhbGciOi..."

مثال: ساخت کاربر ​

bash
curl -X POST https://YOUR_DOMAIN:8000/api/user \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "alice",
    "proxies": { "vless": {}, "vmess": {} },
    "inbounds": {},
    "data_limit": 53687091200,
    "expire": 1767225600,
    "data_limit_reset_strategy": "no_reset",
    "note": "30 days / 50 GB"
  }'
فیلدتوضیح
username۳ تا ۳۲ کاراکتر: حروف انگلیسی، عدد، -، _، @ و .
proxiesپروتکل‌های فعال. {} یعنی تنظیمات پیش‌فرض (UUID/رمز خودکار)
inboundsاینباندهای هر پروتکل. {} یعنی همه‌ی اینباندها
data_limitحجم به بایت. 0 یعنی نامحدود
expireزمان انقضا به‌صورت Unix timestamp. 0 یعنی نامحدود
data_limit_reset_strategyno_reset، day، week، month، year
statusactive یا on_hold
on_hold_expire_durationدر حالت on_hold: مدت اعتبار (ثانیه) از اولین اتصال

مسیرهای اصلی ​

ادمین ​

متدمسیرکار
POST/api/admin/tokenدریافت توکن
GET/api/adminاطلاعات ادمین فعلی
GET/api/adminsلیست ادمین‌ها
POST/api/adminساخت ادمین
PUT/api/admin/{username}ویرایش ادمین
DELETE/api/admin/{username}حذف ادمین
POST/api/admin/{username}/users/disableغیرفعال کردن همه‌ی کاربران ادمین
POST/api/admin/{username}/users/activateفعال کردن همه‌ی کاربران ادمین

کاربر ​

متدمسیرکار
POST/api/userساخت کاربر
GET/api/user/{username}اطلاعات کاربر
PUT/api/user/{username}ویرایش کاربر
DELETE/api/user/{username}حذف کاربر
POST/api/user/{username}/resetریست مصرف
POST/api/user/{username}/revoke_subتغییر لینک سابسکریپشن
POST/api/user/{username}/active-nextفعال کردن پلن بعدی
GET/api/user/{username}/usageمصرف کاربر به تفکیک نود
PUT/api/user/{username}/set-ownerتغییر مالک
GET/api/usersلیست کاربران (با offset، limit، search، status)
POST/api/users/resetریست مصرف همه
GET/api/users/usageمصرف کل کاربران
GET/api/users/expiredلیست کاربران منقضی
DELETE/api/users/expiredحذف کاربران منقضی

قالب کاربر ​

متدمسیرکار
GET/api/user_templateلیست قالب‌ها
POST/api/user_templateساخت قالب
GET / PUT / DELETE/api/user_template/{id}مشاهده / ویرایش / حذف

سیستم، هسته و نود ​

متدمسیرکار
GET/api/systemآمار سیستم
GET/api/inboundsلیست اینباندها
GET / PUT/api/hostsمشاهده / ویرایش هاست‌ها
GET/api/coreوضعیت هسته
POST/api/core/restartری‌استارت هسته
GET / PUT/api/core/configمشاهده / ویرایش کانفیگ Xray
GET/api/node/settingsگواهی نود
GET/api/nodesلیست نودها
POST/api/nodeافزودن نود
GET / PUT / DELETE/api/node/{id}مشاهده / ویرایش / حذف نود
POST/api/node/{id}/reconnectاتصال دوباره
GET/api/nodes/usageمصرف نودها

لیست کامل و دقیق پارامترها را در /docs ببینید.

منتشر شده تحت مجوز AGPL-3.0 · فورک شده از Marzban