Skip to main content
New Relic logo

​
Overview

Add New Relic to any ModuleX agent or workflow. Query observability data and record deployments in New Relic. Run NRQL queries, search monitored entities, fetch entity details, and create deployment change events through New Relic’s NerdGraph GraphQL API (api.newrelic.com/graphql, or api.eu.newrelic.com/graphql for the EU region).
Categories: Monitoring & Observability · Monitoring · Observability · Auth: API Key · Actions: 4

​
Authentication

​
API Key Authentication

Authenticate using your New Relic user API key
1

Step 1

Sign in to New Relic at https://one.newrelic.com
2

Step 2

Open the user menu and go to ‘API keys’
3

Step 3

Create a new ‘User’ key (its value starts with ‘NRAK-’)
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
New Relic User API KeyYour New Relic user API key (starts with ‘NRAK-’)YesNRAK-<your-user-key>

​
Available Actions

​
Parameters

​
account_id
integer
required
New Relic account ID to query
​
nrql
string
required
NRQL query to execute
​
region
string
New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)
​
timeout
integer
Optional query timeout in seconds

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "results": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Results",
      "type": "array"
    },
    "result_count": {
      "default": 0,
      "title": "Result Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "NrqlQueryOutput",
  "type": "object"
}

​
Parameters

​
query
string
required
Entity search query, e.g. name like “api” or domainType = “APM-APPLICATION”
​
region
string
New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)
​
cursor
string
Pagination cursor from a previous entity search

​
Response

{
  "$defs": {
    "Entity": {
      "additionalProperties": false,
      "description": "A single monitored New Relic entity (guid, name, entityType).",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "entity_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Type"
        }
      },
      "title": "Entity",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Query"
    },
    "entities": {
      "items": {
        "$ref": "#/$defs/Entity"
      },
      "title": "Entities",
      "type": "array"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Cursor"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchEntitiesOutput",
  "type": "object"
}

​
Parameters

​
guid
string
required
Entity GUID
​
region
string
New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)

​
Response

{
  "$defs": {
    "Entity": {
      "additionalProperties": false,
      "description": "A single monitored New Relic entity (guid, name, entityType).",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "entity_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Type"
        }
      },
      "title": "Entity",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "entity": {
      "anyOf": [
        {
          "$ref": "#/$defs/Entity"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetEntityOutput",
  "type": "object"
}

​
Parameters

​
entity_guid
string
required
GUID of the entity associated with the deployment
​
version
string
required
Deployment version, release name, or commit SHA
​
region
string
New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)
​
short_description
string
Short description of the deployment
​
description
string
Longer deployment description
​
changelog
string
Deployment changelog text or URL
​
commit
string
Commit SHA or identifier associated with the deployment
​
deep_link
string
URL to the deployment, build, or release details
​
user
string
User or automation that performed the deployment
​
group_id
string
Optional group ID to correlate related changes
​
custom_attributes
object
Custom change event metadata as key-value pairs with string, number, or boolean values
​
deployment_type
string
Deployment type: ‘basic’, ‘blue green’, ‘canary’, ‘rolling’, or ‘shadow’ (Default: basic)
​
timestamp
integer
Event timestamp in milliseconds since Unix epoch

​
Response

{
  "$defs": {
    "ChangeTrackingEntity": {
      "additionalProperties": false,
      "description": "The entity a change tracking event is associated with.",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "title": "ChangeTrackingEntity",
      "type": "object"
    },
    "ChangeTrackingEvent": {
      "additionalProperties": false,
      "description": "A created New Relic change tracking (deployment) event.",
      "properties": {
        "category": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Category"
        },
        "category_and_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Category And Type"
        },
        "change_tracking_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Change Tracking Id"
        },
        "custom_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Custom Attributes"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "group_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Group Id"
        },
        "short_description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Short Description"
        },
        "timestamp": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timestamp"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "user": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User"
        },
        "entity": {
          "anyOf": [
            {
              "$ref": "#/$defs/ChangeTrackingEntity"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "title": "ChangeTrackingEvent",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "event": {
      "anyOf": [
        {
          "$ref": "#/$defs/ChangeTrackingEvent"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "messages": {
      "items": {
        "type": "string"
      },
      "title": "Messages",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDeploymentEventOutput",
  "type": "object"
}

​
Limits & Quotas

  • All actions hit the NerdGraph GraphQL endpoint; New Relic enforces account-level NerdGraph rate limits (per-minute request and query-cost budgets). Heavy or unbounded NRQL queries may be throttled or time out.
  • nrql_query accepts an optional timeout (seconds) forwarded to NerdGraph; the HTTP client itself caps each call at 90 seconds.
  • create_deployment_event custom attribute names must be letters, numbers, and underscores (not starting with a number), must not contain ., and must avoid New Relic’s reserved NRQL keywords; invalid names are rejected before the call. A supplied timestamp must be within one day of the current time per New Relic’s change tracking rules.
  • Error model: non-2xx responses, GraphQL errors, and timeouts are caught and returned as success=False + error rather than raising.

Grafana

Sentry

CrowdStrike