Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RestAPI Keys EOL #19714

Merged
merged 4 commits into from
Jan 16, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/content/eol/2025/01/deprecation-notice-rest-api-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: 'End of life for REST API Keys'
summary: "On March 1, 2025, REST API Keys are deprecating."
publishDate: '2025-01-16'
eolEffectiveDate: '2025-03-01'
---

Effective March 01, 2025, our REST API Keys integration drops support for API integrations.

## Background [#bg]

REST API keys are account-level keys and are not directly linked to a individual user, which limits auditing capabilities. This poses a security risk for both New Relic and our customers. User API keys are a well-tested alternative and serve as a replacement to REST API keys. These newer keys can be used across New Relic features such as NerdGraph, among others.

Check failure on line 12 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L12

[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 12, "column": 42}}}, "severity": "ERROR"}

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

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L12

[Microsoft.Passive] 'be used' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be used' looks like passive voice.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 12, "column": 299}}}, "severity": "INFO"}

Additionally, storing these keys in plain text in the database poses security concerns. Therefore, we have been encouraged to retire them promptly or migrate them to a secret store. A potential data breach could expose these keys, granting access to all accounts.

Check failure on line 14 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L14

[Microsoft.Contractions] Use 'we've' instead of 'we have'.
Raw output
{"message": "[Microsoft.Contractions] Use 'we've' instead of 'we have'.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 14, "column": 100}}}, "severity": "ERROR"}

Check notice on line 14 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L14

[Microsoft.Passive] 'been encouraged' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'been encouraged' looks like passive voice.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 14, "column": 108}}}, "severity": "INFO"}

Check notice on line 14 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L14

[new-relic.Adverbs] Consider removing 'promptly'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'promptly'.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 14, "column": 139}}}, "severity": "INFO"}

## What's happening [#whats-happening]

Customers using deprecated REST API keys will be impacted by this end-of-life.

Check notice on line 18 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L18

[Microsoft.Passive] 'be impacted' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be impacted' looks like passive voice.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 18, "column": 47}}}, "severity": "INFO"}

If you have integrations or custom scripts which make calls to **(api.newrelic.com/v2 and api.eu.newrelic.com/v2)** you must check your API keys. If your API key starts with `NRAK`, no update is required.

Check notice on line 20 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L20

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

<Callout variant="tip">
The 'v2' portion of the URL path is crucial; other paths do not support REST API keys.

Check notice on line 23 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L23

[new-relic.ComplexWords] Consider using 'part' instead of 'portion'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'part' instead of 'portion'.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 23, "column": 15}}}, "severity": "INFO"}

Check notice on line 23 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L23

[Microsoft.Semicolon] Try to simplify this sentence.
Raw output
{"message": "[Microsoft.Semicolon] Try to simplify this sentence.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 23, "column": 49}}}, "severity": "INFO"}

Check failure on line 23 in src/content/eol/2025/01/deprecation-notice-rest-api-keys.md

GitHub Actions / vale

[vale] src/content/eol/2025/01/deprecation-notice-rest-api-keys.md#L23

[Microsoft.Contractions] Use 'don't' instead of 'do not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'don't' instead of 'do not'.", "location": {"path": "src/content/eol/2025/01/deprecation-notice-rest-api-keys.md", "range": {"start": {"line": 23, "column": 63}}}, "severity": "ERROR"}
</Callout>

## What do you need to do [#what-to-do]

* Generate a new User API key and configure your systems to use it.
* If you use a third-party integration, follow the instructions provided by the vendor to update the key.

## What happens if you don't make any changes to your account [#account]

* Failure to update the key will cause API calls to fail against the REST v2 API.
* The impact on your operations depends on which REST v2 API endpoints you use and your reliance on them.
Empty file.
56 changes: 56 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,56 @@
---
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/install/aws-logs/"
getStartedLink: "https://docs.newrelic.com/docs/logs/get-started/get-started-log-management/"
---

New Relic now retiring the REST API key to improve security and reliability. You must update your systems with the new keys to avoid service disruptions.

The current REST API keys used to access REST API v2 **(api.newrelic.com/v2 and 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 11 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#L11

[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": 11, "column": 112}}}, "severity": "INFO"}

If your systems or integrations calling 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 13 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#L13

[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": 13, "column": 1}}}, "severity": "INFO"}

Check notice on line 13 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#L13

[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": 13, "column": 261}}}, "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 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 32 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#L32

[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": 32, "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.

<Callout variant="tip">
Once the old key is deleted, it cannot be restored.

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

[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": 42, "column": 23}}}, "severity": "INFO"}

Check failure 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

[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": 42, "column": 38}}}, "severity": "ERROR"}

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

[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": 42, "column": 45}}}, "severity": "INFO"}
</Callout>

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 47 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#L47

[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": 47, "column": 4}}}, "severity": "INFO"}

* If you’re using multiple New Relic accounts, each one will have its own REST API key. Each API key is must replaced individually with a user API key which is generated in the corresponding account.

Check notice on line 49 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#L49

[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": 49, "column": 19}}}, "severity": "INFO"}

Check notice on line 49 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#L49

[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": 49, "column": 158}}}, "severity": "INFO"}
* If your API key starts with `NRAK`, no update is required.

Check notice on line 50 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#L50

[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": 50, "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)