Visão geral endpoints API

Visão geral de todos os endpoints da API disponíveis (os diferentes URLs da API REST que são chamados). URL base: https://epulz.io/api/v1

Autorização: envie o cabeçalho Authorization: Bearer epulzio_.... O limite de pedidos (rate limit) é de 60 pedidos por minuto por token. O token é gerado em Definições -> Tokens de API.

Estado / verificação do token

• GET /status - verifica o token, devolve o e-mail, o plano, o número de monitores e o número de incidentes abertos.

Monitores

• GET /monitors - lista de todos os seus monitores (incluindo a disponibilidade das últimas 24 h).
• GET /monitors/{id} - detalhe de um único monitor.
• POST /monitors - cria um novo monitor. No corpo do pedido (JSON) envie os campos name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - importação em massa (no máximo 200 monitores num único pedido).
• PATCH /monitors/{id} - edição de um monitor existente (envie apenas os campos que pretende alterar).
• POST /monitors/{id}/check - executa uma verificação imediata fora do intervalo agendado; devolve o monitor atualizado.
• GET /monitors/{id}/uptime?days=30 - disponibilidade em % nos últimos N dias (1-365, predefinido 30); as janelas de manutenção são excluídas.
• DELETE /monitors/{id} - elimina o monitor (juntamente com o histórico de verificações e incidentes).

Verificações (histórico)

• GET /monitors/{id}/checks?limit=100 - as últimas N verificações de um monitor (estado, tempo de resposta, HTTP status code, eventual erro, região). O parâmetro limit pode ser de 1 a 500, predefinido 50.

Incidentes

• GET /incidents - lista de incidentes. Filtros opcionais: monitor_id, resolved (true/false), limit (1-500, predefinido 50).

Códigos de erro

• 401 - token em falta ou inválido.
• 403 - limite de monitores do seu plano excedido (ao criar).
• 404 - o monitor não lhe pertence ou não existe.
• 429 - limite de pedidos excedido (60 por minuto por token).

Documentação legível por máquina

A especificação completa no padrão OpenAPI está disponível em /api/openapi.json. A documentação interativa, onde pode experimentar os endpoints diretamente (Swagger UI), encontra-se em /api/docs. Ambas exigem início de sessão ou um token válido.