Navegar na documentação

Consultar incidentes pela API

Três rotas de leitura dão à sua automação a mesma visão que a aba Incidentes e o Resumo do app: a lista filtrável, a contagem por severidade e o gráfico de atividade das últimas 24 horas. Todas exigem o token svc_ (ver Autenticação, erros e limites).

Listar incidentes

GET/api/v1/svc/incidents

Devolve incidentes da empresa, por padrão só os ativos, ordenados da pior severidade para a melhor, 20 por página. Com um token svc_ a lista não é filtrada por Grupos visíveis: você enxerga tudo, como um Admin.

curl -s "https://app.flowbix.com/api/v1/svc/incidents?status=active&severity=4,5&sort=newest&limit=50" \
  -H "Authorization: Bearer svc_SEU_TOKEN"

Parâmetros de query

Todos são opcionais. Valor fora do domínio devolve 400 com parâmetro inválido: <nome>.

ParâmetroValoresPadrãoDescrição
statusactive · resolved · allactiveEstado atual do incidente.
severityCSV de 0 a 5, até 6 valorestodasEx.: severity=4,5 para Alta e Desastre.
idinteiro > 0Busca um incidente específico. Combine com status=all, pois ele pode já ter resolvido.
hosttexto, até 255Host contém o texto.
qtexto, até 255Nome do incidente (título) contém o texto.
ackunacked · acked · acked_by_metodosEstado de reconhecimento. acked_by_me depende de um usuário; com token svc_ não filtra nada.
age_min_secs0 a 34 560 000Só incidentes abertos há pelo menos N segundos.
age_max_secs0 a 34 560 000Só incidentes abertos há no máximo N segundos.
kindzabbix · webhookambasOrigem: coletados do Zabbix ou recebidos por fonte de dados.
zabbix_server_idinteiro > 0todosSó um servidor Zabbix.
environment_idinteiro > 0todasSó uma fonte de dados (webhook). O id é o mesmo de GET /svc/webhooks.
group_idid do grupo, até 64 caracteresUm host group do Zabbix.
group_idsCSV de ids, até 50Vários host groups.
trigger_idsCSV de ids, até 50Várias triggers.
hostsparâmetro repetido, até 50Nomes exatos de host: hosts=core-01&hosts=core-02. Repetido, não CSV, porque nome de host pode ter vírgula.
sortseverity_desc · severity_asc · newest · oldest · host · recurrence · resolvedseverity_descOrdenação. Ver tabela abaixo.
recently_resolved_secs0 a 18000Junto com status=active, inclui também os resolvidos há até N segundos.
view_idinteiro > 0Aplica uma Visão salva. A visão define origem e escopo; kind, zabbix_server_id e environment_id são ignorados. Visão inexistente devolve 404 visão não encontrada.
limit1 a 10020Itens por página.
offset≥ 00Deslocamento.

Ordenações

sortOrdem
severity_descSeveridade maior primeiro, depois visto por último mais recente
severity_ascSeveridade menor primeiro
newestCriados mais recentemente primeiro
oldestCriados há mais tempo primeiro
hostHost em ordem alfabética, depois severidade maior
recurrenceMais recorrências primeiro, depois severidade maior
resolvedResolvidos mais recentemente primeiro (útil com status=resolved)
Acompanhamento incremental. Use sort=newest&limit=100, guarde o maior id recebido e, a cada consulta, processe só o que tiver id maior. Os ids são crescentes, então isso não depende de relógio nem de fuso.

Resposta

