Chamada REST de API para alerta

Nossa API REST é a API original da New Relic para definir programaticamente as configurações de alerta da New Relic (saiba mais sobre NerdGraph, nossa API preferida).

O REST API Explorer também inclui o formato de solicitação curl, parâmetro disponível, possíveis códigos de status de resposta e estrutura de resposta JSON para cada uma das chamadas de API disponíveis. Você também pode criar condição do alerta na interface.

Antes de usar a API REST

Antes de usar a API REST para gerenciar dados de alertas, leia a introdução às APIs para e inteligência aplicada.

Para alertas de infraestrutura, consulte API REST para alerta de monitoramento de infraestrutura.

Além disso, se ainda não o fez, crie sua conta New Relic gratuita abaixo para começar a monitorar seus dados hoje mesmo.

Dados e funções disponíveis via REST API

REST API functions	Comments
Ver dados da conta	Em geral, qualquer função pode usar uma chave ou de API REST com GET > List funções para view alertar dados. O proprietário e os administradores da conta podem usar sua chave de API. A saída da lista será paginada. As funções disponíveis incluem: Política de alertas Condições para , e (algumas limitações se aplicam.) Condições para serviços externos Condições para monitoramento sintético Condições para monitoramento sintético em vários locais Condições para NRQL (algumas limitações se aplicam). Evento Incidente Incidente
Manter os dados da conta	Você pode ter uma função de Proprietário ou Administrador em sua conta and uma chave de usuário or ter uma função personalizada que concede permissões para gerenciar alertas and uma chave de usuário para usar qualquer função de manutenção, incluindo POST > Create, PUT > Add, PUT > Update e DELETE.

REST API functions

Comments

Ver dados da conta

Em geral, qualquer função pode usar uma chave ou de API REST com GET > List funções para view alertar dados. O proprietário e os administradores da conta podem usar sua chave de API.

A saída da lista será paginada. As funções disponíveis incluem:

Política de alertas
Condições para
,
e
(algumas limitações se aplicam.)
Condições para serviços externos
Condições para monitoramento sintético
Condições para monitoramento sintético em vários locais
Condições para NRQL (algumas limitações se aplicam).
Evento
Incidente
Incidente

Manter os dados da conta

Você pode ter uma função de Proprietário ou Administrador em sua conta and uma chave de usuário or ter uma função personalizada que concede permissões para gerenciar alertas and uma chave de usuário para usar qualquer função de manutenção, incluindo POST > Create, PUT > Add, PUT > Update e DELETE.

Condições excluídas da API REST

Esses tipos de condições não possuem endpoint disponível na API:

APM: transação da web percentil, condições de segmentação de rótulos e anomalia
NRQL: anomalia

Política de alertas

Essas funções de API incluem links para o API Explorer, onde você pode criar, excluir ou listar políticas.

Importante

Se a sua organização hospedar dados no data center da UE, verifique se você está usando os endpoints de API adequados para contas da região da UE.

Para adicionar novas políticas, use sua chave de usuário e inclua estes dois valores na chamada de API:

Required values	Definition
Incidente `incident_preference`	Determina como o alerta criará o incidente. Este deve ser um dos seguintes: `PER_POLICY` (padrão): Acumulação por política. `PER_CONDITION`: Acumule por condição. `PER_CONDITION_AND_TARGET`: Acumule por destino e condição.
Política `name`	A política `name` é obrigatória. Deixá-lo inalterado criará uma política chamada string.

Required values

Definition

Incidente incident_preference

Determina como o alerta criará o incidente. Este deve ser um dos seguintes:

PER_POLICY (padrão): Acumulação por política.
PER_CONDITION: Acumule por condição.
PER_CONDITION_AND_TARGET: Acumule por destino e condição.

Política name

A política name é obrigatória. Deixá-lo inalterado criará uma política chamada string.

API Explorer > Alerts Policies > POST > Create

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

Use esta API para atualizar name e incident_preference de uma política existente. Você precisará da sua chave de usuário.

Required values	Definition
`id`	Obrigatório. Para encontrar o ID de uma política, use uma destas opções: Na interface do usuário: na página da interface do usuário de uma política, encontre o ID abaixo do nome da política. Com a API: use a API List Policy.
Incidente `incident_preference`	Determina como o alerta criará o incidente. Deve ser um dos seguintes: `PER_POLICY` (padrão): Acumulação por política. `PER_CONDITION`: Acumule por condição. `PER_CONDITION_AND_TARGET`: Acumule por destino e condição.
Política `name`	Required. Se você não alterar o nome, o padrão será uma política chamada string. Para encontrar o nome exato de uma política, use a API Listar políticas.

