Instatus API をはじめる

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

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

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

認証

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

Authorization: Bearer <API_KEY>

キーは、ダッシュボード › 開発者の キーを作成 から作成します。キーは複数持つことができ、それぞれに「GitHub Actions」や「Terraform」のような名前を付けられます。キーは inst_sk_ で始まります。

キーでできること

キーごとに次の設定があります。

  • ロール: メンバー、編集者、または Business プランのカスタムロール。ロールは、人の場合と同じように、キーが閲覧・変更できる範囲を決めます。キーをオーナーにすることはできないため、請求、ロール、削除の操作は人だけが行えます。
  • アクセス: 表示と変更 または 表示のみ。表示のみのキーは、ロールで許可されていても何も変更できません。
  • プロジェクト: 今後追加するものも含めたすべてのプロジェクト、または選んだプロジェクトのみ。
  • 有効期限: キーが使えなくなる日付。Free プランでは最長 90 日、Pro では最長 1 年、Business と Enterprise では無期限を含めて好きな長さにできます。チームのオーナーは、チーム設定 › API キーでこれより短い上限を設定できます。キー設定の導入前に作成したキーには影響せず、既存のキーはプランが変わっても日付が変わりません。
  • 許可する IP: Business プランでは、指定した IP アドレスまたは範囲からのみキーが使えます。

キーはチームかあなた個人のどちらかに属します。

  • チームキー は、作成した人がチームを離れても使い続けられます。CI、スクリプト、連携に使ってください。
  • 個人キー はあなたとして動作し、あなたができる以上のことは決してしません。ロールに あなたと同じ を使うことができ、あなたがチームを離れると使えなくなります。

チームのオーナーは、チーム設定 › API キーでキーのルールを決めます。キーの最長有効期間、メンバーがチームキーを作成できるかどうか、個人キーを許可するかどうかを設定できます。

キーの作成、変更、ローテーション、取り消しはチームのアクティビティに表示され、漏えいにより取り消されたキーも同様です。キーや接続したアプリを通じて行われた操作は、そこに「人(キーまたはアプリの名前 経由)」の形で表示されます。

キーを安全に保つ

  • キーが表示されるのは作成時の一度だけです。その場でコピーし、シークレットとして保管してください。
  • キーを置き換えるには、キーを開いて ローテーション をクリックします。古いキーを使い続けられる期間を最長 7 日まで選べるので、そのキーを使っているすべての場所を更新する時間があります。
  • メニューからキーを取り消すと、すぐに使えなくなります。

キー設定の導入前に作成したキーは、これまでどおり使えます。開発者ページでは「キー設定の導入前に作成」と表示され、そこで制限を追加したり、新しいキーに置き換えたりできます。

キーのエラー

キーでリクエストを実行できない場合、エラーには次のいずれかのコードが含まれ、メッセージで何を変更すればよいかが示されます。

コードステータス理由
invalid_key401キーが存在しません。キー全体をコピーしたか確認してください。
key_expired401キーの有効期限が切れています。
key_revoked401キーは取り消されています。
key_owner_left401個人キーの持ち主がチームを離れました。
key_view_only403キーが表示のみで、リクエストが何かを変更しようとしています。
role_not_allowed403キーのロールでは、この対象を閲覧または変更できません。
ip_not_allowed403キーで許可されていない IP アドレスからのリクエストです。
page_not_allowed403キーはこのプロジェクトを使えません。
account_action_not_allowed403キーではページ、チーム、ワークスペースを作成・削除できません。ダッシュボードを使ってください。
route_not_allowed403このルートはドキュメントに記載された API に含まれていません。

ページ ID を取得する

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

  1. ダッシュボードへ移動します。
  2. 左上のプロジェクトを右クリックしてメニューを開きます。
  3. Copy Project ID をクリックすると、ページ 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

エンドポイントを見る: