رفتن به محتوا
cloudhostمستندات
مرجع API

API عمومی

هر کاری که داشبورد، CLI و سرور MCP می‌کنند یک درخواست به همین API است. این صفحه مبانی را می‌گوید؛ همهٔ مسیرها، یکی‌یکی، در بخش‌های پایین آمده‌اند و مستقیم از فایل OpenAPI ایجاد می‌شوند.

آدرس#

متغیرها
export KEY=chk_live_…
curl -H "Authorization: Bearer $KEY" https://api.ibel.ai/v1/whoami

همهٔ مسیرها زیر https://api.ibel.ai/v1 هستند، جز سرور MCP در /mcp. درخواست و پاسخ JSON است، جز جایی که مسیر چیز دیگری بگوید (آپلود فایل و بیلد، لاگ زنده). فیلدهای ناشناخته نادیده گرفته می‌شوند.

اعتبارنامه#

اعتبارنامهشکلاز کجااعتبار
کلید APIchk_live_<id>_<secret> · chk_test_…داشبورد، cloudhost keys create، cloudhost loginتا باطل شدن یا انقضا؛ یک بار نشان داده می‌شود
نشستchs_<id>_<secret>ورود به داشبورد۱۲ ساعت بی‌کاری، حداکثر ۳۰ روز

اعتبارنامه را به شکل Authorization: Bearer … بفرستید. هر دو نوع روی همهٔ مسیرها کار می‌کنند، جز مسیرهایی که فقط نشست می‌خواهند (403 session_only). اعتبارنامهٔ ناقص، نامعتبر، منقضی یا باطل 401 unauthorized می‌گیرد.

نقش‌ها و تایید دوم#

هر کلید و هر عضو تیم یک نقش دارد: owner، admin، developer، billing یا viewer؛ جدولش در تیم‌ها و نقش‌ها. هر مسیر در مرجع می‌گوید چه نقش‌هایی می‌توانند صدایش بزنند.

مسیرهای حساس با نشست داشبورد عامل دومی می‌خواهند که در ۱۰ دقیقهٔ اخیر تایید شده باشد؛ وگرنه 403 step_up_required می‌دهند. کلیدهای API از این مرحله رد می‌شوند.

خطاها#

شکل خطا
{"error": {"code": "not_found", "message": "no function named shop"}}

code ثابت است و برای برنامه‌ها؛ message برای آدم‌هاست و ممکن است عوض شود. منابع تیم‌های دیگر هرگز نشان داده نمی‌شوند: 404 not_found، انگار وجود ندارند.

وضعیتکدکی
400bad_json · bad_param · bad_inputبدنه JSON نیست، پارامتر کوئری بد است یا مقداری نادرست
401unauthorizedاعتبارنامه نیست یا معتبر نیست
403forbidden · session_only · step_up_requiredنقش اجازه نمی‌دهد، نشست لازم است، یا تایید دوم
404not_foundچنین مسیر یا منبعی در این تیم نیست
405methodمسیر هست، این متد نه
413too_largeبدنه از حد مسیر بزرگ‌تر است
429rate_limited · resend_waitبیش از حد درخواست (ورود، تایید دوم، دعوت، ورود CLI)
500internalخطای پیش‌بینی‌نشده

پول، زمان و دوره#

  • همهٔ مبلغ‌ها ریالاند، به عدد صحیح (currency: "IRR"). هر تومان ۱۰ ریال است.
  • زمان‌ها ISO 8601 به UTC‌اند (2026-11-04T09:30:00.000Z).
  • دوره‌های صورت‌حساب ماه شمسی‌اند، YYYY-MM (مثلاً 1405-08)، از نیمه‌شب به وقت تهران روز اول ماه.
  • هر پاسخ هدر cloudhost-version با نسخهٔ API را دارد.

فهرست‌ها و محدودیت‌ها#

فهرست‌ها هنوز صفحه‌بندی با cursor ندارند: همه را برمی‌گردانند یا جدیدترین‌ها را تا یک تعداد ثابت.

فهرستبرمی‌گرداند
نسخه‌ها۱۰۰ تای آخر
بیلد‌ها۵۰ تای آخر
لاگ بیلد۱۰۰۰ خط در هر درخواست؛ برای بقیه after
لاگlimit ۱ تا ۱۰۰۰ (پیش‌فرض ۱۰۰)
گزارش تغییرهاlimit ۱ تا ۵۰۰ (پیش‌فرض ۱۰۰)
تراکنش‌های کیف پول۲۰۰ تای آخر
رویدادهای هشدار۵۰ تای آخر

نام‌ها و آدرسها#

نام فانکشن، برنامه، دیتابیس، کش و شاخه یک برچسب DNS است: حروف کوچک لاتین، رقم و خط تیره، ۱ تا ۶۳ کاراکتر، با حرف یا رقم در ابتدا و انتها، و بدون -- (که شاخه را از نام جدا می‌کند). باکت‌ها همین‌طورند با ۳ تا ۶۳ کاراکتر. نام‌ها در کل پلتفرم یکتا هستند؛ نامی که تیم دیگری دارد 409 name_taken می‌گیرد.

منبعآدرس
فانکشنhttps://<name>.fn.trustpage.ir
برنامهhttps://<name>.app.trustpage.ir
پیش‌نمایشhttps://<branch>--<name>.app.trustpage.ir (or .fn.trustpage.ir)
دیتابیس<db>.database.trustpage.ir:5432، کاربر app، دیتابیس <db>؛ شاخه: <branch>--<db>
کش<name>.cache.trustpage.ir:6379 و https://<name>.cache.trustpage.ir
فضای ذخیره‌سازیhttps://storage.trustpage.ir، ناحیهٔ us-east-1

بخش‌های مرجع