Required values

Definition

id

Obrigatório. Para encontrar o ID de uma política, use uma destas opções:

Na interface do usuário: na página da interface do usuário de uma política, encontre o ID abaixo do nome da política.
Com a API: use a API List Policy.

Incidente incident_preference

Determina como o alerta criará o incidente. Deve ser um dos seguintes:

PER_POLICY (padrão): Acumulação por política.
PER_CONDITION: Acumule por condição.
PER_CONDITION_AND_TARGET: Acumule por destino e condição.

Política name

Required. Se você não alterar o nome, o padrão será uma política chamada string.

Para encontrar o nome exato de uma política, use a API Listar políticas.

API Explorer > Alerts Policies > PUT > Update

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

Para excluir uma política existente, use sua chave de usuário e inclua policy_id (disponível em API Explorer > Alerts Policies > GET > List) na chamada de API:

API Explorer > Alerts Policies > DELETE > Delete

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

Para visualizar uma lista de políticas existentes para sua conta, use sua chave de usuário e inclua estes valores opcionais na chamada de API:

Filtro opcional de política name

Valor de paginação opcional

API Explorer > Alerts Policies > GET > List

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

Condições para APM, browser, mobile

Essas funções de API incluem links para o API Explorer, onde você pode criar, atualizar, excluir ou listar condições de política. Estas chamadas são para condições com estes tipos de entidade:

APM: Apps e transação principal
Browser: Apps e transação principal
mobile: aplicativos móveis

Exception: As seguintes condições de APM são not available destes endpoints da API:

Rótulos de segmentação por condições (segmentação dinâmica)
Condições de porcentagem de transação da web
Condições de anomalia

Importante

O API Explorer fornece informações sobre outros tipos de condições usando separate endpoints, incluindo serviços externos (APM e dispositivos móveis) e monitoramento sintético. Considere todos os tipos de condição do alerta ao pesquisar ou atualizar. Se sua conta hospedar dados no data center da UE, certifique-se de usar os endpoints de API adequados para contas da região da UE.

Para adicionar condições às políticas, inclua estes valores na chamada de API:

Seu
O policy_id (disponível em API Explorer > Alerts Policies > GET > List)

Os valores condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

API Explorer > Alerts Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/$POLICY_ID.json' \
     -H "X-Api-Key:$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"
    }
  }
}'

A resposta JSON retorna uma condição id, que será necessária para atualizar ou excluir a condição. Você também pode visualizar a condição id de API Explorer > Alerts Conditions > GET > List.

Para atualizar as condições das políticas, inclua estes valores na chamada de API:

Sua chave de usuário
O id da condição (disponível em API Explorer > Alerts Conditions > GET > List)

Os valores condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

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 '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"
    }
  }
}'

Para excluir condições das políticas, inclua estes valores na chamada de API:

Sua chave de usuário
O condition_id (disponível em API Explorer > Alerts Conditions > GET > List)
API Explorer > Alerts Conditions > DELETE > Delete
```
curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$API_KEY" -i
```

Para visualizar uma lista de condições existentes para sua política, use sua chave de API REST ou chave de usuário e o policy_id associado na chamada de API.

API Explorer > Alerts Conditions > GET > List

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

Condições para NRQL

Essas funções de API incluem links para o API Explorer, onde você pode criar, atualizar, excluir ou listar condições NRQL para suas políticas.

Exception: As condições de anomalia NRQL são not available deste endpoint.

Importante

Se a sua organização hospedar dados no data center da UE, verifique se você está usando os endpoints de API adequados para contas da região da UE.

Recommendation: Devido à forma como os dados NRQL são transmitidos, defina aggregation_method como EVENT_FLOW e use as configurações padrão de 60 para aggregation_window e 120 para aggregation_delay. EVENT_FLOW funciona na maioria dos casos de uso, mas para uma discussão sobre quais casos de uso funcionam melhor com EVENT_TIMER, consulte Qual método de agregação usar?.

API Explorer > Alerts NRQL Conditions > POST > Create

Para criar condições NRQL para políticas:

curl -X POST 'https://api.newrelic.com/v2/alerts_nrql_conditions/policies/$POLICY_ID.json' \
     -H "X-Api-Key:$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
    }
  }
}'

Se você omitir type ou defini-lo como static, o padrão será o alerta NRQL padrão.

