ابدأ مع واجهة Instatus البرمجية

جميع نقاط النهاية تقع تحت الرابط https://api.instatus.com. وهي تتبع عمومًا نمط REST.

يجب ترميز جميع الطلبات بصيغة JSON مع الترويسة Content-Type: application/json.

كما تُرمَّز استجابات واجهة Instatus البرمجية، بما فيها الأخطاء، بصيغة JSON.

المصادقة

يجب أن ترسل الطلبات المُرسَلة إلى واجهة Instatus البرمجية مفتاح API عبر ترويسة Authorization:

Authorization: Bearer <API_KEY>

أنشئ المفاتيح من لوحة التحكم ← المطوّرون عبر إنشاء مفتاح. يمكنك امتلاك عدة مفاتيح، لكلٍّ منها اسمه الخاص، مثل "GitHub Actions" أو "Terraform". تبدأ المفاتيح بـ inst_sk_.

ما يمكن للمفتاح فعله

لكل مفتاح إعداداته الخاصة:

  • الدور: عضو أو محرّر أو دور مخصّص في خطة Business. يحدد الدور ما يمكن للمفتاح عرضه وتغييره، تمامًا كما يفعل مع الأشخاص. لا يمكن أن يكون المفتاح مالكًا، لذا تبقى الفوترة والأدوار وحذف الأشياء بيد الأشخاص.
  • الوصول: العرض والتغيير أو العرض فقط. المفتاح المضبوط على العرض فقط لا يمكنه تغيير أي شيء، مهما سمح به دوره.
  • المشاريع: كل المشاريع، بما فيها المشاريع التي تضيفها لاحقًا، أو المشاريع التي تختارها فقط.
  • انتهاء الصلاحية: التاريخ الذي يتوقف فيه المفتاح عن العمل. في خطة Free يمكن أن يبقى المفتاح صالحًا حتى 90 يومًا، وفي Pro حتى سنة واحدة، وفي Business وEnterprise لأي مدة، بما في ذلك دون انتهاء صلاحية. يمكن لمالك الفريق تحديد حدّ أقصر في إعدادات الفريق ← مفاتيح API. لا يتأثر بذلك المفاتيح التي أُنشئت قبل إعدادات المفاتيح، وتحتفظ المفاتيح الحالية بتاريخها عند تغيير خطتك.
  • عناوين IP المسموح بها: في خطة Business، لا يعمل المفتاح إلا من عناوين IP أو نطاقاتها التي تحددها.

ينتمي المفتاح إلى الفريق أو إليك:

  • مفاتيح الفريق تظل تعمل عندما يغادر الشخص الذي أنشأها الفريق. استخدمها لـ CI والسكربتات والتكاملات.
  • المفاتيح الشخصية تعمل بصفتك ولا تفعل أبدًا أكثر مما تستطيع أنت فعله. يمكنها استخدام مثلك تمامًا دورًا لها، وتتوقف عن العمل إذا غادرت الفريق.

يضع مالكو الفريق قواعد المفاتيح في إعدادات الفريق ← مفاتيح API: أطول مدة يمكن أن يبقى فيها المفتاح صالحًا، وهل يمكن للأعضاء إنشاء مفاتيح للفريق، وهل يُسمح بالمفاتيح الشخصية.

يظهر إنشاء المفتاح وتغييره وتدويره وإلغاؤه في صفحة النشاط الخاصة بالفريق، وكذلك المفتاح الذي أُلغي لأنه تسرّب. وكل ما يُنفَّذ عبر مفتاح أو تطبيق متصل يظهر هناك بصيغة الشخص عبر اسم المفتاح أو التطبيق.

حافظ على أمان المفاتيح

  • يُعرض المفتاح مرة واحدة فقط، عند إنشائه. انسخه حينها واحفظه كسرّ.
  • لاستبدال مفتاح، افتحه وانقر تدوير. اختر المدة التي يظل فيها المفتاح القديم يعمل، حتى 7 أيام، ليكون لديك وقت لتحديث كل ما يستخدمه.
  • ألغِ المفتاح من قائمته فيتوقف عن العمل فورًا.

المفاتيح التي أُنشئت قبل إعدادات المفاتيح تظل تعمل دون أي تغيير. تظهر بعنوان "أُنشئ قبل إعدادات المفاتيح" في صفحة المطوّرين، حيث يمكنك إضافة قيود إليها أو استبدالها بمفتاح جديد.

أخطاء المفاتيح

عندما لا يُسمح للمفتاح بتنفيذ طلب، يحمل الخطأ أحد هذه الرموز، وتوضّح رسالته ما يجب تغييره.

الرمزالحالةالسبب
invalid_key401المفتاح غير موجود. تحقّق من أنك نسخته كاملًا.
key_expired401تجاوز المفتاح تاريخ انتهاء صلاحيته.
key_revoked401أُلغي المفتاح.
key_owner_left401غادر الفريقَ الشخصُ الذي يعمل المفتاح الشخصي بصفته.
key_view_only403المفتاح مضبوط على العرض فقط والطلب يغيّر شيئًا.
role_not_allowed403دور المفتاح لا يسمح بعرض هذا أو تغييره.
ip_not_allowed403جاء الطلب من عنوان IP لا يسمح به المفتاح.
page_not_allowed403لا يمكن للمفتاح استخدام هذا المشروع.
account_action_not_allowed403لا يمكن للمفاتيح إنشاء الصفحات أو الفرق أو مساحات العمل أو إزالتها. استخدم لوحة التحكم.
route_not_allowed403المسار ليس جزءًا من الواجهة البرمجية الموثّقة.

احصل على معرّف الصفحة

يمكنك العثور على معرّف الصفحة في لوحة التحكم باتباع هذه الخطوات: ١. اذهب إلى لوحة التحكم. ٢. انقر بزر الفأرة الأيمن على مشروعك في الزاوية العلوية اليسرى لفتح القائمة. ٣. انقر Copy Project ID فيُنسخ معرّف الصفحة إلى الحافظة.

معرّف الصفحة

الأخطاء

تحتوي جميع نقاط النهاية على رمز ورسالة داخل استجابات الخطأ.

{
"error": {
"code": "forbidden",
"message": "Not authorized"
}
}

قيم الحالة

حالات الصفحة الممكنة. هذه هي قيمة status التفصيلية التي تعيدها الواجهة البرمجية الحالية (الإصدار v2 وما بعده). أما نقطة النهاية القديمة summary.json وإشعارات الويب هوك فتستخدم صيغة مختصرة تقتصر على UP وHASISSUES وUNDERMAINTENANCE.

  • UP
  • HASISSUES
  • ALLUNDERMAINTENANCE
  • ALLDEGRADEDPERFORMANCE
  • ALLPARTIALOUTAGE
  • ALLMINOROUTAGE
  • ALLMAJOROUTAGE
  • SOMEUNDERMAINTENANCE
  • SOMEDEGRADEDPERFORMANCE
  • SOMEPARTIALOUTAGE
  • SOMEMINOROUTAGE
  • SOMEMAJOROUTAGE
  • ONEUNDERMAINTENANCE
  • ONEDEGRADEDPERFORMANCE
  • ONEPARTIALOUTAGE
  • ONEMINOROUTAGE
  • ONEMAJOROUTAGE

حالات المكوّن الممكنة:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

حالات الحادثة الممكنة:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

حالات الصيانة الممكنة:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

انتقل إلى نقاط النهاية: