REST API calls for alerts

Our REST API is New Relic's original API for programmatically configuring New Relic alerting settings (learn about NerdGraph, our preferred API).

The REST API Explorer also includes the curl request format, available parameters, potential response status codes, and JSON response structure for each of the available API calls. You can also create alert conditions in the UI.

Before using the REST API

Before using the REST API to manage alerting data, read the Intro to APIs for .

For infrastructure alerting, see [REST API for infrastructure monitoring alerts](/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/

Available data and functions via REST API

REST API functions	Comments
View account data	In general, any role can use a or REST API key with GET > List functions to view alerts data. The account Owner and Admins may use their API key. List output will be paginated. Available functions include: Alert policies Conditions for , , and (Some limitations apply.) Conditions for external services Conditions for synthetic monitoring Conditions for Multi-location synthetic monitoring Conditions for NRQL (Some limitations apply.) Events Incidents Incidents
Maintain account data	You may have an Owner or Admin role in your account and a user key or have a custom role that grants permissions to manage alerts and a user key in order to use any maintenance function, including POST > Create, PUT > Add, PUT > Update, and DELETE.

REST API functions

Comments

View account data

In general, any role can use a or REST API key with GET > List functions to view alerts data. The account Owner and Admins may use their API key.

List output will be paginated. Available functions include:

Alert policies
Conditions for , , and (Some limitations apply.)
Conditions for external services
Conditions for synthetic monitoring
Conditions for Multi-location synthetic monitoring
Conditions for NRQL (Some limitations apply.)
Events
Incidents
Incidents

Maintain account data

You may have an Owner or Admin role in your account and a user key or have a custom role that grants permissions to manage alerts and a user key in order to use any maintenance function, including POST > Create, PUT > Add, PUT > Update, and DELETE.

Conditions excluded from the REST API

These types of conditions do not have available endpoints in the API:

APM: Web transaction percentiles, conditions targeting labels, and anomalies
NRQL: Anomalies

Alert policies

These API functions include links to the API Explorer, where you can create, delete, or list policies.

Important

If your organization hosts data in the EU data center, ensure you're using the proper API endpoints for EU region accounts.

To add new policies, use your user key and include these two values in the API call:

Required values	Definition
`incident_preference`	Determines how alerts will create incidents. This must be one of the following: `PER_POLICY` (default): Roll up by policy. `PER_CONDITION`: Roll up by condition. `PER_CONDITION_AND_TARGET`: Roll up by target and condition.
`name`	The policy `name` is required. Leaving it unchanged will create a policy called `string`.

Required values

Definition

incident_preference

Determines how alerts will create incidents. This must be one of the following:

PER_POLICY (default): Roll up by policy.
PER_CONDITION: Roll up by condition.
PER_CONDITION_AND_TARGET: Roll up by target and condition.

name

The policy name is required. Leaving it unchanged will create a policy called string.

API Explorer > Alerts Policies > POST > Create

bash

$curl -X POST 'https://api.newrelic.com/v2/alerts_policies.json' \
>     -H "$API_KEY" -i \
>     -H 'Content-Type: application/json' \
>     -d \
>'{
$  "policy": {
$    "incident_preference": "string",
$    "name": "string"
$  }
$}'

Use this API to update an existing policy's name and incident_preference. You'll need your user key.

Required values	Definition
`id`	To find a policy's ID, use either of these options: From the UI: On a policy's UI page, find the ID under the policy name. With the API: Use the List policies API.
`incident_preference`	Determines how alerts will create incidents. Must be one of the following: `PER_POLICY` (default): Roll up by policy. `PER_CONDITION`: Roll up by condition. `PER_CONDITION_AND_TARGET`: Roll up by target and condition.
`name`	The policy `name`, if you do not change the `name` it defaults to a policy called `string`. To find a policy's exact name, use the List policies API.

Required values

Definition

id

To find a policy's ID, use either of these options:

From the UI: On a policy's UI page, find the ID under the policy name.
With the API: Use the List policies API.

incident_preference

Determines how alerts will create incidents. Must be one of the following:

PER_POLICY (default): Roll up by policy.
PER_CONDITION: Roll up by condition.
PER_CONDITION_AND_TARGET: Roll up by target and condition.

name

The policy name, if you do not change the name it defaults to a policy called string.

To find a policy's exact name, use the List policies API.

API Explorer > Alerts Policies > PUT > Update

bash

$curl -X PUT 'https://api.newrelic.com/v2/alerts_policies/{id}.json' \
>     -H "$API_KEY" -i \
>     -H 'Content-Type: application/json' \
>     -d \
>'{
$  "policy": {
$    "incident_preference": "string",
$    "name": "string"
$  }
$}'

To delete an existing policy, use your user key, and include the policy_id (available from API Explorer > Alerts Policies > GET > List) in the API call:

API Explorer > Alerts Policies > DELETE > Delete

bash

$curl -X DELETE 'https://api.newrelic.com/v2/alerts_policies/$POLICY_ID.json' \
>     -H "$API_KEY" -i

To view a list of existing policies for your account, use your user key, and include these optional values in the API call:

Optional policy name filter

Optional pagination value

API Explorer > Alerts Policies > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \
>     -H "$API_KEY" -i

Conditions for APM, browser, mobile

These API functions include links to the API Explorer, where you can create, update, delete, or list policy conditions. These calls are for conditions with these types of entities:

APM: Apps and key transactions
Browser: Apps and key transactions
Mobile: Mobile apps

Exception: The following APM conditions are not available from this API endpoint:

Conditions targeting labels (dynamic targeting)
Web transaction percentile conditions
Anomaly conditions

Important

The API Explorer provides information about other types of conditions using separate endpoints, including external services (APM and mobile), and synthetic monitoring. Consider all types of alert conditions when searching or updating. If your account hosts data in the EU data center, ensure you are using the proper API endpoints for EU region accounts.

To add conditions to policies, include these values in the API call:

Your
The policy_id (available from API Explorer > Alerts Policies > GET > List)
The required condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)
API Explorer > Alerts Conditions > POST > Create
```
curl -X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/$POLICY_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "condition": {
    "type": "string",
    "name": "string",
    "enabled": boolean,
    "entities": [
      integer
    ],
    "metric": "string",
    "gc_metric": "string",
    "condition_scope": "string",
    "violation_close_timer": integer,
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "user_defined": {
      "metric": "string",
      "value_function": "string"
    }
  }
}'
```
The JSON response returns a condition id, which you will need to update or delete the condition. You can also view the condition id from API Explorer > Alerts Conditions > GET > List.

To update conditions for policies, include these values in the API call:

Your user key
The condition's id (available from API Explorer > Alerts Conditions > GET > List)

The required condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)

API Explorer > Alerts Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "condition": {
    "type": "string",
    "name": "string",
    "enabled": boolean,
    "entities": [
      integer
    ],
    "metric": "string",
    "metric": "string",
    "gc_metric": "string",
    "condition_scope": "string",
    "violation_close_timer": integer,
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "user_defined": {
      "metric": "string",
      "value_function": "string"
    }
  }
}'

To delete conditions from policies, include these values in the API call:

Your user key
The condition_id (available from API Explorer > Alerts Conditions > GET > List)
API Explorer > Alerts Conditions > DELETE > Delete
bash
```
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \
>     -H "$API_KEY" -i
```

To view a list of existing conditions for your policy, use your REST API key or user key, and the associated policy_id in the API call.

API Explorer > Alerts Conditions > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_conditions.json?policy_id=$POLICY_ID' \
>     -H "$API_KEY" -i

Conditions for NRQL

These API functions include links to the API Explorer, where you can create, update, delete, or list NRQL conditions for your policies.

Exception: NRQL anomaly conditions are not available from this endpoint.

Important

If your organization hosts data in the EU data center, ensure you are using the proper API endpoints for EU region accounts.

Recommendation: Due to the way NRQL data is streamed, set the aggregation_method to EVENT_FLOW and use the default settings of 60 for aggregation_window and 120 for aggregation_delay. EVENT_FLOW works in most use-cases, but for a discussion on which use cases work better with EVENT_TIMER, see Which aggregation method to use?.

API Explorer > Alerts NRQL Conditions > POST > Create

To create NRQL conditions for policies:

curl -X POST 'https://api.newrelic.com/v2/alerts_nrql_conditions/policies/$POLICY_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "nrql_condition": {
    "type": "string",
    "name": "string",
    "runbook_url": "string",
    "enabled": boolean,
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "value_function": "string",
    "nrql": {
        "query": "string"
    },
    "signal": {
      "aggregation_window": "string",
      "slide_by": "integer",
      "aggregation_method": "string",
      "aggregation_delay": integer,
      "aggregation_timer": integer,
      "fill_option": "string",
      "fill_value": "string"
    },
    "expiration": {
      "expiration_duration": "string",
      "open_violation_on_expiration": boolean,
      "close_violations_on_expiration": boolean
    }
  }
}'

If you omit type or set it as static, it will default to standard NRQL alerting.

To update NRQL conditions for policies, include these values in the API call:

Your user key
The condition's id (available from API Explorer Alerts NRQL Conditions > GET > List)

The required condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)

API Explorer > Alerts NRQL Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "nrql_condition": {
    "name": "string",
    "runbook_url": "string",
    "enabled": boolean,
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "value_function": "string",
    "nrql": {
        "query": "string"
    }
  }
}'

To delete NRQL conditions from policies, include these values in the API call:

Your user key
The condition's id (available from API Explorer Alerts NRQL Conditions > GET > List)
API Explorer > Alerts NRQL Conditions > DELETE > Delete
bash
```
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \
>     -H "$API_KEY" -i
```

To view a list of existing conditions for your alert policy, use your user key or REST API key, and the associated policy_id in the API call.

API Explorer > Alerts NRQL Conditions > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_nrql_conditions.json' \
>     -H "$API_KEY" -i \
>     -d 'policy_id=$POLICY_ID'

Conditions for external services

These API functions include links to the API Explorer, where you can create, update, delete, or list policy conditions. These calls are for conditions for external services. The API calls can be used with and mobile monitoring apps.

Important

If your organization hosts data in the EU data center, ensure you are using the proper API endpoints for EU region accounts.

To add conditions for external services to policies that have APM or mobile monitoring apps, include these values in the API call:

Your user key
The policy_id (available from API Explorer > Alerts Policies > GET > List)

The required external_service_condition values in the API call (described in the API Explorer page and in the Alerts conditions API glossary)

API Explorer > Alerts External Service Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_external_service_conditions/policies/$POLICY_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "external_service_condition": {
    "type": "string",
    "name": "string",
    "enabled": boolean,
    "entities": [
      integer
    ],
    "external_service_url": "string",
    "metric": "string",
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ]
  }
}'

The JSON response returns a condition id, which you will need to update or delete the condition. You can also view the condition id from API Explorer > Alerts External Service Conditions > GET > List.

To update conditions for external services to policies that have APM or mobile monitoring apps, include these values in the API call:

Your user key
The external service condition's id (available from API Explorer > Alerts External Service Conditions > GET > List)

The required external_service_condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)

API Explorer > Alerts External Service Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "external_service_condition": {
    "type": "string",
    "name": "string",
    "enabled": boolean,
    "entities": [
      integer
    ],
    "external_service_url": "string",
    "metric": "string",
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ]
  }
}'

To delete conditions for external services from policies with APM or mobile monitoring apps, include these values in the API call:

