New Relicでは、New Relic REST APIを含む、複数のAPIを提供しています。このドキュメントで紹介するREST APIエクスプローラーでは、アドミンユーザーおよびAPIキーを持つユーザーは以下を実行できます:
- 利用可能なREST APIエンドポイントの参照
- ユーザーインターフェース(API Explorer)内でのREST APIとのインタラクション
- ドキュメンテーションの随時更新ソースの表示
- APIアクション向けcURLコマンドの取得。
- API ExplorerのURLをコピー・アンド・ペーストによる、同僚との構成済みAPIコールの共有
こうして、ご利用のソフトウェアコンポーネントに追加する前に、ソリューションを素早く検索してAPIコールをテストできます。
インフラストラクチャ の REST APIコールは、 APIエクスプローラーでは使用できません。
特徴
New RelicのAPI Explorer には、選択したアカウント用のインタラクティブなユーザー インターフェースが含まれています。 APIエクスプローラーUIは、 APIコールのタイプ (Applications、Users など) と、使用可能な関数 (GET metric data、PUT (update) applications、DELETE applications など) が一覧表示されます。
Parametersに値を入力すると、その値はRequestに自動的に表示されるので、リクエストを送信する前に構文をテストして検証できます。 UI 、必須フィールド、フィールドの説明、そのタイプ (整数、フロート、ブール値など)、およびその場所 (パス、クエリなど) が表示されます。
APIキーの要件に関する情報は、REST APIキーをご覧ください。
rpm.newrelic.com/api/explore: New Relic API Explorer を使用すると、あらゆるAPIのテストやリクエストの送信が簡単になります。 アカウントを選択し、 APIコールのタイプ (アプリケーション、ブラウザ、ユーザーなど) に応じた機能を選択すると、 UI 、要件を表示し、パラメーターの値をテストするための対話型フォームが表示されます。
APIバージョン1との違い
このAPI Explorerが適用されるNew Relic REST APIバージョン2は、New Relicに出入りするデータに焦点を当てたものです。バージョン2は、New Relicの非推奨となったREST APIバージョン1を置き換えます。
バージョン2と1には、いくつかの違いがある点に注意してください:
- データの名前が異なる可能性があります
- v2の一部のcURLコマンドが、v1とは異なる可能性があります
ヒント
New Relicエージェントは異なるAPIを使用しており、API Explorerを介してアクセスすることはできません。