New to Corsair? See API access, authentication, and error handling.
Accounts
list
accounts.list
List the accounts this key can reach, with the ids NRQL and issues take
Risk: read
Output
accounts full type
accounts full type
Alerts
conditions
alerts.conditions
List the APM, browser and mobile conditions in one policy; external service, synthetic and NRQL conditions are separate endpoints and are not covered
Risk: read
Only APM, browser and mobile conditions; external service, synthetic and NRQL conditions are separate endpoints.
Output
conditions full type
conditions full type
createNrqlCondition
alerts.createNrqlCondition
Add a static NRQL alert condition to a policy: the query, thresholds and how long they must hold
Risk: write
condition full type
condition full type
nrql_condition full type
nrql_condition full type
createPolicy
alerts.createPolicy
Create an alert policy and choose whether incidents roll up per policy, per condition, or per condition and signal
Risk: write
Output
policy full type
policy full type
deleteNrqlCondition
alerts.deleteNrqlCondition
Delete a NRQL alert condition; New Relic has no restore call
Risk: destructive · Irreversible
Output
nrql_condition full type
nrql_condition full type
deletePolicy
alerts.deletePolicy
Delete an alert policy and the conditions attached to it; New Relic has no restore call
Risk: destructive · Irreversible
Deleting a policy also deletes its conditions, and there is no restore call.
Output
policy full type
policy full type
nrqlConditions
alerts.nrqlConditions
List the static NRQL conditions in one policy, with their query, thresholds and signal settings
Risk: read
Output
nrql_conditions full type
nrql_conditions full type
policies
alerts.policies
List alert policies with their incident rollup preference
Risk: read
Output
policies full type
policies full type
updateNrqlCondition
alerts.updateNrqlCondition
Replace a NRQL condition, e.g. to enable it or move its threshold; send the whole condition, since a partial body is refused
Risk: write
Send the whole condition; a partial body answers 400.
condition full type
condition full type
nrql_condition full type
nrql_condition full type
updatePolicy
alerts.updatePolicy
Rename an alert policy or change how its incidents roll up; both fields are sent, since New Relic replaces the policy
Risk: write
Send both name and incident_preference; New Relic replaces the policy and refuses a partial body.
Output
policy full type
policy full type
Applications
get
applications.get
Read one application by id with the same health, reporting and summary block
Risk: read
Output
application full type
application full type
list
applications.list
List applications with their health colour, whether they are reporting, and the summary metrics the UI shows
Risk: read
health_status is green, orange, red or unknown; orange is the REST spelling of the UI yellow.
Output
applications full type
applications full type
Change Tracking
createDeployment
changeTracking.createDeployment
Record a deployment marker (version, commit, changelog) on an entity; markers cannot be deleted
Risk: destructive · Irreversible
Markers cannot be deleted afterwards.
Output
Entities
get
entities.get
Read up to 25 entities by GUID with their type, reporting state, alert severity and tags
Risk: read
Output
entities full type
entities full type
search
entities.search
Search monitored entities (services, hosts, browser apps, dashboards, monitors, alert conditions) with a filter such as type = ‘APPLICATION’
Risk: read
Output
entities full type
entities full type
Issues
list
issues.list
List alert issues for an account, filtered by state, priority, entity or time window
Risk: read
title and description are lists in NerdGraph.
Output
issues full type
issues full type
Metrics
get
metrics.get
Read metric timeslices for an application over a time window, or one averaged value per metric with summarize
Risk: read
Without from, New Relic returns the last 30 minutes. summarize collapses the window into one value per metric.
Output
metric_data full type
metric_data full type
Query
nrql
query.nrql
Run a NRQL query against one account through NerdGraph and return its rows and the time window New Relic actually ran over
Risk: read
Runs through NerdGraph, so accountId is required. A bad query answers 200 with an errors array, which the plugin throws.
Output
metadata full type
metadata full type