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
, o parâmetro disponível, os códigos de status de resposta potenciais e a estrutura de resposta JSON para cada uma das chamadas de API disponíveis. Você também pode criar condições do alerta na interface.
Antes de usar a API REST
Antes de usar a API REST para gerenciar dados de alertas, leia o documento Introdução ao uso de alertas com nosso NerdGraph API .
Para alertas de infraestrutura, consulte REST API para alertas de monitoramento de infraestrutura
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:
|
Manter os dados da conta | Você pode ter uma função |
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 |
---|---|
| Determina como os alertas criarão incidentes. Deve ser um dos seguintes:
|
A política |
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 esta API para atualizar name
e incident_preference
de uma política existente. Você precisará da sua chave de usuário.
Required values | Definition |
---|---|
| Para encontrar o ID de uma política, use uma destas opções:
|
| Determina como os alertas criarão incidentes. Deve ser um dos seguintes:
|
A política 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 "$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
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_policies/$POLICY_ID.json' \> -H "$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
bash$curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \>-H "$API_KEY" -i
Condições para APM, navegador e celular
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 hospeda 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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#type">type</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>": [$integer$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"gc_metric": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#condition-scope">condition_scope</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#violation_close_timer">violation_close_timer</a>": integer,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "string"$}$],$"user_defined": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_value_function">value_function</a>": "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çãoid
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
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"condition": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#type">type</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>": [$integer$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"gc_metric": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#condition-scope">condition_scope</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#violation_close_timer">violation_close_timer</a>": integer,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "string"$}$],$"user_defined": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_value_function">value_function</a>": "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
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "$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 "$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.
Recomendação: Devido à maneira 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 Escolha seu método de agregação.
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 "$API_KEY" -i \> -H 'Content-Type: application/json' \> -d \>'{$ "nrql_condition": {$ "type": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$ "terms": [$ {$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "string"$ }$ ],$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_value_function">value_function</a>": "string",$ "nrql": {$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#nrql-query">query</a>": "string"$ },$ "signal": {$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#signal_aggregation_window">aggregation_window</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#signal_slide_by">slide_by</a>": "integer",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#signal_aggregation_method">aggregation_method</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#signal_aggregation_delay">aggregation_delay</a>": integer,$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#signal_aggregation_timer">aggregation_timer</a>": integer,$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#fill_option">fill_option</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#fill_value">fill_value</a>": "string"$ },$ "expiration": {$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#expiration_duration">expiration_duration</a>": "string",$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#expiration_duration">open_violation_on_expiration</a>": boolean,$ "<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#expiration_duration">close_violations_on_expiration</a>": 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
A condição
id
(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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "string"$}$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_value_function">value_function</a>": "string",$"nrql": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#nrql-query">query</a>": "string"$}$}$}'
Para excluir condições NRQL das políticas, inclua estes valores na chamada de API:
Sua chave de usuário
A condição
id
(disponível no 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
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]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'
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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#type">type</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>": [$integer$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#external_service_url">external_service_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "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çãoid
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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#type">type</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>": [$integer$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#external_service_url">external_service_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "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
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \>-H "$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 "$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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#monitor_id">monitor_id</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": 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çãoid
de API Explorer > Alerts Synthetics 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
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "X-Api-Key:<a href='/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key'>$API_KEY</a>" -i \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"condition": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#type">type</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>": [$integer$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#metric">metric</a>": "string",$"gc_metric": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#condition-scope">condition_scope</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#violation_close_timer">violation_close_timer</a>": integer,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_duration">duration</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_operator">operator</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_threshold">threshold</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#terms_time_function">time_function</a>": "string"$}$],$"user_defined": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_metric">metric</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#user_defined_value_function">value_function</a>": "string"$}$}$}'
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
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \>-H "$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 "$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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>":$[$"string"$],$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#threshold">threshold</a>": integer,$}$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#violation_time_limit_seconds">violation_time_limit_seconds</a>": 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çãoid
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
bash$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": {$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#name">name</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#runbook_url">runbook_url</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#enabled">enabled</a>": boolean,$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#entities">entities</a>":$[$"string"$],$"terms": [${$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#priority">priority</a>": "string",$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#threshold">threshold</a>": integer,$}$],$"<a href="/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/rest-api-alerts/alerts-conditions-api-field-names#violation_time_limit_seconds">violation_time_limit_seconds</a>": 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
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \>-H "$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 "$API_KEY" -i
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:
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
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'
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
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'
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
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'