Use the API Explorer

New Relic's REST API Explorer (v2) makes it easy to test and send requests for any available API endpoint. After you select your choice of functions for the type of API call (applications, browsers, etc.), the user interface provides an interactive form to view requirements and test your parameter values. It also provides a live source of documentation about the API values.

Provide your API key

Before you can use the API Explorer, API access must be activated and an API key must be generated for your account.

  • If you are signed in to New Relic as an Admin user on your account, when you use the API Explorer your API key will appear automatically in the Request and Parameters sections of the user interface.
  • If you are not signed in to New Relic when you use the API Explorer, or you are not an Admin user but have been given the API Key, you can paste your API key into the API Explorer's Parameters.

For master accounts with sub-accounts, each sub-account has its own API keys. Make sure you are using the correct one.

Access the API Explorer

To use the New Relic API Explorer:

  1. Go to rpm.newrelic.com/api/explore.
  2. Select your account and API call:

    Admin users
    1. From the API Explorer's menu bar, select the account name for your app from the dropdown list.
    2. From the sidebar, select a product (Applications, Browsers, etc.) and an available API function: GET, PUT, DELETE.
    Non-admin users
    1. From the sidebar, select a product (Applications, Browsers, etc.) and an available API function: GET, PUT, DELETE.
    2. Enter the API key (must be supplied by an admin in your account) in the API key field.
  3. Type the other Parameters values for your API call. (Refer to the UI for descriptions and requirements for v2.)
  4. Select the format for your request: JSON or XML.
  5. Select Send Request.

For more information, see Parts of the API Explorer.

For more help

Recommendations for learning more: