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.
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:
Você pode ter uma função Owner ou Admin em sua conta and uma chave de usuário ou ter uma função personalizada que concede permissões para gerenciar alertas e 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.
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"
$
}
$
}'
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 > 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)
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": {
$
"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:
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:
bash
$
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
$
}
$
}
$
}'
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:
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.
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.
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:
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": {
$
"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:
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": {
$
"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:
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
bash
$
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:
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": {
$
"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 das políticas, inclua estes valores na chamada de API:
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
bash
$
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:
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": {
$
"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:
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
bash
$
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.
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 (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:
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'\