מדריך ה‑API של דפי סטטוס

קבלת דפי הסטטוס שלכם

נקודת קצה:

GET /v2/pages?page=:page&per_page=:per_page

• מספר העמוד שמוגדר כברירת מחדל הוא 1.
• ערך ברירת המחדל של per_page הוא 50, והמקסימום הוא 100 פריטים לעמוד.

דוגמת תשובה:

[
  {
    "id": "ckf01fonve9i40a32oas5b0uw",
    "subdomain": "nasa",
    "name": "Nasa",
    "logoUrl": null,
    "faviconUrl": null,
    "websiteUrl": null,
    "customDomain": null,
    "publicEmail": null,
    "twitter": null,
    "status": "UP",
    "subscribeBySms": null,
    "language": "en",
    "useLargeHeader": true,
    "brandColor": "#111",
    "okColor": "rgba(51, 177, 126, 1)",
    "disruptedColor": null,
    "degradedColor": null,
    "downColor": null,
    "noticeColor": null,
    "unknownColor": null,
    "googleAnalytics": null,
    "smsService": null,
    "htmlInMeta": null,
    "htmlAboveHeader": null,
    "htmlBelowHeader": null,
    "htmlAboveFooter": null,
    "htmlBelowFooter": null,
    "htmlBelowSummary": null,
    "launchDate": null,
    "cssGlobal": null,
    "onboarded": null,
    "createdAt": "2020-09-12T19:03:48.379Z",
    "updatedAt": "2020-09-12T19:04:03.731Z"
  }
]

יצירת דף סטטוס

נקודת קצה:

POST /v1/pages

דוגמת בקשה:

{
  "email": "ali@instatus.com",
  "name": "Nasa",
  "subdomain": "nasa",
  "components": ["Website", "App", "API"],
  "logoUrl": "https://instatus.com/sample.png",
  "faviconUrl": "https://instatus.com/favicon-32x32.png",
  "websiteUrl": "https://instatus.com",
  "language": "en",
  "useLargeHeader": true,
  "brandColor": "#111",
  "okColor": "#33B17E",
  "disruptedColor": "#FF8C03",
  "degradedColor": "#ECC94B",
  "downColor": "#DC123D",
  "noticeColor": "#70808F",
  "unknownColor": "#DFE0E1",
  "googleAnalytics": "UA-00000000-1",
  "subscribeBySms": true,
  "smsService": "twilio",
  "twilioSid": "YOUR_TWILIO_SID",
  "twilioToken": "YOUR_TWILIO_TOKEN",
  "twilioSender": "YOUR_TWILIO_SENDER",
  "esendexUsername": "YOUR_ESENDEX_USERNAME",
  "esendexPassword": "YOUR_ESENDEX_PASSWORD",
  "esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF",
  "nexmoKey": null,
  "nexmoSecret": null,
  "nexmoSender": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p"
}

דוגמת תשובה:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "createdAt": "2020-10-13T18:29:25.708Z",
  "subdomain": "nasa",
  "logoUrl": null,
  "faviconUrl": null,
  "websiteUrl": null,
  "name": "Nasa",
  "status": "UP",
  "color": null,
  "language": null,
  "googleAnalytics": null,
  "publicEmail": null,
  "customDomain": null,
  "useLargeHeader": true,
  "disableDarkMode": null,
  "twitter": null,
  "subscribeBySms": null,
  "brandColor": null,
  "okColor": null,
  "disruptedColor": null,
  "downColor": null,
  "degradedColor": null,
  "noticeColor": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "onboarded": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false,
  "allowList": [],
  "components": [
    {
      "id": "ckg8auwlzlcxd09506r3g6y8z",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8auwv7lcxm09506jjate2o",
      "name": "App",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8aux4oo3ik0a35parnbunk",
      "name": "API",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    }
  ]
}

עדכון דף סטטוס

נקודת קצה:

PUT /v2/:page_id

דוגמת בקשה:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "name": "Nasa",
  "status": "UP",
  "subdomain": "nasa",
  "logoUrl": "https://instatus.com/sample.png",
  "faviconUrl": "https://instatus.com/favicon-32x32.png",
  "websiteUrl": "https://instatus.com",
  "language": "en",
  "publicEmail": "hello@nasa.gov",
  "useLargeHeader": true,
  "brandColor": "#111",
  "okColor": "#33B17E",
  "disruptedColor": "#FF8C03",
  "degradedColor": "#ECC94B",
  "downColor": "#DC123D",
  "noticeColor": "#70808F",
  "unknownColor": "#DFE0E1",
  "googleAnalytics": "UA-00000000-1",
  "subscribeBySms": true,
  "smsService": "twilio",
  "twilioSid": "YOUR_TWILIO_SID",
  "twilioToken": "YOUR_TWILIO_TOKEN",
  "twilioSender": "YOUR_TWILIO_SENDER",
  "esendexUsername": "YOUR_ESENDEX_USERNAME",
  "esendexPassword": "YOUR_ESENDEX_PASSWORD",
  "esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF",
  "nexmoKey": null,
  "nexmoSecret": null,
  "nexmoSender": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false,
  "subscriberConfirmationMode": "REQUIRED",
  "translations": {
    "name": {
      "fr": "nasa"
    }
  }
}

אימיילי אישור

השתמשו ב‑subscriberConfirmationMode כדי לקבוע מה קורה כשמישהו נרשם:

• REQUIRED — המנויים חייבים לאשר באימייל לפני שיקבלו עדכונים. ברירת מחדל.
• WELCOME — המנויים נוספים מיד ומקבלים אימייל קבלת פנים. ב‑Pro בלבד.
• NONE — המנויים נוספים מיד ללא אימייל. ב‑Pro בלבד.

השדה autoConfirmSubscribers הוצא משימוש. לצורך תאימות לאחור, true ממופה ל‑NONE ו‑false ממופה ל‑REQUIRED.

דוגמת תשובה:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "createdAt": "2020-10-13T18:29:25.708Z",
  "subdomain": "nasa",
  "name": "Nasa",
  "status": "UP",
  "logoUrl": null,
  "faviconUrl": null,
  "websiteUrl": null,
  "color": null,
  "language": null,
  "googleAnalytics": null,
  "publicEmail": "hello@nasa.gov",
  "customDomain": null,
  "useLargeHeader": true,
  "disableDarkMode": null,
  "twitter": null,
  "subscribeBySms": null,
  "brandColor": null,
  "okColor": null,
  "disruptedColor": null,
  "downColor": null,
  "degradedColor": null,
  "noticeColor": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "onboarded": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false,
  "allowList": [],
  "subscriberConfirmationMode": "REQUIRED",
  "components": [
    {
      "id": "ckg8auwlzlcxd09506r3g6y8z",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8auwv7lcxm09506jjate2o",
      "name": "App",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8aux4oo3ik0a35parnbunk",
      "name": "API",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    }
  ],
  "translations": {
    "name": {
      "fr": "nasa"
    }
  }
}

מחיקת דף סטטוס

נקודת קצה:

DELETE /v2/:page_id

דוגמת תשובה:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm"
}