REST API calls for alerts

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

API Explorer > Alerts Policies > POST > Create

$
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.

API Explorer > Alerts Policies > PUT > Update

$
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

$
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

  Copy

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

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

• Your user key

• 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

  bash

  Copy

  $
  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

  bash

  Copy

  $
  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

  Copy

  $
  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

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

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 Choose your aggregation method.

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

  bash

  Copy

  $
  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

  Copy

  $
  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]https://api.newrelic.com/docs/#/Alerts%20NRQL%20Conditions/get_alerts_nrql_conditions_json) > Alerts NRQL Conditions > GET > List

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

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

  bash

  Copy

  $
  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

  bash

  Copy

  $
  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

$
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

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

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

  bash

  Copy

  $
  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 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 "X-Api-Key:$API_KEY" -i \
>
     -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 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

  bash

  Copy

  $
  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

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

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

  bash

  Copy

  $
  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

  bash

  Copy

  $
  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

  bash

  Copy

  $
  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

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

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

  Copy

  $
  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

  Copy

  $
  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

  Copy

  $
  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'