New RelicのREST APIを使用すると、New Relicツールからデータの取得、New Relicツールへのデータのプッシュ、機能の設定、削除操作を実行できます。APIエクスプローラーを使用して、REST APIを介して利用できるデータを理解したり、cURLコマンドを取得したり、JSON応答を表示したりすることもできます。
セットアップ
REST APIコマンド構造は、次のテンプレートに従います。
GETコマンドはクエリの目的に応じて、POSTまたはDELETEでも可能です。
プレースホルダーを理解するには、読み進めてください。
ヒント
当社の例では、cURLを共通のコマンドラインツールとして使用し、REST APIからメトリックタイムスライスのデータを引き出します。ただし、RESTリクエストには任意の方法を使用できます。curlコマンドには、任意のリクエストメカニズムに関連するターゲットURL、ヘッダー情報、およびデータが含まれます。
URL
APIコールには、データにアクセスする場所を指定するURLが必要になります。プレースホルダ<URL>は、リクエストされているデータのタイプに応じて変化する適切なURLに置き換える必要があります。通常、URLはこのテンプレートに従います。
https://api.newrelic.com/v2/applications/$APP_ID/metrics/data.json$APP_IDは、データがリクエストされているアプリケーションまたは製品そのものを指定します。このパラメーターに続く情報は、リクエストするデータに応じて異なります。
EUリージョンのアカウントがある場合は、次のURLになります:
api.eu.newrelic.com/v2/applications/$APP_ID/metrics/data.jsonヒント
.jsonを.xmlに置き換えることで、JSONの代わりにXMLデータを取得できます。
APIキー $API_KEY
New Relic APIコールにはAPIキーが必要です。これはいくつかのAPIキーの1つです。
- ユーザーキー：これが推奨されます。これは当社の最新のキー実装で、REST APIキーよりも制限が少なくなっています。ユーザーキーは、NerdGraph APIでも使用されます。
- REST APIキー：これは当社の古いキー実装です。この詳細については、「REST APIキー」をご覧ください。このキーを使用する場合、必要なヘッダーは
X-Api-Keyで、Api-Keyではありません。 - New Relicパートナーシップアカウントをお持ちの場合、別のキーを使用します。「パートナーシップ認証」をご覧ください。
REST APIの例では、当社はUnixシェルプログラミングのAPIキープレースホルダー$API_KEYを使用しています。コールを作成する時は、このプレースホルダーとその他のユーザー固有の変数を置き換えてください。
クエリの詳細（ペイロード）
PAYLOADには、次を定義するクエリの詳細が含まれています。
例
REST APIの使用事例については、以下のドキュメントを参照してください。
- APMの例（APMのメトリックタイムスライス データを取得する方法）。
- ブラウザの例（ブラウザモニタリングのメトリックタイムスライスを取得する方法）。REST APIは、Lite Browserエージェントスクリプトのみを返します。詳しくは、Lite、Pro、Pro+SPAタイプを比較するこの表を参照してください。
- Infrastructureアラートの例
- アラートの例（アラート条件の作成や通知チャネルの設定など）。