Instatus API をはじめる

すべてのエンドポイントは https://api.instatus.com 配下にあります。基本的に REST のアーキテクチャに従っています。

すべてのリクエストは JSON でエンコードし、Content-Type: application/json ヘッダーを付ける必要があります。

Instatus API からのレスポンスは、エラーも含めて JSON でエンコードされます。

認証

Instatus API へのリクエストでは、Authorization ヘッダーで API トークンを渡す必要があります。

API キーは、ユーザー設定 → 開発者設定から取得できます。

Authorization: Bearer <API_KEY>

ページ ID を取得する

ページ ID は、ダッシュボードで次の手順により確認できます。

1. ダッシュボードへ移動します。
2. 左上のプロジェクトを右クリックしてメニューを開きます。
3. Copy Project ID をクリックすると、ページ ID がクリップボードにコピーされます。

エラー

すべての API エンドポイントは、エラーのレスポンスにコードとメッセージを含みます。

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

ステータスの値

ページのステータスとして返る値です。これは現行の API (v2 以降) が返す詳細な status です。従来の summary.json エンドポイントと Webhook 通知は、UP、HASISSUES、UNDERMAINTENANCE のみの簡略な形式を使います。

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

コンポーネントのステータスとして返る値:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

インシデントのステータスとして返る値:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

メンテナンスのステータスとして返る値:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

エンドポイントを見る: