ドットコムモニタAPIは、Dotcom-Monitorサービスの強力な監視および負荷テスト機能にアクセスするためのシンプルで構造化された方法を提供します。
Web API 統合 ( > 統合の管理 > 新しい統合) を構成する場合は、Web API を介して Dotcom-Monitor アカウント以外のデータへのアクセスを有効にする必要があります。 詳細については、「 Web API アクセスの IP をホワイトリストに登録する方法 」を参照してください。
ベース URL
ドットコムモニタ API は HTTP/HTTPS 経由で提供されます。
ドキュメント内で参照されるすべての URI には、次の基本があります。
| https://api.dotcom-monitor.com/config_api_v1/ |
|---|
認証
すべての要求には、事前認証が必要です。 60 秒間の非アクティブ状態の後、認証は期限切れになります。
API 認証 セクションでは、認証プロセスを案内します。
Web API サービスを介して、すべての認証済み要求に対して、または信頼できる IP アドレスからの認証済み要求に対してのみ、ドットコムモニター アカウントのデータへのアクセスを有効にすることができます。 ウィキの「 Web API アクセスの IP をホワイトリストに登録する方法 」の記事を参照してください。
MIME タイプ
API は、要求と応答の両方に対して、サービス全体で JSON をデータ形式として使用します。
アプリは、要求本文で JSON を送信する場合にのみ、コンテンツタイプ HTTP ヘッダーを “アプリケーション/json” に設定する必要があります。
メソッド
すべての読み取りメソッドは HTTP/HTTPS GET 要求です。
すべての書き込みメソッドは、HTTP/HTTPS POST または PUT 要求です。
エラー
「エラー処理」の記事には、エラーがどのように反映されるかについて説明します。
API の使用
- API の概要 セクションには、アプローチの概要が含まれています。
- LoadView メソッド と モニタリングメソッド セクションには、リソースのリスト、対応するエンドポイントの説明、および関連するパラメーターの詳細な概要を含む JSON オブジェクトの例を含むメソッドが含まれています。
- コード例 セクションには、開発者が構築できる適切なコメントが付いたコード パターンがあります。