בואו נתחיל עם ה‑API של Instatus

כל נקודות הקצה נמצאות תחת הכתובת https://api.instatus.com. הן פועלות באופן כללי לפי ארכיטקטורת REST.

כל הבקשות חייבות להיות מקודדות כ‑JSON עם הכותרת Content-Type: application/json.

התשובות מה‑API של Instatus, כולל שגיאות, מקודדות אף הן כ‑JSON.

אימות

בקשות ל‑API של 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הנתיב הזה לא חלק מה‑API המתועד.

איך משיגים את מזהה הדף

אפשר למצוא את מזהה הדף שלכם בדאשבורד לפי השלבים הבאים:

  1. עברו לדאשבורד שלכם.
  2. לחצו לחיצה ימנית על הפרויקט בפינה השמאלית העליונה כדי לפתוח את התפריט.
  3. לחצו על העתקת מזהה הפרויקט ומזהה הדף יועתק ללוח.
מזהה דף

שגיאות

כל נקודות הקצה של ה‑API מחזירות קוד והודעה בתוך תשובות השגיאה.

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

ערכי סטטוס

סטטוסים אפשריים של דף. זהו ערך ה‑status המפורט שמוחזר על ידי ה‑API הנוכחי (v2 ואילך). נקודת הקצה הישנה summary.json והתראות ה‑webhook משתמשות בצורה מקוצרת עם 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

מעבר לנקודות הקצה: