Visão geral endpoints API

5 min de leitura · API e integrações

Referência de todos os endpoints API disponíveis. Base URL: https://epulz.io/api/v1

Autorização: Authorization: Bearer plz_.... Rate limit 60 requisições por minuto por token. Gere um token em Configurações -> Tokens API.

Status / auth check

GET /status - verifica o token, retorna email, plano, número de monitores e incidentes abertos

Monitors

GET /monitors - lista todos os seus monitores (incluindo uptime 24h) GET /monitors/{id} - detalhe de um monitor POST /monitors - criar novo monitor (JSON: name, type, target, interval_minutes, expected_status, expected_keyword) POST /monitors/bulk - importação em massa (máx 200 monitores por requisição) DELETE /monitors/{id} - apagar monitor (incluindo histórico de checks e incidentes)

Checks (histórico)

GET /monitors/{id}/checks?limit=100 - últimas N verificações (status, response time, status code, error, region). Limite 1-500, default 50.

Incidents

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

Códigos de erro

401 - token ausente ou inválido
403 - limite de monitores do plano excedido (na criação)
404 - o monitor não pertence a você ou não existe
429 - rate limit excedido (60 req/min)

Spec OpenAPI completa

Especificação legível por máquina em /api/openapi.json e docs interativos (Swagger UI) em /api/docs. Ambos requerem login / token.