API 監視

API モニターを使うと、API エンドポイントにアクセスでき、効率よく動作し、正しいデータを返しているかを自動的に検証できます。これにより、アプリケーションや連携が意図したとおりに機能することを確認できます。

他のモニターと同様に、API モニターが問題を検知したら、チームで協力してインシデントを解決し、必要に応じてステータスページを更新できます。

主な機能

• 世界各地のさまざまな地域から、30 秒ごとに API エンドポイントをテストします。
• HTTP ステータスコード、JSON ボディ、ヘッダー、応答時間を検証します。
• カスタムヘッダー、クエリパラメーター、JSON ペイロードを含められます。
• エンドポイントがダウンしている、遅い、想定外の結果を返しているときに、すぐに通知を受け取れます。
• Slack、メール、SMS、電話、Webhook などと連携できます。

最初の API モニターを追加する

モニターを作成するには、プロジェクト → モニター → モニターを追加 と進みます。

モニターの種類

モニターの種類として API を選びます。

監視したいエンドポイントの URL を入力します。例:
https://api.yourservice.com/v1/users

リクエストの設定

API リクエストは細かくカスタマイズできます。

• HTTP メソッド: GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD
• ボディ: JSON、フォームデータ、GraphQL、プレーンテキストをリクエストと一緒に送信します
• 認証: Basic 認証、API キー、Bearer トークンによる認可を追加します
• クエリパラメーター: リクエスト URL にキーと値のペアを追加します
• ヘッダー: API リクエストに必要なカスタムヘッダーを追加します

モニターが成功と判定される条件

API モニターは、指定したすべてのアサーションを満たしたときに成功します。
次のアサーションを 1 つ以上設定できます。

• ステータスコード: 例 — 応答が 200 OK である
• 応答時間: 例 — 1 秒 未満である
• ボディに含まれる: 例 — "success": true
• JSON パス: 例 — data.status が "active" である
• ヘッダーに含まれる: 例 — Content-Type: application/json

いずれかの条件を満たさない場合、モニターは障害とマークされ、アラート設定に従ってアラートが送信されます。

詳細設定

• 表示名: 見分けやすいように、モニターに分かりやすい名前を付けます。
• チェックの実行間隔: エンドポイントをテストする頻度を決めます。
• 実行地域: テストを実行する地域を選びます (アメリカ、カナダ、ヨーロッパ、アジア)。
• ステータスページに追加: API の稼働率と応答の統計を公開表示します。
• モニターが失敗したとき: インシデントを作成する、購読者に通知する、ステータスページに公開する、といった動作を選べます。
• モニターが復旧したとき: インシデントを解決し、ステータスページを自動的に更新します。