همهٔ سیستم‌ها عملیاتی‌اند
ایران‌کلاد
ورود ثبت‌نام

مستندات توسعه‌دهندگان · نسخهٔ v1

مستندات API ایران‌کلاد

سرورهای ابری، DNS و CDN، فضای ذخیره‌سازی، دیتابیس، اپلیکیشن‌ها و کیف پول حساب خود را با اسکریپت یا CI مدیریت کنید. API از نوع REST است، پاسخ‌ها JSON هستند و هر درخواست با یک توکن شخصی احراز هویت می‌شود.

راهنمای شروع سریع ساخت توکن API
نشانی پایه
https://iranclaud.ir/api/v1
احراز هویت
هدر Authorization: Bearer ic_pat_…
قالب پاسخ
JSON با کلیدهای data، meta یا error
محدودیت نرخ هر توکن
۱۲۰ خواندن و ۳۰ تغییر در دقیقه
مشخصات OpenAPI
openapi.yaml openapi.json

نمونهٔ سریع

اولین درخواست در یک دقیقه

در صفحهٔ ساخت توکن توکنی با دسترسی vm:read بسازید، آن را جای YOUR_TOKEN بگذارید و دستور را اجرا کنید. پاسخ، فهرست سرورهای حساب شماست.

توکن فقط یک بار، همان لحظهٔ ساخت، نمایش داده می‌شود. می‌توانید برایش انقضای ۳۰، ۹۰ یا ۳۶۵ روزه بگذارید و هر زمان باطلش کنید.

فهرست سرورها · curl 
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://iranclaud.ir/api/v1/vms

بدون توکن هم می‌توانید فهرست گروه‌های API را ببینید: curl https://iranclaud.ir/api/v1

مرجع

مرجع endpoint‌ها

همهٔ ۱۱۴ endpoint فعال در ۱۸ گروه، با دسترسی لازم، نوع محدودیت نرخ، پارامترها، فیلدهای بدنه، پاسخ‌ها و نمونهٔ curl. همین فهرست در فایل OpenAPI هم آمده است.

سرورهای ابری

vm،  ۸ endpoint

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

  • GET /vms
  • POST /vms
  • GET /vms/{uuid}
  • PATCH /vms/{uuid}
همهٔ ۸ endpoint

فایروال سرور

vm-firewall،  ۴ endpoint

وضعیت فایروال هر سرور، افزودن و حذف قانون و روشن یا خاموش کردن آن.

  • GET /vms/{uuid}/firewall
  • POST /vms/{uuid}/firewall/rules
  • DELETE /vms/{uuid}/firewall/rules/{pos}
  • POST /vms/{uuid}/firewall/toggle
جزئیات

متریک سرور

vm-metrics،  ۳ endpoint

مصرف لحظه‌ای پردازنده، حافظه و دیسک و نمودار زمانی مصرف و سرعت شبکه.

  • GET /vms/{uuid}/metrics
  • GET /vms/{uuid}/metrics/timeseries
  • GET /vms/{uuid}/traffic
جزئیات

پشتیبان‌گیری سرور

backup،  ۴ endpoint

فهرست، ساخت، حذف و بازگردانی بکاپ هر سرور.

  • GET /vms/{uuid}/backups
  • POST /vms/{uuid}/backups
  • DELETE /vms/{uuid}/backups/{volid}
  • POST /vms/{uuid}/backups/restore
جزئیات

ترافیک ماهانه

traffic،  ۳ endpoint

سهمیهٔ ترافیک ماهانهٔ هر سرور و خرید بستهٔ ترافیک اضافه از کیف پول.

  • GET /traffic/packs
  • GET /vms/{uuid}/traffic/quota
  • POST /vms/{uuid}/traffic/topup
جزئیات

گروه‌های قانون فایروال

firewall،  ۹ endpoint

مجموعه‌قانون‌های مشترک که روی چند سرور اعمال می‌شوند.

  • GET /firewall/rulesets
  • POST /firewall/rulesets
  • GET /firewall/rulesets/{uuid}
  • DELETE /firewall/rulesets/{uuid}
همهٔ ۹ endpoint

حساب کاربری

account،  ۹ endpoint

پروفایل، کلیدهای SSH، تنظیم اعلان‌ها و نشست‌های ورود به پنل.

  • GET /account
  • GET /me
  • GET /account/ssh-keys
  • POST /account/ssh-keys
همهٔ ۹ endpoint

کیف پول

wallet،  ۲ endpoint

موجودی، هزینهٔ جاری ساعتی و ماهانه و تاریخچهٔ تراکنش‌ها.

  • GET /wallet
  • GET /wallet/transactions
جزئیات

پلن‌ها و سیستم‌عامل‌ها

catalog،  ۲ endpoint

فهرست عمومی پلن‌ها و قالب‌های سیستم‌عامل؛ بدون توکن.

  • GET /plans
  • GET /os-templates
جزئیات

DNS

dns،  ۹ endpoint

زون‌ها و رکوردهای DNS و خروجی گرفتن از زون.

  • GET /dns/zones
  • POST /dns/zones
  • GET /dns/zones/{uuid}
  • GET /dns/zones/{uuid}/export
همهٔ ۹ endpoint

CDN

edge،  ۴ endpoint

روشن و خاموش کردن CDN و SSL خودکار هر رکورد، تنظیمات CDN و آمار مصرف.

  • GET /edge/records
  • GET /edge/usage
  • PATCH /edge/records/{rid}
  • PATCH /edge/records/{rid}/settings
جزئیات

فضای ذخیره‌سازی ابری

storage،  ۸ endpoint

ساخت و حذف باکت، مصرف باکت و کلیدهای دسترسی.

  • GET /storage/buckets
  • POST /storage/buckets
  • GET /storage/buckets/{name}
  • DELETE /storage/buckets/{name}
همهٔ ۸ endpoint

دیتابیس مدیریت‌شده

database،  ۱۱ endpoint

سرویس‌های دیتابیس، دیتابیس‌ها و کاربران هر سرویس.

  • GET /databases/instances
  • POST /databases/instances
  • GET /databases/instances/{uuid}
  • DELETE /databases/instances/{uuid}
همهٔ ۱۱ endpoint

وردپرس

wordpress،  ۱۱ endpoint

سایت‌های وردپرس مدیریت‌شده، افزونه‌ها، رمز مدیر، کش و فضای ذخیره‌سازی.

  • GET /apps/wordpress/sites
  • POST /apps/wordpress/sites
  • GET /apps/wordpress/sites/{uuid}
  • DELETE /apps/wordpress/sites/{uuid}
همهٔ ۱۱ endpoint

نکست‌کلاد

nextcloud،  ۱۱ endpoint

سرویس‌های نکست‌کلاد، اپ‌ها، رمز مدیر، کش و فضای ذخیره‌سازی.

  • GET /apps/nextcloud/sites
  • POST /apps/nextcloud/sites
  • GET /apps/nextcloud/sites/{uuid}
  • DELETE /apps/nextcloud/sites/{uuid}
همهٔ ۱۱ endpoint

مترموست

mattermost،  ۱۰ endpoint

سرویس‌های مترموست، تیم‌ها، کاربران، رمز مدیر و کش.

  • GET /apps/mattermost/sites
  • POST /apps/mattermost/sites
  • GET /apps/mattermost/sites/{uuid}
  • DELETE /apps/mattermost/sites/{uuid}
همهٔ ۱۰ endpoint

تیکت پشتیبانی

tickets،  ۵ endpoint

ثبت، پاسخ و بستن تیکت‌های پشتیبانی.

  • GET /tickets
  • POST /tickets
  • GET /tickets/{uuid}
  • POST /tickets/{uuid}/replies
همهٔ ۵ endpoint

گزارش فعالیت

activity،  ۱ endpoint

رویدادهای حساب با فیلتر نوع و شدت.

  • GET /activity
جزئیات

قواعد مشترک

آنچه برای همهٔ endpoint‌ها یکسان است

توکن و دسترسی

هر توکن فقط به scope‌هایی که هنگام ساخت انتخاب کرده‌اید دسترسی دارد؛ درخواست بیرون از آن‌ها پاسخ 403 می‌گیرد.

در راهنمای شروع

محدودیت نرخ

سقف دقیقه‌ای و روزانه برای هر توکن و سقف روزانه برای کل حساب؛ وضعیت در هدرهای X-RateLimit می‌آید.

در راهنمای شروع

کدهای خطا

هر خطا یک کد ثابت ماشین‌خوان دارد، مثل scope_missing یا rate_limited، همراه با شناسهٔ درخواست.

در راهنمای شروع

صفحه‌بندی

سرورها و تراکنش‌ها با limit و offset، تیکت‌ها و فعالیت‌ها با page و per_page؛ بقیهٔ فهرست‌ها یک‌جا برمی‌گردند.

در راهنمای شروع

صفحه‌های مرتبط

معرفی امکانات و کاربردها در صفحهٔ API ابری، تغییرات تازه در فهرست تغییرات و وضعیت لحظه‌ای سرویس‌ها در صفحهٔ وضعیت.

شروع سریع