گیم سرورها و VPSهایتان را با کد کنترل کنید: روشن و خاموش کردن، ریاستارت، اجرای دستور و دیدن وضعیت. خرید، تمدید و تغییر تنظیمات فقط از پنل ممکن است. هر گیم سرور با نامش (`world_name`) شناخته میشود. نمودار، مشخصات و اجرای دستور فعلاً فقط برای ماینکرفت است. برای فایلها از FTP استفاده کنید: آدرس همان `host` سرور، پورت `1021`، یوزر و رمز از پنل (فایلمنیجر ← دکمهی FTP).
همهی درخواستها به یک API key نیاز دارند. کلید را در هدر Authorization بفرستید.
Authorization: api_key <YOUR_API_KEY>API key را از پنل، صفحهی حساب کاربری بسازید. هدر دقیقاً `Authorization: api_key <token>` است (با یک فاصله؛ `Bearer` کار نمیکند).
تصمیمگیری کلاینت باید بر اساس فیلد error_code باشد، نه متن پیام.
INVALID_AUTH_HEADERهدر احراز هویت نامعتبر است
Invalid authorization header
احراز هویت انجام نشد
WORLD_NAME_REQUIREDنام سرور ارسال نشده است
Server name was not provided
`world_name` نیامده، سرور در حال انتقال است، یا کار دیگری روی سرور در جریان است (`SERVER_BUSY`؛ چند ثانیه بعد دوباره تلاش کنید)
HOST_UNAVAILABLEارتباط با سرور میزبان موقتاً قطع است و تیم فنی در جریان است. چند دقیقه دیگر دوباره تلاش کنید
The host of this server is temporarily unreachable and our team is on it. Please try again in a few minutes
سرور میزبان موقتاً در دسترس نیست؛ کمی بعد دوباره تلاش کنید
SERVER_NOT_FOUNDسرور مورد نظر یافت نشد
Server not found
سروری با این `world_name` در حساب شما نیست
SERVER_NOT_FOUNDسرور مورد نظر یافت نشد
Server not found
VPSی با این `name` در حساب شما نیست
/server/startworld_namestringالزامینام سرور (همان `world_name` در `/servers`)
messagestringفقط برای دیباگ؛ موفقیت را از کد ۲۰۰ تشخیص دهید
سرور با موفقیت روشن شد
{
"world_name": "myworld"
}/server/stopworld_namestringالزامینام سرور (همان `world_name` در `/servers`)
messagestringفقط برای دیباگ؛ موفقیت را از کد ۲۰۰ تشخیص دهید
سرور با موفقیت خاموش شد
{
"world_name": "myworld"
}/server/restartworld_namestringالزامینام سرور (همان `world_name` در `/servers`)
messagestringفقط برای دیباگ؛ موفقیت را از کد ۲۰۰ تشخیص دهید
سرور با موفقیت ریاستارت شد
{
"world_name": "myworld"
}/server/force_restartسرور بدون صبر برای ذخیرهشدن، فوراً بسته و دوباره روشن میشود. فقط وقتی استفاده کنید که سرور هنگ کرده و ریاستارت معمولی جواب نمیدهد.
world_namestringالزامینام سرور (همان `world_name` در `/servers`)
messagestringفقط برای دیباگ؛ موفقیت را از کد ۲۰۰ تشخیص دهید
سرور با موفقیت ریاستارت شد
{
"world_name": "myworld"
}/minecraft/server/cmdهر دستوری که در کنسول سرور میزنید (مثل `whitelist add`، `ban`، `op`) را اجرا میکند و خروجیاش را برمیگرداند.
world_namestringالزامیcmdstringالزامیدستور کنسول ماینکرفت؛ اسلش ابتدایی اختیاری است — مثل `whitelist add player` یا `op player`
use_rconbooleandefault: true`false` یعنی خروجی دستور لازم نیست
resultstringخروجی دستور؛ در Bedrock فقط `ok`، و اگر اجرا نشد `error`
خروجی اجرای دستور
{
"world_name": "myworld",
"cmd": "whitelist add player",
"use_rcon": true
}/serversworldsobject[]world_namestringgamestringminecraftterrariahytaledstcs16pzmemoryintegerرم به مگابایت
diskintegerدیسک به گیگابایت
is_bedrockbooleanremaining_timeintegerساعت باقیمانده؛ منفی یعنی زمان تمام شده و باید تمدید شود
is_tmodbooleanتراریای موددار (tModLoader)
renewal_discountnumberدرصد تخفیف تمدید (فقط اگر تخفیف دارید)
remaining_conversions_this_monthintegerچند بار دیگر این ماه میتوانید نوع سرور را عوض کنید (از پنل)
convert_monthly_limitintegerسقف ماهانهی تغییر نوع سرور
لیست سرورها
/server/dataworld_namestringالزامینام سرور (همان `world_name` در `/servers`)
world_namestringportintegerپورت اصلی بازی
hoststringآدرسی که پلیرها با آن وصل میشوند، مثلاً de1.9craft.ir
ipstringIP همان آدرس
ftp_hoststringداخلی است؛ برای FTP از `host` استفاده کنید
filemanager_base_urlstringداخلی پنل؛ به کار شما نمیآید
remaining_timeintegerساعت باقیمانده؛ منفی یعنی زمان تمام شده و باید تمدید شود
is_fullinteger01`1` یعنی دیسک سرور پر است
is_migratingbooleanسرور در حال انتقال است و تا تمام شدنش کنترل نمیشود
diskintegerدیسک به گیگابایت
memoryintegerرم به مگابایت
versionstring | nullنسخهی ماینکرفت
javastring | nullنسخهی جاوا (در Bedrock خالی)
softwarestringpaper, purpur, spigot, leaf, fabric, forge, ...
is_bedrockbooleanadditional_portinteger | nullپورت دوم (اگر خریده باشید)
listen_portsstring[]پورتهای اضافهای که برایتان باز شده
subdomainstring | nullدامنهی اختصاصی سرور (اگر ثبت کرده باشید)
renewal_discountnumberدرصد تخفیف تمدید (فقط اگر تخفیف دارید)
اطلاعات سرور
/server/logs/queryلاگ کنسول سرور، برای همهی بازیها. میتوانید جستوجو کنید (`grep`)، فقط خطاها را بگیرید (`level`)، فایل متنی بگیرید (`format=text`) یا لاگ را زنده دنبال کنید (`follow`). زمانها به وقت تهران است. برای ادامهی خواندن، `next_since` پاسخ را در درخواست بعدی بهعنوان `since` بفرستید. سقف: ۳۰ درخواست در دقیقه.
world_namestringالزامینام سرور (همان `world_name` در `/servers`)
tailintegerچند خط آخر. پیشفرض ۲۰۰، حداکثر ۲۰۰۰ (در فایل متنی و لاگ زنده تا ۲۰۰۰۰).
sincestringاز چه زمانی: `start` (از آخرین روشن شدن)، مدت مثل `10m`، `2h`، `1d`، یا یک زمان مشخص (epoch یا `2026-10-01T14:00:00+03:30`).
untilstringتا چه زمانی؛ همان فرمت `since`. فقط همراه `since`، و نه با `follow`.
grepstringمتنی که دنبالش هستید (حروف بزرگ و کوچک فرقی ندارند)، حداکثر ۱۰۰ کاراکتر
levelstringwarnerror`error` فقط خطاها، `warn` هشدارها و خطاها
contextintegerdefault: 0چند خط قبل و بعد از هر نتیجه هم بیاید؛ همراه `grep` یا `level`
timestampsbooleandefault: falseزمان را اول هر خط بگذارد (در فایل متنی و لاگ زنده)
formatstringdefault: "json"jsontextfollowbooleandefault: falseلاگ زنده (Server-Sent Events)؛ هر ۳۰ دقیقه دوباره وصل شوید
linesobject[]tsstring | nullزمان خط
textstringمتن خط
levelstringdebuginfowarnerrorنوع خط، اگر معلوم باشد
gapbooleanstateobjectstatusstring`running` روشن، `exited` خاموش، `restarting` در حال ریاستارت
started_atstring | nullزمان آخرین روشن شدن
finished_atstring | nullexit_codeinteger | nulloom_killedboolean | null`true` یعنی سرور بهخاطر کم آمدن رم بسته شده
restart_countinteger | nullstarted_atstring | nullزمان آخرین روشن شدن
next_sincestring | nullبرای ادامه، این را بهعنوان `since` بفرستید
scannedintegerچند خط گشته شد
truncatedboolean`true` یعنی نتیجههای بیشتری هست؛ بازه را کوچکتر کنید
timezonestringutc_offsetstringخطوط لاگ. در لاگ زنده اول وضعیت سرور (`state`) میآید، بعد هر خط جدید، و آخر `end`.
/v2/server/graphدادهی همان نمودارهای پنل (پلیرها، TPS، رم، CPU و ...) برای ۳۰ روز گذشته. سقف: ۳۰ درخواست در دقیقه.
world_namestringالزامینام سرور (همان `world_name` در `/servers`)
periodstringdefault: "1h"1h6h1d3d1w2wبازهی زمانی تا الان
startintegerشروع بازه (epoch به ثانیه)؛ بهجای `period`
endintegerپایان بازه (epoch به ثانیه)؛ پیشفرض الان
stepintegerفاصلهی نقطهها به ثانیه؛ اگر ندهید خودکار انتخاب میشود
startintegerشروع بازه (epoch)
endintegerپایان بازه (epoch)
stepintegerفاصلهی نقطهها به ثانیه
seriesobjectهر نمودار یک لیست از `[زمان، مقدار]`. Java: `player`، `tps`، `mspt`، `ram_usage` (مگابایت)، `cpu` (درصد)، `entity`، `chunk`، `villager`. Bedrock: `cpu`، `memory` (۱۰۰ یعنی ۱ گیگابایت).
دادهی نمودارها
/vm/listوضعیت، IP، یوزر و رمز، زمان و ترافیک باقیماندهی VPSها. بدون `name` همه را در `vms` میدهد (رمزها `***`)؛ با `name` فقط همان VPS را، با رمز واقعی.
namestringنام VPS (همان `name` در لیست)؛ اگر بدهید فقط همان VPS برمیگردد
vmsobject[]namestringنام VPS؛ در درخواستهای دیگر همین را بفرستید
regionstringشناسهی لوکیشن (دیتاسنتر) VPS
usernamestringیوزر ورود (SSH یا Remote Desktop)
passwordstring | nullرمز ورود؛ در لیست `***` است، رمز واقعی فقط با `?name=`
statusinteger01236789`0` خاموش · `1` روشن · `2` در حال ساخت یا نصب دوباره · `3` خراب (به پشتیبانی بگویید) · `6` در حال خاموش شدن · `7` در حال ریاستارت · `8` در حال ریاستارت فوری · `9` در حال روشن شدن
taskstring | nullکار در جریان: `provisioning` (ساخت) یا `rebuilding` (نصب دوباره)؛ وگرنه null
imagestringسیستمعامل، مثل `ubuntu-24`
logostring | nullلوگوی سیستمعامل
flavorstringنام پلن
cpuintegerتعداد هستهی CPU
ramintegerرم به گیگابایت
diskintegerدیسک به گیگابایت
ipstring | nullIP اصلی برای اتصال؛ تا ساخت تمام نشده ممکن است null باشد
ip6string | nullآدرس IPv6 این VPS (رایگان، توسط پشتیبانی تخصیص داده میشود)؛ بدون آن null
additional_ipsstring[]IPهای اضافهای که خریدهاید
start_datestring (date-time)تاریخ خرید
remaining_timeintegerساعت باقیمانده؛ منفی یعنی زمان تمام شده و باید تمدید شود
renewal_discountnumber | nullدرصد تخفیف تمدید؛ null یعنی تخفیفی نیست
boot_minutesintegerروشن شدن حدوداً چند دقیقه طول میکشد
traffic_limit_gbnumberکل ترافیک این ماه (گیگابایت)
traffic_used_gbnumberترافیک مصرفشده این ماه
traffic_remaining_gbnumberترافیک باقیمانده این ماه
traffic_bank_gbnumberترافیک اضافهی خریداریشده (جزو کل ترافیک)
traffic_bank_used_gbnumberمصرفشده از ترافیک خریداریشده در این ماه
traffic_period_ends_atstring | nullتاریخ شروع دوبارهی ترافیک ماهانه
network_suspendedboolean`true` یعنی ترافیک تمام شده و اینترنت VPS قطع است تا ترافیک بخرید
rebuild_stepstring | nullمرحلهی نصب دوباره (فقط در حین آن)
featuresobjectامکانات پنل که برای این VPS فعال است
reset_passwordbooleanریست رمز از پنل
novncbooleanکنسول تحت وب (noVNC) در پنل
warningstringاطلاعیهی عمومی VPS (مثلاً اختلال شبکه)؛ اگر خالی نیست به کاربر نشان دهید
لیست VPSها، یا یک VPS وقتی `name` ارسال شده باشد
/vm/initمقدارهای `init` در جدول بدنهی درخواست آمده است. پاسخ موفق یعنی دستور ثبت شد؛ برای دیدن نتیجه `/vm/list?name=...` را بخوانید تا `status` روشن (`1`) یا خاموش (`0`) شود.
namestringالزامینام VPS از `/vm/list`
initintegerالزامی01678کاری که میخواهید انجام شود: `1` روشن کردن · `6` خاموش کردن عادی (مثل shutdown داخل سیستمعامل؛ برنامهها درست بسته میشوند) · `0` خاموش کردن فوری (مثل کشیدن برق؛ برای وقتی VPS هنگ کرده یا خاموش کردن عادی گیر کرده) · `7` ریاستارت عادی · `8` ریاستارت فوری (مثل دکمهی reset؛ برای وقتی VPS هنگ کرده یا ریاستارت عادی گیر کرده). VPS باید برای `1` خاموش و برای بقیه روشن باشد.
msgstringدستور ثبت شد
{
"name": "string",
"init": 0
}/public/error-codesمتن فارسی هر `error_code`. یکبار بگیرید و نگه دارید.
نگاشت کد خطا به متن فارسی