Getting started with New Relic's REST API Explorer

New Relic offers several APIs, including the New Relic REST API. This document introduces you to the REST API Explorer, which allows Admin users and those with the API Key to:

  • Browse the available REST API endpoints.
  • Interact with the REST API within a user interface (the API Explorer).
  • View a live source of documentation.
  • Obtain cURL commands for API actions.
  • Share configured API calls with colleagues by copy and pasting API Explorer's URLs.

This helps you to quickly search for solutions and test your API calls before adding them to your own software components.

Access to metric timeslice data depends on your subscription level. Summary data is the only data available for free New Relic accounts.

Features

New Relic's API Explorer includes an interactive user interface for your selected account. The API Explorer UI lists the types of API calls (Applications, Users, etc.) and their available functions, such as GET Metric Data, PUT (update) Applications, DELETE Applications, etc.

As you type values for Parameters, they automatically appear in the Request so that you can test and verify your syntax before sending the request. The UI indicates required fields, field descriptions, their type (integer, float, Boolean, etc.), and their location (path, query, etc.).

Any Admin user on an account may select the appropriate API key from the dropdown menu. If your account Admin user has provided an API key, enter it in the appropriate API key field.

This is an example of the API Explorer homepage
https://rpm.newrelic.com/api/explore: The New Relic API Explorer makes it easy to test and send requests for any API endpoint. After you select your account and your choice of functions for the type of API call (applications, browsers, users, etc.), the UI provides an interactive form to view requirements and test your parameter values.

Differences from API version 1

This API Explorer applies only to the New Relic REST API version 2, which focuses on data in and data out of New Relic. Version 2 replaces New Relic's deprecated REST API version 1.

Be aware there are some differences between version 2 and 1:

  • Names for data may be different.
  • Some cURL commands for v2 are different than v1.

The New Relic agents use different APIs and are not accessible via the API Explorer.

For more help

Additional documentation resources include:

Recommendations for learning more: