Types of New Relic API keys

New Relic has several types of APIs that require their own API keys. This resource describes our API keys, what they are used for, and how to access them.

Manage API keys in UI

Here's a direct link to the API keys UI page. To find this from the New Relic UI:

  1. From the account dropdown, select Account settings.
  2. Select API keys.

Overview of API keys

Different APIs use different types of API keys.

Key type What it's for Where to access

User key

(aka "personal API key")

Used for NerdGraph (our GraphQL API) and for accessing REST API endpoints (dependent on user permissions).

API keys UI

License key

Allows ingest of data from APM agents, the infrastructure agent, and from our metric, event, log, and trace APIs and the tools that use them.

API keys UI

Insights insert key

Allows ingest of events via HTTPS request. Used by our metric, log, trace, and event APIs and the tools that use those APIs.

Go to the API keys UI and click Insights insert key.

Browser key

Allows ingest of browser monitoring data.

API keys UI

Mobile key

(aka "mobile app token")

Allows mobile monitoring data to be sent to New Relic.

See Mobile app token.

REST API key

Note: we recommend using the user key instead because it has fewer limitations. The REST API key is for using our REST APIs for Alerts, APM, Browser, Infrastructure alerts, as well as Mobile REST APIs and the API Explorer.

Go to the API keys UI and click REST API key.

Admin API key

Note: we recommend using the user key instead because it has fewer limitations. The Admin API key is available only to Admin users on our original user model. Provides admin-only functionality with the REST API and API Explorer or with Synthetics API.

Go to the API keys UI and click REST API key.

Insights query key

This key allows use of the Insights query API. Note: we now recommend using NerdGraph to query New Relic data.

Go to the API keys UI and click Insights query key.

User key

New Relic user keys (sometimes referred to as "personal API keys") allow use of NerdGraph (our GraphQL API), which allows you to query most New Relic data and do some types of configuration. Users keys also let you use our REST API, with restrictions based on your permissions.

Create a user key
  1. Go to the API keys UI and click Create key.
  2. In the Account dropdown, choose the account for which you want the key to be created.
  3. In the Key type dropdown, select User.
  4. In the Name field, enter a descriptive name for your key.
  5. In the Notes field, add relevant details about the key.
  6. Click Create.
Edit a user key
  1. Go to the API keys UI.
  2. In the row of the user key you want to edit, click ... and select Edit.
  3. Make your changes and click Update key.
Delete a user key
  1. Go to the API keys UI.
  2. In the row of the user key you want to delete, click ... and select Delete.
  3. Click Delete key to confirm your deletion.

License key

New Relic license keys allow the ingest of data from APM agents, from the infrastructure agent, and from our metric, event, log, and trace APIs (and the tools that use those).

Create a license key
  1. Go to the API keys UI and click Create key.
  2. In the Account dropdown, choose the account for which you want the key to be created.
  3. In the Key type dropdown, select License.
  4. In the Name field, enter a descriptive name for your key.
  5. In the Notes field, add relevant details about the key.
  6. Click Create.
Edit a license key
  1. Go to the API keys UI.
  2. In the row of the license key you want to edit, click ... and select Edit.
  3. Make your changes and click Update key.
Delete a license API key
  1. Go to the API keys UI.
  2. In the row of the license key you want to delete, click ... and select Delete.
  3. Click Delete key to confirm your deletion.

Browser key

The browser key allows ingest of data from New Relic browser monitoring.

Create a browser key
  1. Go to the API keys UI and click Create key.
  2. In the Account dropdown, choose the account for which you want the key to be created.
  3. In the Key type dropdown, select Browser.
  4. In the Name field, enter a descriptive name for your key.
  5. In the Notes field, add relevant details about the key.
  6. Click Create.
Edit a browser key
  1. Go to the API keys UI.
  2. In the row of the browser API key you want to edit, click ... and select Edit.
  3. Make your changes and click Update key.
Delete a browser key
  1. Go to the API keys UI.
  2. In the row of the browser API key you want to delete, click ... and select Delete.
  3. Click Delete key to confirm your deletion.

REST API key

We recommend using a user key to use the REST API because that key has fewer limitations.

You can use a REST API key with our REST API and the API Explorer. For parent accounts with sub-accounts, each sub-account must use its own REST API key.

Availability: Each New Relic account can have only one REST API key.

Activate or change REST API key
  1. Go to the API keys UI and select REST API key.
  2. Click Regenerate REST API key.
  3. Click (Show key) to view your account's new REST API key.
  4. Copy your account's REST API key to use with New Relic's REST API.
