公开 API

每个状态页都可以对外提供一个小型只读 API,客户可以把你的当前状态拉取到自己的看板、脚本或健康检查中。

启用公开 API

instatus.com/login 登录 Instatus,然后选择你的状态页。

  1. 进入状态页 → 通知
  2. 开启 API
  3. 点击保存

之后 API 会出现在状态页的获取状态更新菜单中,指向一个参考页面,其中用你自己页面的实时响应说明各个端点。

端点

your-status-page-url/v3/summary.json
your-status-page-url/v3/components.json

summary.json 返回页面的整体状态,以及所有进行中的事件和维护。components.json 返回每个组件及其当前状态。

响应格式和可能的状态列表见公开可用数据