# UptimeScout API ドキュメント

REST、SDK、MCPを通じて、サービス状況、地域ごとのシグナル、履歴を確認できます。ダッシュボードを構築し、AIアシスタントに明確な稼働状況の情報を提供しましょう。

URL: https://uptimescout.com/ja/docs/

## REST

```sh
curl -G https://api.uptimescout.com/v1/status --data-urlencode "service=github" --data-urlencode "region=US" -H "Authorization: Bearer $EVELODE_LICENSE_KEY"
```

## 利用可能なメソッド

- `GET /v1/services`: サービスカタログを検索し、ページごとに取得します。

- `GET /v1/status`: 1つのサービスの現在保存されている状況を取得します。

- `GET /v1/statuses`: 複数サービスの状況を1回のリクエストで取得します。

- `GET /v1/summary`: 地域または選択したサービスの観測シグナルを要約します。

- `GET /v1/history`: 保存された経時的な観測データをページごとに取得します。

- `GET /v1/stats`: 実測稼働率ではなく、保存されたシグナルサンプルの比率を算出します。

- `GET /v1/incidents`: 注意シグナルがあるサービスを一覧表示します。世界規模のインシデントが確認されたことを示すものではありません。

## データの仕組み

UptimeScoutは、バックグラウンドで地域ごとの観測データを保存します。各応答には観測時刻とデータの鮮度に関する情報が含まれます。同じサービスでも、地域によって異なるシグナルが得られる場合があります。

正常シグナルは、保存されたサンプルで問題を示すシグナルが観測されなかったことを示します。注意シグナルまたは障害シグナルは観測された状況を示すもので、世界規模のインシデントが確認されたことを意味しません。観測データがない場合や古い場合は、不明として扱われます。サンプルの比率は、実測稼働率や SLA ではありません。

画面は毎分更新されます。状況がどれだけ最新かを判断するには、各サービスの観測時刻とデータの鮮度をご確認ください。

言語は情報の表示方法を決め、観測地域はデータがどの国を対象としているかを決めます。両者は個別に切り替えられます。ページを翻訳しても、特定の国の観測結果が自動的に表示されるわけではありません。

## ライセンスとリクエスト上限

Evelode ライセンスキーを Bearer トークンとして使用してください。キーはサーバー上で管理し、ブラウザーのコードや公開リポジトリには含めないでください。データ取得に成功したリクエストのみ、利用枠を消費します。ライセンスの更新またはプランの変更で、新しい利用枠が開始されます。暦月ごとのリセットはありません。年間プランでは、月間プラン1期間分の12倍のリクエスト枠を、年間ライセンス期間全体で1つの枠として利用します。

## AI アシスタントに接続

以下のエンドポイントにStreamable HTTP対応のMCPクライアントを接続し、Authorizationヘッダーにライセンスキーを指定してください。読み取り専用ツールを7つ利用でき、サービス状況、地域ごとのシグナル、履歴を確認できます。ライセンスの利用制限は同じです。

https://mcp.uptimescout.com

## レスポンスの確認

データを読み取る前に HTTP ステータスを確認してください。400 はパラメーターが無効、401 または 403 は認証またはライセンスの問題、409 はリクエスト処理中にライセンスの利用資格が変更されたこと、429 はリクエスト数またはレートの上限、503 は一時的な利用不可を示します。再試行までの待機時間を守り、短い間隔での再試行を繰り返さないでください。

OpenAPI: https://uptimescout.com/openapi.json