Your user key
The condition_id (available from API Explorer > Alerts External Service Conditions > GET > List)
API Explorer > Alerts External Service Conditions > DELETE > Delete
bash
```
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \
>     -H "$API_KEY" -i
```

To view a list of existing conditions for policies with external service apps (APM or mobile monitoring), use your user key or REST API key and the associated policy_id in the API call.

API Explorer > Alerts External Service Conditions > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_external_service_conditions.json' \
>     -H "$API_KEY" -i \
>     -d 'policy_id=$POLICY_ID'

Conditions for synthetic monitoring

These API functions include links to the API Explorer, where you can create, update, delete, or list conditions for your alert policies. The API calls can be used with synthetic monitoring.

To add conditions to policies for synthetic monitoring, include these values in the API call:

Your user key
The policy_id (available from API Explorer > Alerts Policies > GET > List)
The required synthetics_condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)
API Explorer > Alerts Synthetics Conditions > POST > Create
```
curl -X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/$POLICY_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "synthetics_condition": {
    "name": "string",
    "monitor_id": "string",
    "runbook_url": "string",
    "enabled": boolean
  }
}'
```
The JSON response returns a condition id, which you will need to update or delete the condition. You can also view the condition id from API Explorer > Alerts Synthetics Conditions > GET > List.

To update policy conditions for synthetic monitoring, include these values in the API call:

Your user key
The condition id (available from API Explorer > Alerts Synthetics Conditions > GET > List)

The required synthetics_condition values in the API call (described in the API Explorer page to create alert conditions for synthetics and in the alerts conditions API glossary)

API Explorer > Alerts Synthetics Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "synthetics_condition": {
    "name": "string",
    "monitor_id": "string",
    "runbook_url": "string",
    "enabled": boolean
  }
}'

To delete policy conditions for synthetic monitoring, include these values in the API call:

Your user key
The condition_id (available from API Explorer > Alerts Synthetics Conditions > GET > List)
API Explorer > Alerts Synthetics Conditions > DELETE > Delete
bash
```
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \
>     -H "$API_KEY" -i
```

To view a list of existing policy conditions for synthetic monitoring, use your user key or REST API key, and the associated policy_id in the API call.

API Explorer > Alerts Synthetics Conditions > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_synthetics_conditions.json' \
>     -H "$API_KEY" -i \
>     -d 'policy_id=$POLICY_ID'

Multi-location conditions for synthetic monitoring

These API functions include links to the API Explorer, where you can create, update, delete, or list conditions for your alert policies. The API calls can be used for multi-location conditions with synthetic monitoring. Before creating or updating a condition, read the rules for multi-location alert conditions.

To add conditions to policies for multi-location synthetic monitoring, include these values in the API call:

Your user key
The policy_id (available from API Explorer > Alerts Policies > GET > List)

The required location_failure_condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)

API Explorer > Alerts Location Failure Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "location_failure_condition": {
    "name": "string",
    "runbook_url": "string",
    "enabled": boolean,
    "entities":
    [
        "string"
    ],
    "terms": [
        {
            "priority": "string",
            "threshold": integer,
        }
    ],
    "violation_time_limit_seconds": integer
  }
}'

The JSON response returns a condition id, which you will need to update or delete the condition. You can also view the condition id from API Explorer > Alerts Location Failure Conditions > GET > List.

To update policy conditions for multi-location synthetic monitoring, include these values in the API call:

Your user key
The condition id (available from API Explorer > Alerts Location Failure Conditions > GET > List)

The required location_failure_condition values in the API call (described in the API Explorer page and in the alerts conditions API glossary)

API Explorer > Alerts Location Failure Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \
     -H "$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "location_failure_condition": {
    "name": "string",
    "runbook_url": "string",
    "enabled": boolean,
    "entities":
    [
      "string"
    ],
    "terms": [
      {
        "priority": "string",
        "threshold": integer,
      }
    ],
    "violation_time_limit_seconds": integer
  }
}'

To delete policy conditions for multi-location synthetic monitoring, include these values in the API call:

Your user key
The condition_id (available from API Explorer > Alerts Location Failure Conditions > GET > List)
API Explorer > Alerts Location Failure Conditions > DELETE > Delete
bash
```
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \
>     -H "$API_KEY" -i
```

To view a list of existing policy conditions for multi-location synthetic monitoring, use your user key or REST API key, and the associated policy_id in the API call.

API Explorer > Alerts Location Failure Conditions > GET > List

bash

$curl -X GET 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json' \
>     -H "$API_KEY" -i

Alert entity conditions

These API functions include links to the API Explorer, where you can list, add and remove entities in the conditions for your alert policies.

Important

If your organization hosts data in the EU data center, ensure you are using the proper API endpoints for EU region accounts.

To view the conditions an entity that apply to an entity in APM, browser, mobile, or key transactions, include these values in the API call:

Your user key or REST API key
The entity_id This is the specific entity (alert target) to be monitored.
The entity_type, which must be one of the following:
- Application
- BrowserApplication
- MobileApplication
- KeyTransaction
API Explorer > Alerts Entity Conditions > GET > list
bash
```
$curl -X GET 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \
>     -H "$API_KEY" -i \
>     -G -d 'entity_type=$ENTITY_TYPE'
```

To add an entity to a condition, include these values in the API call:

Your user key
The entity_id This is the entity (alert target) to be monitored. It is the numeric ID for the APM application, browser app, key transaction, or mobile app.
The condition_id (available from API Explorer > Alerts Conditions > GET > List)

The entity_type, which must be one of the following:

Application
BrowserApplication
MobileApplication
KeyTransaction

API Explorer > Alerts Entity Conditions > PUT > Add

bash

$curl -X PUT 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \
>     -H "$API_KEY" -i \
>     -H 'Content-Type: application/json' \
>     -G -d 'entity_type=$ENTITY_TYPE&condition_id=$CONDITION_ID'

To remove an entity being monitored from a condition, include these values in the API call:

Your user key
The entity_id This is the specific monitored entity (alert target) to be removed. It is the numeric ID for the APM application, browser app, key transaction, or mobile app.
The condition_id (available from API Explorer > Alerts Conditions > GET > List)

The entity_type, which must be one of the following:

Application
BrowserApplication
MobileApplication
KeyTransaction

API Explorer > Alerts Entity Conditions > DELETE > Remove

bash

$curl -X DELETE 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \
>     -H "$API_KEY" -i \
>     -G -d 'entity_type=$ENTITY_ID&condition_id=$CONDITION_ID'

Before using the REST API .css-21sua1{background:none;border:none;width:0;padding:0;}

Available data and functions via REST API

Conditions excluded from the REST API

Alert policies

Important

Update policies

Delete existing policies

List existing policies

Conditions for APM, browser, mobile

Important

Create conditions for policies

Update conditions for policies

Delete conditions from policies

List existing conditions for policies

Conditions for NRQL

Important

Create NRQL conditions for policies

Update NRQL conditions for policies

Delete NRQL conditions for policies

List existing NRQL conditions for policies

Conditions for external services

Important

External services: Create conditions for policies

External services: Update conditions for policies

External services: Delete conditions from policies

External services: List existing conditions for policies

Conditions for synthetic monitoring

Synthetic monitoring: Create conditions for policies

Synthetic monitoring: Update conditions for policies

Synthetic monitoring: Delete conditions from policies

Synthetic monitoring: List existing conditions for policies

Multi-location conditions for synthetic monitoring

Multi-location synthetics: Create conditions for policies

Multi-location synthetics: Update conditions for policies

Multi-location synthetics: Delete conditions for policies

Multi-location synthetics: List existing conditions for policies

Alert entity conditions

Important

List condition by entity

Add an entity to a condition

Remove an entity from a condition

Before using the REST API