View REST API keys

To view REST API keys:

  1. Go to the API keys UI and select REST API key.
  2. Click (Show key) to view your account's new REST API key.
Delete REST API key

To delete your account's REST API key:

  1. Before you delete an API key, make sure you have the correct account or sub-account.
  2. Go to the API keys UI and select REST API key.
  3. Select the delete [trash can icon] icon for the REST API key.
  4. Confirm the deletion by typing DELETION IS FOREVER in the text field.
  5. Select Delete.

Admin API key

We recommend using the user key because it has fewer limitations.

The Admin API key is not available for users on the New Relic One user model.

The Admin API key is used to manage access to the REST API and API Explorer. Users can use the account REST API key to view data with the API Explorer while Owners and Admins can use the Admin API key to view, add, change, or delete data.

The Admin API key grants full permissions to use the New Relic REST API and API Explorer, including GET > List, POST > Create, PUT > Add or Update, and DELETE functions.

In addition, you must use your Admin API key to manage dashboards using the API Explorer functions, including CREATE > Post, UPDATE > Put, SHOW > Get, SHOW > List, and DELETE functions. Other account users cannot view dashboard data from the API Explorer or use the Dashboard API functions.

Requirements and availability:

Activate or regenerate Admin API key

To activate Admin API access:

  1. Go to the API keys UI and select REST API key.
  2. Next to your name, select the generate [regenerate icon] icon to generate your Admin API key.
  3. Click (Show key) to view your account's new REST API key.
  4. Copy your Admin API key to use with New Relic's REST API.
View Admin API key

An index of Admin API keys appears below the account's REST API key. The list includes the Admin's full name and the date their key was last used.

  • You can view your own Admin API key: From the Admin index, select (Show key) for your name.
  • You can only view other Admin's names. The keys for all other Admins are partially obscured.
Regenerate Admin API key

To change an Admin API key:

  1. Go to the API keys UI and select REST API key.
  2. Select the Admin user's [regenerate icon][repeat]icon.
  3. Confirm the deletion of the previous Admin API key by typing DELETION IS FOREVER in the text field.
  4. Select Regenerate.
  5. Copy the new Admin API key to use with New Relic's REST API.
Delete an Admin API key

If you delete an Admin from the New Relic account, or change their role from Admin to User or Restricted user, this will also automatically remove their Admin API key.

To delete an Admin API key:

  1. Before you delete an API key, make sure you have the correct account or sub-account.
  2. Go to the API keys UI page and select REST API key.
  3. From the list of Admins, locate the person whose key must be deleted.
  4. Select the delete [trash can icon] icon for the REST API key or the Admin API key.
  5. Confirm the deletion by typing DELETION IS FOREVER in the text field.
  6. Select Delete.

Insights insert key

This key is required for sending data via the Event API, Log API, Metric API, and Trace API, or via tools that use those APIs.

Tips on availability and access:

  • Because these keys are associated with an account and not a specific user, anyone in the account with access to a key can use it.
  • As a best practice for security purposes, we recommend you use different Insights insert keys for different applications or different data sources.
Generate an Insights insert key
  1. Go to the API keys UI and select Insights insert keys.
  2. Next to the Insert keys heading, select the button. A cURL command containing your insert key will appear, as well as NRQL query field.
  3. Edit the NRQL query field.
  4. Add comments in the Notes field if desired.
  5. Click Save your notes.
Edit or delete an Insights insert key
  1. Go to the API keys UI and select Insights insert keys.
  2. Under Insert Keys, find the key you want to modify. Select Edit or Delete.

Insights query key

The Insights query key is used for our Insights query API: we now recommend using NerdGraph for querying New Relic data.

Generate an Insights query key

You must have access to the UIs you plan to query and the correct permissions in order to register or modify this key.

Insights query keys are generated per account; they're not associated with a specific user. This means that any user in an account with access to a query key can use it.

To register this key:

  1. Go to the API keys UI and select Insights query keys.
  2. Next to the Query Keys heading, select the button. A cURL command containing your insert key will appear, as well as NRQL query field.
  3. Edit the NRQL query field.
  4. Add comments in the Notes field if desired.
  5. Click Save your notes.
Edit or delete an Insights query key

To edit or delete this key:

  1. Go to the API keys UI page and select Insights query keys.
  2. Under Query Keys, find the key you want to modify. Select Edit or Delete.

For more help

If you need more help, check out these support and learning resources: