PulseAPIドキュメント
PulseAPIはAPIエンドポイントを監視し、問題発生時にアラートを送信します。このドキュメントではセットアップ、REST API、主要概念を説明します。
主要概念
エンドポイント
監視したいURL。各エンドポイントは設定可能な間隔(1分~1時間)でHTTPにより確認されます。
チェック
個別の監視プローブ。各チェックはステータスコード、レスポンスタイム、オプションのアサーション結果を記録します。
アラート
2回以上の連続失敗で自動的にトリガーされます。エンドポイント復旧時に回復アラートが送信されます。低速レスポンスアラートは1時間に1回に制限されています。
ステータスページ
エンドポイントの状態、稼働率バー、インシデントを表示する公開ページ。カスタムドメインとブランディングに対応。
インシデント
タイムライン更新、重要度レベル、ポストモーテムで障害を追跡します。サブスクライバーには自動で通知されます。
ベースURL
すべてのAPIエンドポイントはこのベースURLからの相対パスです。
クイック例
# Create an API key in Dashboard > Settings > API Keys, then:
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints
# Create a new endpoint
curl -X POST https://api.pulseapi.tech/endpoints \
-H "Authorization: pk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{"name":"My API","url":"https://api.example.com/health","method":"GET","checkInterval":300,"timeout":10}'
# Check uptime stats
curl -H "Authorization: pk_live_abc123..." \
"https://api.pulseapi.tech/endpoints/ENDPOINT_ID/stats?period=24h"