-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: "REST API Keys End-of-life" | ||
summary: "Retiring the REST API key to improve security and reliability." | ||
releaseDate: "2025-03-01" | ||
learnMoreLink: "https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/" | ||
--- | ||
|
||
New Relic is now retiring the REST API keys to improve security and reliability. You must update your systems with the new User keys to avoid service disruptions. | ||
|
||
The current REST API keys used to access REST API v2 **(api.newrelic.com/v2 or api.eu.newrelic.com/v2)** will be retired. This change addresses the limitations of the existing account-level keys and aligns with industry best practices. | ||
Check notice on line 10 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L10
Raw output
|
||
|
||
If your systems or integrations call these specified API end-points using the REST API keys, you must replace them with new User API keys by **March 1, 2025**, to avoid service disruptions. Failure to update may result in API call failures and errors, also potentially disrupting workflows. | ||
Check notice on line 12 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L12
Raw output
Check notice on line 12 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L12
Raw output
|
||
|
||
You must complete replacement of the REST API keys by March 1, 2025. | ||
|
||
## To get started | ||
|
||
This change requires you to [rotate your API key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#rotate-user-key). | ||
|
||
You must do the following: | ||
|
||
* **Generate new keys:** Use the [New Relic UI](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/) or [NerdGraph API.](https://docs.newrelic.com/docs/apis/nerdgraph/examples/use-nerdgraph-manage-license-keys-user-keys/) | ||
* **Update systems:** Replace old keys with new User API keys in your systems. | ||
* **Validate:** Ensure all API integrations work with the new User keys. | ||
* **Remove old keys:** Delete old keys once validated. | ||
|
||
## Rotate API key | ||
|
||
**To rotate API keys in UI:** | ||
|
||
1. Go to [New Relic UI](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/) and determine which account you need a key for. | ||
Check notice on line 31 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L31
Raw output
|
||
2. Create new User API keys associated to that account. | ||
3. Update your systems to use the new User API keys. | ||
|
||
a. Go to [one.newrelic.com/api-keys](http://one.newrelic.com/api-keys) or [one.eu.newrelic.com/api-keys](http://one.eu.newrelic.com/api-keys) for EU data center and refer to the create and update instructions [here](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#rotate-user-key). | ||
|
||
4. Ensure your API integrations function/work correctly with the new keys. This requires updating any scripts or code that reference the old key to use the new key value. | ||
5. Once validated, remove the old REST API keys. After the old key is deleted, it cannot be restored. | ||
Check notice on line 38 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38
Raw output
Check failure on line 38 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38
Raw output
Check notice on line 38 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38
Raw output
|
||
|
||
You can also manage User keys via our NerdGraph API. For instructions, refer to NerdGraph tutorial [Manage API keys.](https://docs.newrelic.com/docs/apis/nerdgraph/examples/use-nerdgraph-manage-license-keys-user-keys/) | ||
|
||
## Additional key points | ||
Check notice on line 42 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L42
Raw output
|
||
|
||
* If you’re using multiple New Relic accounts, each one will have its own REST API key. Each REST API key must be replaced individually with a User API key which is generated in the corresponding account. | ||
Check notice on line 44 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44
Raw output
Check notice on line 44 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44
Raw output
Check notice on line 44 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44
Raw output
|
||
* If your API key starts with `NRAK`, no update is required. | ||
Check notice on line 45 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md GitHub Actions / vale[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L45
Raw output
|
||
|
||
## Contact support | ||
|
||
Our support team is here to assist you during this transition. If you have any questions about these changes, please contact [Support.](https://docs.newrelic.com/docs/new-relic-solutions/solve-common-issues/find-help-get-support/) | ||
|
||
For more information on how to view and manage API Keys in New Relic, click [here.](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#keys-ui) |