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

وضعیت سرویس‌ها

وضعیت خود پلتفرم، نه پروژه‌های شما: هر بخش، دسترس‌پذیری ۹۰ روز، رخدادها، نگهداری‌ها و اشتراک خبرها؛ بدون کلید.

توضیح هر مسیر به انگلیسی است، همان متنی که مرجع از کد ساخته می‌شود. مسیرها، نام فیلدها و کدها همان‌اند که در درخواست می‌نویسید.
GET/v1/status

The platform's status page#

The status of our own services, not your projects: the overall status, each component (dashboard, api, functions, apps, databases, caches, storage, builds, dns) with its current status, 90-day uptime and one entry a day (Tehran days, oldest first: the worst status that lasted a minute, the uptime, the minutes of each status and the incidents that touched it), open incidents, scheduled and running maintenance, the last 15 days' incidents and the ways to subscribe. Checked every minute; cached 15 s. Uptime counts a minute of major outage whole and of partial outage 30 %; degraded counts as up; announced maintenance is left out. Names and texts come in Persian and English ({fa, en}). Auth: none. CORS: *.

دسترسی
بدون اعتبارنامه

پاسخ

200PlatformStatus

  • statusPlatformStatusValue
  • updated_atstring (date-time)
  • page_urlstring
  • componentsobject[]
  • incidentsPlatformIncident[]
  • maintenancePlatformIncident[]
  • recentPlatformIncident[]
  • channelsobject

نمونه

curl "https://api.ibel.ai/v1/status"
GET/v1/status/summary

The status in one line#

The overall status, the components that are not operational, open incidents and maintenance (what the dashboard's footer and cloudhost status show). Auth: none. CORS: *.

دسترسی
بدون اعتبارنامه

پاسخ

200object

  • statusPlatformStatusValue
  • updated_atstring (date-time)
  • page_urlstring
  • componentsobject[]
  • incidentsobject[]
  • maintenanceobject[]

نمونه

curl "https://api.ibel.ai/v1/status/summary"
GET/v1/status/incidents

Incident history#

Past and current incidents and maintenance (not those still only scheduled), newest first, with every update. Page with before (the next_before of the page before). Auth: none.

دسترسی
بدون اعتبارنامه

پارامترها

  • limitintegerکوئری

    1–50 · default 20

  • beforestring (date-time)کوئری

    an RFC 3339 time; incidents that started before it

  • kindstringکوئری

    one of incident, maintenance

پاسخ

200object

  • itemsPlatformIncident[]
    • idstring (uuid)
    • kindstring

      one of incident, maintenance

    • titleBilingual
    • impactstring

      one of none, minor, major, critical, maintenance

    • statusstring

      one of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled

    • componentsobject[]
    • starts_atstring (date-time)
    • ends_atstring (date-time)
    • started_atstring (date-time)
    • resolved_atstring (date-time)
    • updated_atstring (date-time)
    • updatesobject[]
  • next_beforestring (date-time)

خطاها

وضعیتتوضیح
400Bad request: bad_request, bad_param, bad_code

نمونه

curl "https://api.ibel.ai/v1/status/incidents"
GET/v1/status/incidents/{id}

One incident#

An incident or maintenance with every update, newest first. Auth: none.

دسترسی
بدون اعتبارنامه

پارامترها

  • idstring (uuid)مسیرالزامی

پاسخ

200PlatformIncident

  • idstring (uuid)
  • kindstring

    one of incident, maintenance

  • titleBilingual
  • impactstring

    one of none, minor, major, critical, maintenance

  • statusstring

    one of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled

  • componentsobject[]
  • starts_atstring (date-time)
  • ends_atstring (date-time)
  • started_atstring (date-time)
  • resolved_atstring (date-time)
  • updated_atstring (date-time)
  • updatesobject[]

خطاها

وضعیتتوضیح
404Not found: not_found

نمونه

curl "https://api.ibel.ai/v1/status/incidents/88e2fe1d-6d75-4de5-8c8f-27380ec66903"
GET/v1/status/feed.rss

Incidents as RSS#

The last 30 incidents and maintenance with their updates, as RSS 2.0 (/v1/status/feed.atom: the same as Atom). lang=en for English. The status page serves the same feeds at /feed.rss and /en/feed.rss. Auth: none.

دسترسی
بدون اعتبارنامه

پارامترها

  • langstringکوئری

    one of fa, en · default "fa"

پاسخ

200stringapplication/rss+xml

نمونه

درخواست
curl "https://api.ibel.ai/v1/status/feed.rss"
GET/v1/status/feed.atom

Incidents as Atom#

The same as the RSS feed, as Atom. Auth: none.

دسترسی
بدون اعتبارنامه

پارامترها

  • langstringکوئری

    one of fa, en · default "fa"

پاسخ

200stringapplication/atom+xml

نمونه

درخواست
curl "https://api.ibel.ai/v1/status/feed.atom"
POST/v1/status/subscribe

Subscribe to incident updates#

By email (a confirmation link, valid 24 hours) or SMS (a 6-digit code, valid 10 minutes). Nothing is sent until it is confirmed; every message has an unsubscribe link. An address already subscribed gets a note saying so, not a second subscription. Bale, Eitaa and RSS need no subscription (see channels in GET /v1/status). Limits: 10 a network per hour, 5 SMS a network per day, 3 messages an address per day. Auth: none.

دسترسی
بدون اعتبارنامه

بدنهٔ درخواستapplication/json

  • channelstringالزامی

    one of email, sms

  • targetstringالزامی

    an email address, or an Iranian mobile number

  • langstring

    one of fa, en · default "fa"

  • componentsstring[]

    only updates touching these components; none for all

پاسخ

200objectSent

  • sentboolean
  • confirmstring

    one of link, code

خطاها

وضعیتتوضیح
400Bad request: bad_request, bad_param, bad_code
429Too many requests: rate_limited

نمونه

curl -X POST "https://api.ibel.ai/v1/status/subscribe" \
  -d '{"channel":"email","target":"…"}'
POST/v1/status/subscribe/confirm

Confirm a subscription#

{token} from the email's link, or {channel: "sms", target, code}. A code allows 5 tries. Auth: none.

دسترسی
بدون اعتبارنامه

بدنهٔ درخواستapplication/json

  • tokenstring
  • channelstring

    one of sms

  • targetstring
  • codestring

پاسخ

200objectConfirmed

  • confirmedboolean
  • channelstring
  • langstring
  • componentsstring[]
  • manage_tokenstring

خطاها

وضعیتتوضیح
400Bad request: bad_request, bad_param, bad_code

نمونه

curl -X POST "https://api.ibel.ai/v1/status/subscribe/confirm" \
  -d '{"token":"…","channel":"sms","target":"…","code":"123456"}'
POST/v1/status/unsubscribe

Unsubscribe#

{token}: the one in every message's unsubscribe link. Auth: none.

دسترسی
بدون اعتبارنامه

بدنهٔ درخواستapplication/json

  • tokenstringالزامی

پاسخ

200objectUnsubscribed

  • unsubscribedboolean

خطاها

وضعیتتوضیح
404Not found: not_found

نمونه

curl -X POST "https://api.ibel.ai/v1/status/unsubscribe" \
  -d '{"token":"…"}'