Tài liệu tham khảo API Trang trạng thái

Lấy danh sách trang trạng thái của bạn

Endpoint:

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

• Số trang mặc định là 1.
• Giá trị per_page mặc định là 50 và tối đa là 100 mục mỗi trang.

Phản hồi ví dụ:

[
  {
    "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"
  }
]

Tạo một trang trạng thái

Endpoint:

POST /v1/pages

Yêu cầu ví dụ:

{
  "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"
}

Phản hồi ví dụ:

{
  "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": []
    }
  ]
}

Cập nhật một trang trạng thái

Endpoint:

PUT /v2/:page_id

Yêu cầu ví dụ:

{
  "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"
    }
  }
}

Email xác nhận

Dùng subscriberConfirmationMode để kiểm soát điều gì xảy ra khi ai đó đăng ký:

• REQUIRED — người đăng ký phải xác nhận qua email trước khi nhận cập nhật. Mặc định.
• WELCOME — người đăng ký được thêm ngay lập tức và nhận một email chào mừng. Chỉ dành cho Pro.
• NONE — người đăng ký được thêm ngay lập tức, không gửi email. Chỉ dành cho Pro.

autoConfirmSubscribers đã lỗi thời. Để tương thích ngược, true tương ứng với NONE và false tương ứng với REQUIRED.

Phản hồi ví dụ:

{
  "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"
    }
  }
}

Xóa một trang trạng thái

Endpoint:

DELETE /v2/:page_id

Phản hồi ví dụ:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm"
}