graphql-schema-docs.md

Schema Types

Table of Contents

• Objects
  • Nr1CatalogInstallAlertPolicyTemplateResult
  • Nr1CatalogInstallDashboardTemplateResult
  • Nr1CatalogQuickstart
  • Nr1CatalogQuickstartAlert
  • Nr1CatalogQuickstartAlertCondition
  • Nr1CatalogQuickstartAlertConditionMetadata
  • Nr1CatalogQuickstartAlertMetadata
  • Nr1CatalogQuickstartDashboard
  • Nr1CatalogQuickstartDashboardMetadata
  • Nr1CatalogQuickstartDocumentation
  • Nr1CatalogQuickstartDocumentationMetadata
  • Nr1CatalogQuickstartMetadata
  • Nr1CatalogQuickstartsListing
• Inputs
  • Nr1CatalogInstallDirectiveInput
  • Nr1CatalogQuickstartMetadataAlertConditionInput
  • Nr1CatalogQuickstartMetadataDashboardInput
  • Nr1CatalogQuickstartMetadataDocumentationInput
  • Nr1CatalogQuickstartMetadataInput
• Enums
  • Nr1CatalogInstallerType
  • Nr1CatalogQuickstartAlertConditionType
• Interfaces
  • Nr1CatalogInstaller
  • Nr1CatalogQuickstartComponent
  • Nr1CatalogQuickstartComponentMetadata

Objects

Nr1CatalogInstallAlertPolicyTemplateResult

Information about the mutation result when installing an alert policy template * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
alertPolicyTemplate		Nr1CatalogAlertPolicyTemplate!	The template that was used for the installation * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
createdAlertPolicy		Nr1CatalogAlertPolicyOutline!	An outline of the created alert policy * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogInstallDashboardTemplateResult

Information about the mutation result when installing a dashboard template * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
createdDashboard		Nr1CatalogDashboardOutline!	An outline of the created dashboard * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
dashboardTemplate		Nr1CatalogDashboardTemplate!	The template that was used for the installation * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstart

Information about the quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
featured		Boolean!	Determines if this is a featured quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
id		ID!	The unique identifier for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
metadata		Nr1CatalogQuickstartMetadata	Metadata associated with the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
sourceUrl		String	Specifies the URL where the source definition for the quickstart can be found * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
supportLevel		Nr1CatalogSupportLevel!	Level of support expected for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartAlert

Information about an alert in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
id ⚠️		ID!	The unique identifier for the alert * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer) ⚠️ DEPRECATED This field is no longer supported. Please use Nr1CatalogQuickstartAlertCondition instead.
metadata ⚠️		Nr1CatalogQuickstartAlertMetadata!	Metadata associated with the alert * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer) ⚠️ DEPRECATED This field is no longer supported. Please use Nr1CatalogQuickstartAlertCondition instead.

Nr1CatalogQuickstartAlertCondition

Information about an alert condition in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
id		ID!	The unique identifier for the alert condition * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
metadata		Nr1CatalogQuickstartAlertConditionMetadata!	Metadata associated with the alert condition * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartAlertConditionMetadata

Metadata associated with the alert condition in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
description		String	A short form description for the alert condition * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
displayName		String	The human-readable name for the alert condition * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
type		Nr1CatalogQuickstartAlertConditionType!	Determines the type of alert condition that will be created * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartAlertMetadata

Metadata associated with the alert in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
description ⚠️		String	A short form description for the alert. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer) ⚠️ DEPRECATED This field is no longer supported. Please use Nr1CatalogQuickstartAlertCondition instead.
displayName ⚠️		String	The human-readable name for the alert. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer) ⚠️ DEPRECATED This field is no longer supported. Please use Nr1CatalogQuickstartAlertCondition instead.

Nr1CatalogQuickstartDashboard

Information about a dashboard in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
id		ID!	The unique identifier for the dashboard * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
metadata		Nr1CatalogQuickstartDashboardMetadata!	Metadata associated with the dashboard * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartDashboardMetadata

Metadata associated with the dashboard in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
description		String	A short form description for the dashboard. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
displayName		String	The human-readable name for the dashboard. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
previews		[Nr1CatalogPreview!]!	A list of previews for the dashboard, such as screenshots. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartDocumentation

Information about a documentation component in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
metadata		Nr1CatalogQuickstartDocumentationMetadata!	Metadata associated with the dashboard * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartDocumentationMetadata

Metadata associated with the documentation component in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
description		String	A short form description for the documentation component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
displayName		String	The human-readable name for the documentation component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
url		String!	The documentation URL * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartMetadata

Metadata associated with the quickstart that is available in New Relic I/O * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
authors		[Nr1CatalogAuthor!]!	Authors for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
categories		[Nr1CatalogCategory!]!	The list of categories for filtering, searching, and grouping associated with the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
categoryTerms		[String!]!	The list of category terms associated with the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
dataSources		[Nr1CatalogDataSource!]!	The list of data sources associated with the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
description		String	A short form description for the quickstart. Used throughout the platform when displaying the quickstart. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
displayName		String	The human-readable name for the quickstart. Used throughout the New Relic One platform when displaying the quickstart. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
icon		Nr1CatalogIcon	The corresponding icon for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
installer ⚠️		Nr1CatalogInstaller	Information about how a quickstart is installed * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer) ⚠️ DEPRECATED This field is in a deprecation period. Please refer to dataSources for how a quickstart is installed.
keywords		[String!]!	A list of keywords for filtering and searching * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
quickstartComponents		[Nr1CatalogQuickstartComponent!]!	List of components in a quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
slug		String!	The URL friendly name of the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
summary		String	A short summary detailing the functionality of the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartsListing

