Skip to content

Commit

Permalink
Merge pull request #18880 from johnathannewrelic/patch-10
Browse files Browse the repository at this point in the history
Update new-relic-api-keys.mdx
  • Loading branch information
akristen authored Oct 9, 2024
2 parents 8797534 + b0c395a commit 55160b1
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions src/content/docs/apis/intro-apis/new-relic-api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -160,20 +160,9 @@ To get started with API keys:

## View and manage API keys [#keys-ui]

You can view and manage most API keys from the [API keys UI page](https://one.newrelic.com/api-keys). To find that: from the [user menu](/docs/accounts/accounts-billing/general-account-settings/intro-account-settings/#user-menu), click <DNT>**API keys**</DNT>. You can also:
You can manage most API keys from the [API keys UI page](https://one.newrelic.com/api-keys) located in the [user menu](/docs/accounts/accounts-billing/general-account-settings/intro-account-settings/#user-menu) when you click <DNT>**API keys**</DNT>.

* [Use NerdGraph explorer to view and create](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph#explorer) user keys
* [Use our NerdGraph API](/docs/apis/nerdgraph/examples/use-nerdgraph-manage-license-keys-user-keys) for a programmatic way to manage license keys, browser keys, and user keys

The [account ID](/docs/accounts/accounts-billing/account-setup/account-id) is another identifying number often required for reporting data to New Relic.

## Copying keys from the UI [#copy-keys]

You can copy existing API keys and their IDs from [<DNT>**one.newrelic.com/api-keys**</DNT>](https://one.newrelic.com/api-keys):

* <DNT>**Copy key**</DNT>: Copies the value of the key itself.
* <DNT>**Copy key ID**</DNT>: Copies the ID of the key, which is sometimes needed for referencing the key object via API.
* <DNT>**Copy truncated key**</DNT>: This option is available for keys that are not yours. It copies only a few digits from the key, which can be useful for your internal tracking of keys, or for talking with support.
To view a key in NerdGraph, copy the key ID. You can also [use NerdGraph to manage keys](/docs/apis/nerdgraph/examples/use-nerdgraph-manage-license-keys-user-keys)

## Recommendations for managing API keys [#security-practices]

Expand All @@ -185,11 +174,11 @@ If your API keys get into the wrong hands, it can present a security risk. For e
You should treat your API keys securely, as you would passwords and other sensitive information. Some recommendations:

* For the license key and the browser key, consider implementing a key rotation strategy: creating new keys and deleting old ones on a set schedule. Considerations:
* You can't delete the original keys associated with an account, so to implement a strong security strategy, you must create additional keys that you can later delete.
* You can't delete the original ingest keys associated with an account, so we recommend creating additional ingest keys that you can later delete. This ensures you're assuming a strong security posture.
* Note that this doesn't apply to the mobile app token; you can't delete a token or create additional tokens.
* For the <InlinePopover type="userKey"/>:
* Instruct your team members to keep their user keys secure.
* When members leave your organization, remove them from New Relic.
* When members leave your organization, remove their user IDs from New Relic. This disables all the user keys associated with their user ID.

## Rotate API keys [#rotate-keys]

Expand Down

0 comments on commit 55160b1

Please sign in to comment.