公開 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 は、各コンポーネントとその現在のステータスを返します。

レスポンスの形式と返りうるステータスの一覧は、公開されているデータを参照してください。