Para atualizar as condições NRQL para políticas, inclua estes valores na chamada de API:

Sua chave de usuário
O id da condição (disponível no API Explorer Alerts NRQL Conditions > GET > List)

Os valores condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

API Explorer > Alerts NRQL Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$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"
    }
  }
}'

Para excluir condições NRQL das políticas, inclua estes valores na chamada de API:

Sua chave de usuário
O id da condição (disponível no API Explorer Alerts NRQL Conditions > GET > List)
API Explorer > Alerts NRQL Conditions > DELETE > Delete
```
curl -X DELETE 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$API_KEY" -i
```

Para visualizar uma lista de condições existentes para sua política de alertas, use sua chave de usuário ou chave de API REST e o policy_id associado na chamada de API.

API Explorer > Alerts NRQL Conditions > GET > List

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

Condições para serviços externos

Essas funções de API incluem links para o API Explorer, onde você pode criar, atualizar, excluir ou listar condições de política. Estas chamadas são para condições de serviços externos. A chamada de API pode ser usada com e aplicativos de monitoramento de dispositivos móveis.

Importante

Se a sua organização hospedar dados no data center da UE, verifique se você está usando os endpoints de API adequados para contas da região da UE.

Para adicionar condições de serviços externos a políticas que possuem aplicativos APM ou monitoramento de Mobile, inclua estes valores na chamada de API:

Sua chave de usuário
O policy_id (disponível em API Explorer > Alerts Policies > GET > List)

Os valores external_service_condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

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 "X-Api-Key:$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"
      }
    ]
  }
}'

A resposta JSON retorna uma condição id, que será necessária para atualizar ou excluir a condição. Você também pode visualizar a condição id de API Explorer > Alerts External Service Conditions > GET > List.

Para atualizar condições de serviços externos para políticas que possuem aplicativos APM ou monitoramento de Mobile, inclua estes valores na chamada de API:

Sua chave de usuário
A condição de serviço externo id (disponível em API Explorer > Alerts External Service Conditions > GET > List)

Os valores external_service_condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

API Explorer > Alerts External Service Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$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"
      }
    ]
  }
}'

Para excluir condições de serviços externos de políticas com APM ou aplicativos de monitoramento de dispositivos móveis, inclua estes valores na chamada de API:

Sua chave de usuário
O condition_id (disponível em API Explorer > Alerts External Service Conditions > GET > List)
API Explorer > Alerts External Service Conditions > DELETE > Delete
```
curl -X DELETE 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$API_KEY" -i
```

Para visualizar uma lista de condições existentes para políticas com aplicativos de serviços externos (APM ou monitoramento de Mobile), use sua chave de usuário ou chave de API REST e o policy_id associado na chamada de API.

API Explorer > Alerts External Service Conditions > GET > List

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

Condições para monitoramento sintético

Essas funções de API incluem links para o API Explorer, onde você pode criar, atualizar, excluir ou listar condições para sua política de alertas. A chamada de API pode ser utilizada com monitoramento sintético.

Para adicionar condições às políticas para monitoramento sintético, inclua estes valores na chamada de API:

Sua chave de usuário
O policy_id (disponível em API Explorer > Alerts Policies > GET > List)
Os valores synthetics_condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)
API Explorer > Alerts Synthetics Conditions > POST > Create
```
curl -X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/$POLICY_ID.json' \
     -H "X-Api-Key:$API_KEY" -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "synthetics_condition": {
    "name": "string",
    "monitor_id": "string",
    "runbook_url": "string",
    "enabled": boolean
  }
}'
```
A resposta JSON retorna uma condição id, que será necessária para atualizar ou excluir a condição. Você também pode visualizar a condição id de API Explorer > Alerts Synthetics Conditions > GET > List.

Para atualizar as condições da política para monitoramento sintético, inclua estes valores na chamada de API:

Sua chave de usuário
A condição id (disponível em API Explorer > Alerts Synthetics Conditions > GET > List)

Os valores synthetics_condition necessários na chamada de API (descritos na página do API Explorer para criar condição do alerta para Sintético e no glossário da API condição do alerta)

API Explorer > Alerts Synthetics Conditions > PUT > Update

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

Para excluir condições de política para monitoramento sintético, inclua estes valores na chamada de API:

Sua chave de usuário
O condition_id (disponível em API Explorer > Alerts Synthetics Conditions > GET > List)
API Explorer > Alerts Synthetics Conditions > DELETE > Delete
```
curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$API_KEY" -i
```

