Bắt đầu với API Instatus

Mọi endpoint đều nằm dưới URL https://api.instatus.com. Chúng nhìn chung tuân theo kiến trúc REST.

Mọi yêu cầu phải được mã hóa dưới dạng JSON kèm header Content-Type: application/json.

Phản hồi từ API Instatus, kể cả lỗi, cũng được mã hóa dưới dạng JSON.

Xác thực

Các yêu cầu tới API Instatus phải gửi một khóa API qua header Authorization:

Authorization: Bearer <API_KEY>

Tạo khóa trong Dashboard › Nhà phát triển bằng nút Tạo khóa. Bạn có thể có nhiều khóa, mỗi khóa có tên riêng, chẳng hạn "GitHub Actions" hoặc "Terraform". Khóa bắt đầu bằng inst_sk_.

Khóa có thể làm gì

Mỗi khóa có các cài đặt riêng:

  • Vai trò: Thành viên, Người chỉnh sửa, hoặc một vai trò tùy chỉnh trong gói Business. Vai trò quyết định những gì khóa được xem và thay đổi, giống như với con người. Khóa không thể là Chủ sở hữu, nên việc thanh toán, vai trò và xóa dữ liệu vẫn do con người đảm nhận.
  • Quyền truy cập: Xem và thay đổi hoặc Chỉ xem. Khóa Chỉ xem không thể thay đổi bất cứ thứ gì, dù vai trò của nó cho phép gì.
  • Dự án: tất cả dự án, kể cả những dự án bạn thêm sau này, hoặc chỉ những dự án bạn chọn.
  • Hết hạn: ngày khóa ngừng hoạt động. Ở gói Free, khóa có thể dùng tối đa 90 ngày, ở gói Pro tối đa 1 năm, còn ở gói Business và Enterprise thì bao lâu tùy bạn, kể cả không bao giờ hết hạn. Chủ sở hữu nhóm có thể đặt giới hạn ngắn hơn trong Cài đặt nhóm › Khóa API. Các khóa được tạo trước khi có cài đặt khóa không bị ảnh hưởng, và các khóa hiện có vẫn giữ nguyên ngày hết hạn khi gói của bạn thay đổi.
  • IP được phép: trong gói Business, khóa chỉ hoạt động từ các địa chỉ hoặc dải IP bạn liệt kê.

Một khóa thuộc về nhóm hoặc thuộc về bạn:

  • Khóa nhóm vẫn hoạt động khi người tạo ra chúng rời nhóm. Hãy dùng chúng cho CI, script và tích hợp.
  • Khóa cá nhân hoạt động với tư cách của bạn và không bao giờ làm được nhiều hơn bạn. Chúng có thể dùng vai trò Giống bạn, và sẽ ngừng hoạt động nếu bạn rời nhóm.

Chủ sở hữu nhóm đặt quy tắc cho khóa trong Cài đặt nhóm › Khóa API: thời hạn dài nhất của một khóa, thành viên có được tạo khóa nhóm hay không, và có cho phép khóa cá nhân hay không.

Việc tạo, thay đổi, xoay vòng và thu hồi khóa đều hiển thị trong mục Hoạt động của nhóm, kể cả khi khóa bị thu hồi vì bị lộ. Mọi thao tác thực hiện qua khóa hoặc ứng dụng đã kết nối đều hiển thị ở đó dưới dạng người qua tên khóa hoặc ứng dụng.

Giữ khóa an toàn

  • Khóa chỉ hiển thị một lần, khi bạn tạo nó. Hãy sao chép ngay lúc đó và lưu như một thông tin bí mật.
  • Để thay khóa, hãy mở khóa và nhấn Xoay vòng. Chọn khoảng thời gian khóa cũ còn hoạt động, tối đa 7 ngày, để bạn kịp cập nhật mọi thứ đang dùng nó.
  • Thu hồi khóa từ menu của nó và khóa sẽ ngừng hoạt động ngay lập tức.

Các khóa được tạo trước khi có cài đặt khóa vẫn hoạt động như cũ. Chúng hiển thị là "Tạo trước khi có cài đặt khóa" trong trang Nhà phát triển, nơi bạn có thể thêm giới hạn cho chúng hoặc thay chúng bằng một khóa mới.

Lỗi về khóa

Khi một khóa không thể thực hiện một yêu cầu, lỗi trả về có một trong các mã sau, và thông điệp cho biết bạn cần thay đổi gì.

MãTrạng tháiLý do
invalid_key401Khóa không tồn tại. Hãy kiểm tra bạn đã sao chép đầy đủ chưa.
key_expired401Khóa đã quá ngày hết hạn.
key_revoked401Khóa đã bị thu hồi.
key_owner_left401Người mà khóa cá nhân đại diện đã rời nhóm.
key_view_only403Khóa là Chỉ xem nhưng yêu cầu lại thay đổi dữ liệu.
role_not_allowed403Vai trò của khóa không được xem hoặc thay đổi mục này.
ip_not_allowed403Yêu cầu đến từ một địa chỉ IP mà khóa không cho phép.
page_not_allowed403Khóa không được dùng dự án này.
account_action_not_allowed403Khóa không thể tạo hoặc xóa trang, nhóm hay không gian làm việc. Hãy dùng dashboard.
route_not_allowed403Đường dẫn này không thuộc API đã được tài liệu hóa.

Lấy ID trang của bạn

Bạn có thể tìm ID trang trong dashboard theo các bước sau:

  1. Vào dashboard của bạn.
  2. Nhấp chuột phải vào dự án ở góc trên bên trái để mở menu.
  3. Nhấp Copy Project ID và ID trang của bạn sẽ được sao chép vào clipboard.
ID trang

Lỗi

Mọi endpoint API đều chứa một mã và một thông điệp trong phản hồi lỗi.

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

Các giá trị trạng thái

Các trạng thái trang có thể có. Đây là giá trị status chi tiết do API hiện tại (v2 trở lên) trả về. Endpoint summary.json cũ và thông báo webhook dùng dạng rút gọn chỉ gồm UP, HASISSUES và UNDERMAINTENANCE.

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

Các trạng thái thành phần có thể có:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Các trạng thái sự cố có thể có:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Các trạng thái bảo trì có thể có:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Chuyển đến các endpoint: