New Relic Nerdgraph GraphQL API Collection

Number of APIs: 30

NerdGraph is our GraphQL-format API that lets you query New Relic data and configure some New Relic features. After you sign up for a free New Relic account and install any of our monitoring services, you can get started with NerdGraph.

Authenticating in Qodex

To use this collection, you need to provide your API key. Your API key can be found in the API Keys section of New Relic One.

Once you have your API key, create a new Environment in Qodex by clicking on the Environments tab within the left-hand navigation. You can name your environment whatever you prefer, for example, Production.

In the new environment define a new variable called new_relic_api_key and provide both its initial value and current value with your New Relic API key. Remember to save your work when finished.

Once you have done so, make sure to choose your new Environment from the dropdown in the upper right-hand corner of Qodex directly under your avatar.

What can you do with NerdGraph?

NerdGraph functionality can be broken down into two main categories:

Querying New Relic data. You can fetch data for a variety of purposes, including using it in a programmatic workflow, or building a New Relic One app for custom data visualizations.
Configuring New Relic features. There are a variety of configurations available and more will be added over time. You can do things like add tags, configure workloads, or customize golden metrics.

You can use NerdGraph to return a wide range of New Relic data but we’ve created some tutorials for common use cases:

Topic	Tutorials
Alerts	See all alert-related tutorials
APM agents	APM agent configuration
Applied Intelligence	View and configure topology
Cloud integrations (AWS, Azure, GCP)	Configure cloud integrations
Dashboards	* Create dashboards * Export dashboards to other accounts * Export dashboards as files * Migrate from Insights Dashboard API to NerdGraph
Data management	* Convert event data to metric data * Data retention * Drop data
Distributed tracing	* Query distributed tracing data * Configure Infinite Tracing
Entities	* Get data about entities * Understand entity relationships and dependencies (used to build service maps) * Query and configure golden metrics (important entity metrics)
Key management	Create and manage keys (license keys used for data ingest, and user keys)
Log management	* Manage data partitions * Manage log parsing rules
New Relic One apps	Build a New Relic One app
Partners and resellers	Manage subscriptions (only for partners using original pricing model)
Querying data	Query using NRQL (our query language)
Service levels	Configure and manage service levels
Tags	Add and manage tags
Workloads	View and configure workloads

NerdGraph terminology

The following are terms that originate with GraphQL (the API format NerdGraph uses).

Term	Definition
Queries and mutations	There are two classes of GraphQL operations: * Queries are basic requests used only to fetch data. These queries are not static, meaning that you can ask for more data or less data, depending on your needs. For each query, you can specify exactly what data you want to retrieve, as long as it is supported by the schema. * Mutations are requests that perform an action, such as creating a resource or changing configuration. Mutations require the keyword `mutation`, as well as the `name` of the mutation.
Type	Data in GraphQL is organized into types. Types can be scalars (like strings, numbers, or booleans) or object types. An object type is a custom type made up of a collection of fields. For example, an object type called `User` may represent a user in a system.
Field	A field represents a piece of information on an object type that can be queried. Fields can be scalars, lists, or objects. For example, a `User` object type could have a string field called `name`.
Interface	An interface is an abstract type that represents a collection of common fields that other object types can `implement`.

mutations-Alerts - alertsNotificationChannelUpdate POST {{url}}
mutations-Entity - entityRelationshipUserDefinedDelete POST {{url}}
mutations-NerdPack - nerdpackUnsubscribeAccounts POST {{url}}
mutations-Organization Provisioning - organizationProvisioningUpdatePartnerSubscription POST {{url}}
mutations-Service Level - serviceLevelUpdate POST {{url}}
mutations-Synthetics - syntheticsUpdateSecureCredential POST {{url}}
mutations-Installation - installationDeleteInstall POST {{url}}
mutations-Mobile - mobilePushNotificationSendTestPushToAll POST {{url}}
mutations-Workload - workloadUpdate POST {{url}}
mutations-Tagging - taggingReplaceTagsOnEntity POST {{url}}