- 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.
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.
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:
- Getting started with the New Relic REST API (v2) (overview of the New Relic REST API and the structure of an API call)
- API keys (creating, copying, or regenerating an API key from the New Relic user interface)
- Using the API Explorer (using the API Explorer's user interface to get data in and data out of New Relic)
- Parts of the API Explorer (a quick reference for how to use each section of the API Explorer)
- Pagination for API output (how to interpret the Link header for multiple pages of API output)