Para visualizar uma lista de condições de política existentes para monitoramento sintético, use sua chave de usuário ou chave de API REST e o policy_id associado na chamada de API.

API Explorer > Alerts Synthetics Conditions > GET > List

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

Condições de vários locais para monitoramento sintético

Essas funções de API incluem links para o API Explorer, onde você pode criar, atualizar, excluir ou listar condições para sua política de alertas. A chamada de API pode ser usada para condições multilocais com monitoramento sintético. Antes de criar ou atualizar uma condição, leia as regras para condição do alerta em vários locais.

Para adicionar condições às políticas para monitoramento sintético de vários locais, inclua estes valores na chamada de API:

Sua chave de usuário
O policy_id (disponível em API Explorer > Alerts Policies > GET > List)

Os valores location_failure_condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

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 "X-Api-Key:$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
  }
}'

A resposta JSON retorna uma condição id, que será necessária para atualizar ou excluir a condição. Você também pode visualizar a condição id de API Explorer > Alerts Location Failure Conditions > GET > List.

Para atualizar as condições da política para monitoramento sintético de vários locais, inclua estes valores na chamada de API:

Sua chave de usuário
A condição id (disponível em API Explorer > Alerts Location Failure Conditions > GET > List)

Os valores location_failure_condition necessários na chamada de API (descritos na página do API Explorer e no glossário da API condição do alerta)

API Explorer > Alerts Location Failure Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$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
  }
}'

Para excluir condições de política para monitoramento sintético de vários locais, inclua estes valores na chamada de API:

Sua chave de usuário
O condition_id (disponível em API Explorer > Alerts Location Failure Conditions > GET > List)
API Explorer > Alerts Location Failure Conditions > DELETE > Delete
```
curl -X DELETE 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \
     -H "X-Api-Key:$API_KEY" -i
```

Para visualizar uma lista de condições de política existentes para monitoramento sintético de vários locais, use sua chave de usuário ou chave de API REST e o policy_id associado na chamada de API.

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

Atividade de alerta: evento, incidente

Essas funções da API incluem links para o API Explorer, onde você pode visualizar informações sobre eventos e incidentes para sua política de alertas.

Importante

Se a sua organização hospedar dados no data center da UE, verifique se você está usando os endpoints de API adequados para contas da região da UE.

Para visualizar o evento da entidade monitorada por APM, browser, mobile, monitoramento sintético e alerta, inclua estes valores na chamada de API:

Sua chave de usuário ou chave de API REST
Outros valores opcionais para usar como filtros (descritos na página do API Explorer) que dependem do tipo de produto (monitoramento de Browser, monitoramento de Mobile, etc.), entidade (como apps ou transação principal para APM, monitoramento sintético, etc. ) e tipo de evento (notificação, implantação, instrumentação, etc.)

Um valor de paginação opcional

API Explorer > Alerts Events > GET > List

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

Para visualizar o incidente de qualquer monitor de entidade da sua conta, inclua estes valores na chamada de API:

Sua chave de usuário ou chave de API REST
Um sinalizador opcional para mostrar apenas os incidentes que estão abertos no momento
Um valor de paginação opcional
API Explorer > Alerts Incidents > GET > List
```
curl -X GET 'https://api.newrelic.com/v2/alerts_violations.json' \
     -H "X-Api-Key:$API_KEY" -i
```
Dica
Para encontrar informações sobre políticas, condições e incidentes: pegue os IDs encontrados na seção links da propriedade violations e coloque-os nos URLs contidos na propriedade links externa da carga útil.

Para visualizar o incidente de qualquer monitor de entidade da sua conta, inclua estes valores na chamada de API:

Sua chave de usuário ou chave de API REST
Um sinalizador opcional para mostrar apenas os incidentes que estão abertos no momento
Um sinalizador opcional para excluir dados de incidentes da resposta

Um valor de paginação opcional

API Explorer > Alerts Incidents > GET > List

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

Para mostrar um único incidente associado à sua conta, inclua estes valores na chamada de API:

Sua chave de usuário ou chave de API REST

Um ID de incidente

API Explorer > Alerts Incidents > GET > Show

curl -X GET 'https://api.newrelic.com/v2/alerts_incidents/{id}.json' \
     -H "X-Api-Key:$API_KEY" -i

Para confirmar um incidente associado à sua conta, inclua estes valores na chamada de API:

Sua chave de usuário

Um ID de incidente

