API e Automação
A API estável/documentada usa /api/v0 e header X-Auth-Token. Ela cobre Devices, Groups, Ports, Alerts, Routing, Inventory, Bills, Services, Logs, Pollers e Locations.
Ponto técnico 1
API v0: A API estável/documentada usa /api/v0 e header X-Auth-Token. Ela cobre Devices, Groups, Ports, Alerts, Routing, Inventory, Bills, Services, Logs, Pollers e Locations.
Ponto técnico 2
API v1 Beta: A documentação atual também possui /api/v1 em beta, desabilitada por padrão e autenticada por Bearer token. Não trate v1 como substituta estável de v0 ainda.
Ponto técnico 3
Tokens: Crie token por usuário/integracão e aplique menor privilégio.
Ponto técnico 4
Descoberta de endpoints: GET /api/v0 lista rotas disponíveis e ajuda a explorar a API.
Ponto técnico 5
Idempotência: GET → comparar → POST/PATCH/PUT conforme endpoint → validar. Não crie devices repetidamente.
Ponto técnico 6
Ports: Use columns para limitar payload; a própria documentação recomenda não puxar todas as colunas.
Ponto técnico 7
Alert Rules: API permite consultar e gerenciar regras/templates; mudanças em massa precisam de dry-run e backup lógico.
Ponto técnico 8
Maintenance: Automatize janelas a partir de tickets/change, com escopo e duração explícitos.
Ponto técnico 9
Segurança: Token em secret manager, HTTPS, logs sem token e identidade dedicada.
Ponto técnico 10
Troubleshooting: 401/403 → token/usuário; 404 → versão/rota; payload inválido → endpoint; lentidão → filtro/columns/banco.
Procedimento de engenharia
Escopo e impacto
Defina serviço, owner, estado esperado e impacto antes de alterar o monitoramento.
Evidência primeiro
Valide fonte, caminho, credenciais, baseline e timestamps antes de alterar thresholds.
Mudança controlada
Altere uma variável por vez e mantenha um caminho de rollback.
Comandos / fluxo de referência
curl -H 'X-Auth-Token: \${LIBRENMS_TOKEN}' https://librenms.exemplo/api/v0
# API v1 beta
curl -H 'Authorization: Bearer \${LIBRENMS_V1_TOKEN}' https://librenms.exemplo/api/v1/healthRotina operacional recomendada
- Revise estados críticos, lacunas de coleta e falhas de entrega a cada turno.
- Revise alertas ruidosos, objetos lentos, credenciais e erros recorrentes semanalmente.
- Revise versões, backup/restore, permissões e capacidade periodicamente.
Sintoma → escopo → camada → evidência → hipótese → validação
Construa, quebre, diagnostique e recupere
- Registre um baseline saudável.
- Induza uma falha controlada relacionada ao tema.
- Identifique a camada com falha antes de reiniciar componentes.
- Corrija a causa identificada e valide a recuperação.
Pronto para produção?
Responsabilidade
Objetivo, escopo e owner estão definidos.
Segurança
Credenciais e integrações seguem menor privilégio.
Validação
Falha e recuperação foram testadas e documentadas.
Documentação sensível à versão
LibreNMS é rolling release. O conteúdo foi confrontado com a documentação oficial atual; instalação, Dispatcher, API, distributed polling, RRDCached, Redis, HA e requisitos devem ser reconfirmados antes de change.