Paginated information about Quickstarts * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
nextCursor		String	Cursor used to fetch the next set of results * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
results		[Nr1CatalogQuickstart!]!	The list of quickstart results * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
totalCount		Int!	The total number of quickstart results * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Inputs

Nr1CatalogInstallDirectiveInput

Set of attributes which represent how an install takes place * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(flag:DevEx/nrio_mutations)

Field		Type	Description
link		Nr1CatalogLinkInstallDirectiveInput	Link information for this directive. Cannot be used with a nerdlet directive. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
nerdlet		Nr1CatalogNerdletInstallDirectiveInput	Nerdlet information for this directive. Cannot be used with a link directive. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)

Nr1CatalogQuickstartMetadataAlertConditionInput

Metadata associated with the alert condition in this quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(flag:DevEx/nrio_mutations)

Field		Type	Description
description		String	A short form description for the alert condition. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
displayName		String!	The human-readable name for the alert condition. Used throughout the New Relic One platform when displaying the alert condition. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
rawConfiguration		Nr1CatalogRawConfiguration!	The raw JSON configuration for the alert condition * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
sourceUrl		String	The source of the alert configuration * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
type		Nr1CatalogQuickstartAlertConditionType!	Determines the type of alert condition that will be created * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)

Nr1CatalogQuickstartMetadataDashboardInput

Metadata associated with the dashboard in this quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(flag:DevEx/nrio_mutations)

Field		Type	Description
description		String	A short form description for the dashboard. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
displayName		String!	The human-readable name for the dashboard. Used throughout the New Relic One platform when displaying the dashboard. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
rawConfiguration		Nr1CatalogRawConfiguration!	The raw JSON configuration for the dashboard * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
screenshots		[Nr1CatalogScreenshotInput!]	A list of previews for the dashboard, such as screenshots. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
sourceUrl		String	The source of the dashboard configuration * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)

Nr1CatalogQuickstartMetadataDocumentationInput

Metadata associated with the documentation in this quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(flag:DevEx/nrio_mutations)

Field		Type	Description
description		String!	A short form description for the documentation component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
displayName		String!	The human-readable name for the documentation component. Used throughout the New Relic One platform when displaying the documentation component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
url		String!	The documentation URL * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)

Nr1CatalogQuickstartMetadataInput

Metadata associated with the quickstart that will be available in New Relic Instant Observability * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(flag:DevEx/nrio_mutations)

Field		Type	Description
alertConditions		[Nr1CatalogQuickstartMetadataAlertConditionInput!]	A list of alert condition components that are included in the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
authors		[Nr1CatalogAuthorInput!]!	Authors for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
categoryTerms		[String!]	The list of category terms associated with the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
dashboards		[Nr1CatalogQuickstartMetadataDashboardInput!]	A list of dashboard components that are included in the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
dataSourceIds		[ID!]	A list of data source ids corresponding to the data sources associated with this quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
description		String!	A short form description for the quickstart. Used throughout the platform when displaying the quickstart. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
displayName		String!	The human-readable name for the quickstart. Used throughout the New Relic One platform when displaying the quickstart. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
documentation		[Nr1CatalogQuickstartMetadataDocumentationInput!]	A list of documentation components that are included in the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
icon		String!	The public url of an icon for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
keywords		[String!]	A list of keywords for filtering and searching * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
slug		String	The URL friendly name for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
sourceUrl		String	Specifies the URL where the source definition for the quickstart can be found * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
summary		String!	A short summary detailing the functionality of the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)
supportLevel		Nr1CatalogSupportLevel	Level of support for the quickstart * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(flag:DevEx/nrio_mutations)

Enums

Nr1CatalogQuickstartAlertConditionType

Possible types of configured alert conditions * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Value	Description
BASELINE	A baseline alert condition
OUTLIER ⚠️	An outlier alert condition ⚠️ DEPRECATED Outlier alert conditions are no longer supported
STATIC	A static alert condition

Interfaces

Nr1CatalogInstaller

Information about how a quickstart is installed * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
type		Nr1CatalogInstallerType!	The type of installer * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartComponent

Information about a component in a quickstart * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
metadata		Nr1CatalogQuickstartComponentMetadata!	Metadata associated with the quickstart component * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)

Nr1CatalogQuickstartComponentMetadata

Information related to the metadata attached to a quickstart component * #help-nr1-dev-experience

• Team ID: No team ID provided

• catalog-service-elixir repo

• No additional info link provided

• visibility(customer)

Field	Argument	Type	Description
description		String	A short form description for the quickstart component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)
displayName		String	The human-readable name for the quickstart component. * #help-nr1-dev-experience Team ID: No team ID provided catalog-service-elixir repo No additional info link provided visibility(customer)