API Explorer > Alerts Incidents > PUT > Acknowledge

curl -X PUT 'https://api.newrelic.com/v2/alerts_incidents/{id}/acknowledge.json' \
     -H "X-Api-Key:$API_KEY" -i \
     -H 'Content-Type: application/json'

Para encerrar um incidente associado à sua conta, inclua estes valores na chamada de API:

Sua chave de usuário

Um ID de incidente

API Explorer > Alerts Incidents > PUT > Close

curl -X PUT 'https://api.newrelic.com/v2/alerts_incidents/{id}/close.json' \
     -H "X-Api-Key:$API_KEY" -i \
     -H 'Content-Type: application/json'

Condições da entidade de alerta

Estas funções da API incluem links para o API Explorer, onde você pode listar, adicionar e remover entidades nas condições da sua política de alertas.

Importante

Se a sua organização hospedar dados no data center da UE, verifique se você está usando os endpoints de API adequados para contas da região da UE.

Para visualizar as condições que uma entidade se aplica a uma entidade no APM, browser, mobile ou transação principal, inclua estes valores na chamada da API:

Sua chave de usuário ou chave de API REST
O entity_id Esta é a entidade específica (destino do alerta) a ser monitorada.
O entity_type, que deve ser um dos seguintes:
- Aplicativo
- Aplicativo de browser
- MobileApplication
- KeyTransaction
API Explorer > Alerts Entity Conditions > GET > list
```
curl -X GET 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \
     -H "X-Api-Key:$API_KEY" -i \
     -G -d 'entity_type=$ENTITY_TYPE'
```

Para adicionar uma entidade a uma condição, inclua estes valores na chamada de API:

Sua chave de usuário
O entity_id Esta é a entidade (destino do alerta) a ser monitorada. É o ID numérico do aplicativo APM, aplicativo de browser, transação principal ou aplicativo mobile.
O condition_id (disponível em API Explorer > Alerts Conditions > GET > List)

O entity_type, que deve ser um dos seguintes:

Aplicativo
Aplicativo de browser
MobileApplication
KeyTransaction

API Explorer > Alerts Entity Conditions > PUT > Add

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

Para remover uma entidade que está sendo monitorada de uma condição, inclua estes valores na chamada de API:

Sua chave de usuário
O entity_id Esta é a entidade de monitor específica (destino do alerta) a ser removida. É o ID numérico do aplicativo APM, aplicativo de browser, principal de transação ou aplicativo mobile.
O condition_id (disponível em API Explorer > Alerts Conditions > GET > List)

O entity_type, que deve ser um dos seguintes:

Aplicativo
Aplicativo de browser
MobileApplication
KeyTransaction

API Explorer > Alerts Entity Conditions > DELETE > Remove

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

Esta tradução de máquina é fornecida para sua comodidade.

Antes de usar a API REST .css-21sua1{background:none;border:none;width:0;padding:0;}

Dados e funções disponíveis via REST API

Condições excluídas da API REST

Política de alertas

Importante

Atualizar políticas

Excluir políticas existentes

Listar políticas existentes

Condições para APM, browser, mobile

Importante

Crie condições para políticas

Atualizar condições para políticas

Excluir condições das políticas

Listar as condições existentes para políticas

Condições para NRQL

Importante

Crie condições NRQL para políticas

Atualizar condições NRQL para políticas

Excluir condições NRQL para políticas

Listar as condições NRQL existentes para políticas

Condições para serviços externos

Importante

Serviços externos: Crie condições para políticas

Serviços externos: atualizar condições para políticas

Serviços externos: excluir condições das políticas

Serviços externos: listar as condições existentes para políticas

Condições para monitoramento sintético

Monitoramento sintético: Criar condições para políticas

Monitoramento sintético: Condições de atualização para políticas

Monitoramento sintético: Excluir condições das políticas

Monitoramento sintético: Listar condições existentes para políticas

Condições de vários locais para monitoramento sintético

Multilocalização Sintético: Crie condições para políticas

Multi-location Sintético: Atualizar condições para políticas

Multi-location Sintético: Excluir condições para políticas

Multilocalização Sintético: Liste as condições existentes para apólices

Atividade de alerta: evento, incidente

Importante

Listar evento

Lista de incidentes

Listar incidente

Mostrar incidente

Reconhecer o incidente

Fechar incidente

Condições da entidade de alerta

Importante

Listar condição por entidade

Adicionar uma entidade a uma condição

Remover uma entidade de uma condição

Antes de usar a API REST