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.

Sign up for GitHub

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

Update use-nerdgraph-manage-license-keys-user-keys.mdx #19906

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Update use-nerdgraph-manage-license-keys-user-keys.mdx #19906

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4c6e36
Update use-nerdgraph-manage-license-keys-user-keys.mdx
johnathannewrelic Feb 5, 2025
9a5d994
fix nerdgraph name
WriteMayur Feb 13, 2025
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
11 changes: 5 additions & 6 deletions ...nt/docs/apis/nerdgraph/examples/use-nerdgraph-manage-license-keys-user-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,15 @@ Notes about this functionality:

* All mutations can accept multiple keys as arguments, and will return details about successful changes and errors. See examples below for details.
* All mutations (create, update and delete) will result in an `NrAuditEvent` that can be queried for auditing purposes. For details, see [Audit events](/docs/insights/use-insights-ui/manage-account-data/query-account-audit-logs-nrauditevent).
* Regarding license keys:
* License keys are categorized by NerdGraph as <DNT>**ingest keys**</DNT>. This is because their main use is to allow data ingest.
* You can create up to 1,000 keys of each license key type, which allows for key rotation.
* You can't manage or delete original license keys; you can only create additional license keys and manage keys you've created.
* Regarding ingest keys:
* License and Browser keys are categorized by NerdGraph as <DNT>**ingest keys**</DNT>. This is because their main use is to allow data ingest.
* You can create up to 1,000 keys of each ingest key type, which allows for key rotation.
* You can't manage or delete original account ingest keys but you can contact New Relic support to rotate these; you can only create additional ingest or user keys and manage keys you've created.

## Before using examples [#before-examples]

Things to note before using these example queries:

* The examples below use license keys (aka ingest keys), but you can query [user keys](/docs/apis/get-started/intro-apis/types-new-relic-api-keys#user-api-key) in similar ways, replacing the ingest-key-specific fields with user-key-specific fields.
* To understand the data structure, we recommend experimenting with queries using the [GraphiQL explorer](https://api.newrelic.com/graphiql).
* You can also [create, view, and delete user keys using the UI.](/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key)

Expand All @@ -49,7 +48,7 @@ Things to note before using these example queries:
You can find and generate user keys using the [NerdGraph GraphiQL explorer](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/#explorer), at the top of that interface.
</Callout>

To create multiple keys (user key or license key) in a single mutation, for multiple accounts and key types. Note that the mutation can return successfully created keys as well as any errors encountered trying to create keys.
To create multiple keys (user key or ingest key) in a single mutation, for multiple accounts and key types. Note that the mutation can return successfully created keys as well as any errors encountered trying to create keys.

Example of creating a key:

Expand Down
Loading