{
  "incidents": [
    {
      "id": 48213,
      "source": "zabbix",
      "origin_name": "Zabbix Matriz",
      "host": "core-sw-01",
      "trigger_id": "23907",
      "title": "Interface Gi1/0/24 down",
      "message": "Link down on Gi1/0/24",
      "severity": 4,
      "severity_label": "high",
      "status": "active",
      "acknowledged": false,
      "recurrence_count": 3,
      "last_seen": "2026-08-26T14:03:11Z",
      "created_at": "2026-08-26T13:41:52Z",
      "resolved_at": null
    }
  ],
  "pagination": { "limit": 50, "offset": 0, "total": 1 }
}
CampoTipoDescrição
idinteiroId do incidente no Sentrya. É o que as rotas de ACK e dispensar esperam.
sourcetextoRótulo da origem: zabbix ou webhook.
origin_nametextoNome do servidor Zabbix ou da fonte de dados que gerou o incidente.
hosttextoHost / Equipamento.
trigger_idtextoId da trigger no Zabbix. Em webhook, é a key enviada pela fonte (ver Ciclo de vida do alerta e a key).
titletextoNome do incidente.
messagetextoDescrição / corpo do alerta.
severityinteiro 0–5Severidade na escala do Zabbix.
severity_labeltextonot_classified, info, warning, average, high ou disaster.
statustextoactive ou resolved.
acknowledgedbooleanoSe há reconhecimento (ACK) registrado.
recurrence_countinteiroQuantas vezes o mesmo problema reabriu (ver Recorrências).
last_seenRFC 3339 UTCÚltima vez que a origem confirmou o problema.
created_atRFC 3339 UTCQuando o incidente foi aberto.
resolved_atRFC 3339 UTC ou nullQuando foi resolvido. null enquanto ativo.

Resumo por severidade

GET/api/v1/svc/incidents/summary

Conta os incidentes ativos por severidade. É a rota mais barata da API e a que o n8n usa para testar a credencial.

ParâmetroValoresDescrição
kindzabbix · webhookRestringe a origem. Vazio soma as duas.
zabbix_server_idinteiro > 0Só um servidor Zabbix.
environment_idinteiro > 0Só uma fonte de dados.
view_idinteiro > 0Conta dentro de uma Visão salva. Quando presente, os três parâmetros acima são ignorados.
curl -s "https://app.flowbix.com/api/v1/svc/incidents/summary?kind=zabbix" \
  -H "Authorization: Bearer svc_SEU_TOKEN"
{
  "total_active": 17,
  "by_severity": [
    { "severity": 5, "label": "disaster",       "count": 1 },
    { "severity": 4, "label": "high",           "count": 4 },
    { "severity": 3, "label": "average",        "count": 6 },
    { "severity": 2, "label": "warning",        "count": 6 },
    { "severity": 1, "label": "info",           "count": 0 },
    { "severity": 0, "label": "not_classified", "count": 0 }
  ]
}

by_severity tem sempre as 6 entradas, da pior severidade para a melhor, incluindo as com contagem zero. total_active é a soma.

Atividade das últimas 24 horas

GET/api/v1/svc/incidents/activity

Devolve quantos alertas surgiram em cada hora das últimas 24, o mesmo dado do gráfico de pico na Visão geral (ver Resumo e atividade das últimas 24h). Aceita kind, zabbix_server_id e environment_id com o mesmo significado do resumo.

curl -s "https://app.flowbix.com/api/v1/svc/incidents/activity" \
  -H "Authorization: Bearer svc_SEU_TOKEN"
{
  "total": 42,
  "peak_index": 21,
  "buckets": [
    { "start": "2026-08-25T15:00:00Z", "count": 0 },
    { "start": "2026-08-25T16:00:00Z", "count": 3 },
    …
    { "start": "2026-08-26T14:00:00Z", "count": 2 }
  ]
}
CampoDescrição
buckets24 baldes contíguos de uma hora, do mais antigo para o mais recente. start é o início do balde em UTC.
totalSoma das 24 contagens.
peak_indexPosição (0 a 23) do balde com maior contagem; em empate, o mais recente. Vale -1 quando todas as contagens são zero.
O que cada balde conta. Incidentes cuja abertura (created_at) caiu naquela hora, ativos ou já resolvidos. Serve para enxergar em que hora a rede ficou instável, não para medir quanto tempo cada problema durou.

Veja também