Integre monitoramento de uptime diretamente nos seus sistemas. Autenticada por API keys, com rate limiting por plano e respostas JSON consistentes.
https://api.thealert.io/api/v1A API pública do TheAlert permite gerenciar monitores, consultar histórico de checks e listar status pages programaticamente. É ideal para automatizar onboarding, integrar CI/CD, ou construir dashboards customizados.
API Keys com prefixo ta_ geradas no dashboard
Todos os endpoints retornam application/json
Limites por plano, com headers X-RateLimit-*
Todas as rotas da API pública requerem uma API key válida. As keys são geradas em Dashboard → Integrações → API Keys. Cada key é exibida uma única vez — guarde em segurança.
Opção 1 — Authorization Header (recomendado)
Authorization: Bearer ta_a1b2c3d4e5f6...Opção 2 — X-API-Key Header
X-API-Key: ta_a1b2c3d4e5f6...Mantenha sua key segura
Nunca exponha API keys em código front-end ou repositórios públicos. Use variáveis de ambiente. Se suspeitar de vazamento, revogue e gere uma nova key imediatamente.
https://api.thealert.io/api/v1Todos os endpoints são relativos a esta base URL. Versões futuras utilizarão /api/v2, garantindo compatibilidade retroativa da v1.
Os limites são por API key, usando janela deslizante de 1 hora. Cada resposta inclui headers para acompanhar o consumo:
X-RateLimit-Limit: 1000 # total permitido na janela
X-RateLimit-Remaining: 847 # restantes nesta janela
X-RateLimit-Reset: 1741699200 # timestamp unix do reset| Plano | Req / hora | Req / dia (est.) | API pública |
|---|---|---|---|
| FREE | — | — | ✗ |
| STARTER | 100 | ~2.400 | ✓ |
| PRO | 1.000 | ~24.000 | ✓ |
| BUSINESS | 10.000 | ~240.000 | ✓ |
Ao exceder o limite, a API retorna 429 Too Many Requests com resetInSeconds indicando quando a janela reinicia.
A API usa códigos HTTP convencionais. Respostas de erro sempre têm o campo error com descrição legível.
| Status | Significado | Causa comum |
|---|---|---|
200 | OK | Requisição bem-sucedida |
201 | Created | Recurso criado (POST) |
204 | No Content | Operação concluída sem body (DELETE) |
400 | Bad Request | Dados inválidos — veja o campo details |
401 | Unauthorized | API key ausente ou inválida |
403 | Forbidden | Plano não suporta API pública (FREE) |
404 | Not Found | Recurso não encontrado ou de outro usuário |
429 | Too Many Requests | Rate limit excedido para esta key |
500 | Server Error | Erro interno — entre em contato |
// Erro de validação (400)
{
"error": "Dados inválidos",
"details": {
"url": ["URL inválida"],
"interval": ["Intervalo mínimo para o plano STARTER é 30 segundos"]
}
}
// Rate limit excedido (429)
{
"error": "Rate limit excedido",
"limit": 100,
"remaining": 0,
"resetInSeconds": 1847
}CRUD completo de monitores. Todos os limites do plano são respeitados (número máximo, intervalo mínimo, features por tier).
Retorna os checks mais recentes do monitor em ordem decrescente. Útil para calcular uptime customizado, plotar gráficos ou detectar padrões de falha.
Lista as status pages do usuário proprietário da key. Combine com os checks dos monitores para automatizar atualizações de status.
Endpoint usado por monitores do tipo PUSH. O servidor ou cron job envia um POST periódico para confirmar que está vivo. Se o TheAlert não receber o ping dentro do intervalo configurado × 1.5, o monitor vira DOWN e dispara alertas. O token é gerado automaticamente ao criar um monitor PUSH — não é necessária API key.
Limites
404Sua key é exibida uma única vez. O servidor guarda apenas o hash — nunca o valor original. Se comprometida, revogue pelo dashboard e ela é invalidada imediatamente.
Recursos de outros usuários retornam 404, não 403 — impedindo enumeração de IDs. Nenhuma operação cross-user é possível via API pública.
Os campos headers (podem conter tokens), pushToken e sslCertInfo raw são removidos de todos os responses — independente do que estiver no banco.
Gere sua primeira API key no dashboard e integre em minutos.