Skip to content

Commit

Permalink
addiding the file back
Browse files Browse the repository at this point in the history
  • Loading branch information
cbehera-newrelic committed Jan 17, 2025
1 parent df6a5bc commit d5bec67
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md
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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L10

[Microsoft.Passive] 'be retired' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be retired' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 10, "column": 111}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L12

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 12, "column": 1}}}, "severity": "INFO"}

Check notice on line 12 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L12

[new-relic.Adverbs] Consider removing 'potentially'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'potentially'.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 12, "column": 258}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L31

[new-relic.ComplexWords] Consider using 'decide' or 'find' instead of 'determine'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'decide' or 'find' instead of 'determine'.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 31, "column": 97}}}, "severity": "INFO"}
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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38

[Microsoft.Passive] 'is deleted' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is deleted' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 38, "column": 68}}}, "severity": "INFO"}

Check failure on line 38 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38

[Microsoft.Contractions] Use 'can't' instead of 'cannot'.
Raw output
{"message": "[Microsoft.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 38, "column": 83}}}, "severity": "ERROR"}

Check notice on line 38 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L38

[Microsoft.Passive] 'be restored' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be restored' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 38, "column": 90}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L42

[new-relic.ComplexWords] Consider using 'more' or 'extra' instead of 'Additional'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'more' or 'extra' instead of 'Additional'.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 42, "column": 4}}}, "severity": "INFO"}

* 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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44

[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 44, "column": 19}}}, "severity": "INFO"}

Check notice on line 44 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44

[Microsoft.Passive] 'be replaced' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be replaced' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 44, "column": 112}}}, "severity": "INFO"}

Check notice on line 44 in src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L44

[Microsoft.Passive] 'is generated' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is generated' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 44, "column": 163}}}, "severity": "INFO"}
* 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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md#L45

[Microsoft.Passive] 'is required' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is required' looks like passive voice.", "location": {"path": "src/content/whats-new/2025/01/whats-new-03-01-rest-api-keys-eol.md", "range": {"start": {"line": 45, "column": 49}}}, "severity": "INFO"}

## 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)

0 comments on commit d5bec67

Please sign in to comment.