Statuspage の異なる API は何ですか?

非公開ページまたはトライアル ページでステータス API を使用するには、API キーを認証ヘッダーとして渡す必要があります。詳細については、下記の FAQ をご参照ください。

はじめに

Statuspage には、ステータス ページをプログラムで管理してアップデートする際に使用できる認証 API と、独自の Web サイトやアプリケーションでシステム ステータスを表示するためのページ情報の消費に使用できるページ レベルのステータス API の、2 つの API があります。

API を管理

認証 API は、ステータス ページに変更を加えたりアップデートしたりする際に使用できます。この API を使用して、コンポーネント、インシデント、サブスクライバー、指標、チーム メンバーなどを作成できます。管理 API エンドポイントは developer.statuspage.io で利用できます。

ステータス API

各ステータス ページには、専用の一連のエンドポイントがあります。当社のお客様の多くはステータス API を使用して、ユーザー/顧客向けのステータス アラートを独自のアプリケーションのユーザー インターフェイスまたはヘルプ ポータルに直接埋め込んでいます。

非公開ページまたはトライアル ページでは CORS は許可されません。認証 API へのアクセスが必要なリクエストには、API プロキシを使用する必要があります。これによって、カスタム HTML ページが認証ヘッダー不要でローカル API プロキシにアクセスできるようになり、その後必要なヘッダーが追加されて下流の API に送信されます。

FAQ

ステータス API を非公開ページで使用できますか?

はい。ただし、ステータス API へのリクエストでは、API キーを認証ヘッダーとして送信する必要があります。該当の非公開ステータス ページにアクセスできない人にステータス情報が漏洩されることは望ましくないため、これは意図的な動作です。

ここでの提案は、API キーを追加してそれらのリクエストを Statuspage に渡す単純なプロキシを作成することです。

ステータス API を公開トライアル ページで使用できますか?

はい。ただし、ステータス API へのリクエストでは、API キーを認証ヘッダーとして送信する必要があります。そうしないと、Statuspage の API が有料サブスクリプションにサイン アップせずトライアルの Statuspage で使用できるようになるため、これは意図的な動作です。ページを有効にして有料の公開ページにすると、この制限が解除されます。

ここでの提案は、API キーを追加してそれらのリクエストを Statuspage に渡す単純なプロキシを作成することです。

Statuspage は読み取り専用の API キーを提供していますか?

現在はサポートされていません。

Statuspage はアカウント全体の API キーを提供していますか?

いいえ。API キーはチーム メンバー (管理者) アカウントに関連付けられています。

回数制限はどうなっていますか?

管理 API は、1 分あたり 60 回のリクエストに制限されています。ステータス API は回数制限されません。

特定のエンドポイントは無効にできますか?

いいえ。エンドポイントのアクティブ/非アクティブは設定できません。