Visão Geral da API
O Cronitorex expõe duas APIs, cada uma com sua própria chave de API:
| API | URL base | Prefixo da chave | Finalidade |
|---|---|---|---|
| Ingest API | https://api.cronitorex.com | ck_ | Receber eventos de monitoramento (pings) dos seus jobs e serviços |
| Management API | https://app.cronitorex.com/api/v1 | mk_ | Gerenciar monitores como documentos manifest: listar, obter, criar, atualizar |
Autenticação
Ambas as APIs autenticam com um token Bearer, mas cada uma usa sua própria chave:
Authorization: Bearer <api_key>- A chave da Ingest API (
ck_...) autentica apenas pings. - A chave da Management API (
mk_...) autentica apenas/api/v1.
Gere ambas as chaves no painel em Configurações → API key. A Ingest API aceita adicionalmente um parâmetro de query ?api_key= para pings GET pontuais (veja GET /ping).
Tipo de conteúdo
Todos os corpos de requisição devem ser application/json. Todas as respostas são application/json.
Limites de taxa
Cada API tem seu próprio limite:
| API | Limite | Ao exceder |
|---|---|---|
| Ingest API | 10 requisições/segundo, burst de 20 | 429 Too Many Requests |
| Management API | 60 requisições/minuto por chave de API | 429 + headers X-RateLimit-Limit / X-RateLimit-Remaining |
Endpoints
Ingest API
| Método | Caminho | Descrição |
|---|---|---|
POST | /ping | Envie um evento de monitoramento, veja POST /ping |
GET | /ping/{monitor} | Envie um evento via parâmetros de query, veja GET /ping |
GET | /health | Checagem de saúde da API (não requer autenticação) |
Vocabulário de status e tipos de evento: Tipos e Estados de Evento.
Management API
| Método | Caminho | Descrição |
|---|---|---|
GET | /api/v1/monitors | Lista manifests de monitores (filtre com ?kind=) |
GET | /api/v1/monitors/{uuid} | Obtém um único monitor |
POST | /api/v1/monitors | Cria um monitor a partir de um manifest |
PUT | /api/v1/monitors/{uuid} | Atualiza um monitor (manifest completo) |
DELETE | /api/v1/monitors/{uuid} | Não suportado, retorna 403; a exclusão é feita somente pelo painel, por design |
Referência completa com o formato do manifest: Management API.
Ferramentas interativas
- Swagger UI, teste ambas as APIs no navegador
- Coleção Postman, requisições prontas para todos os endpoints