New Relicでは、New Relic REST APIを含む、複数のAPIを提供しています。このドキュメントで紹介するREST APIエクスプローラーでは、アドミンユーザーおよびAPIキーを持つユーザーは以下を実行できます:
- 利用可能なREST APIエンドポイントの参照
- ユーザーインターフェース(API Explorer)内でのREST APIとのインタラクション
- ドキュメンテーションの随時更新ソースの表示
- APIアクション向けcURLコマンドの取得。
- API ExplorerのURLをコピー・アンド・ペーストによる、同僚との構成済みAPIコールの共有
こうして、ご利用のソフトウェアコンポーネントに追加する前に、ソリューションを素早く検索してAPIコールをテストできます。
InfrastructureのREST API呼び出しは、APIエクスプローラーでは利用できません。
機能
New RelicのAPI Explorerには、選択されたアカウント向けにインタラクティブなユーザーインタフェースが含まれています。API Explorer UIは、APIコール(アプリケーション、ユーザー等)ならびに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を介してアクセスすることはできません。