Visão geral
A API de consulta permite acessar programaticamente os eventos, sensores e estatísticas da sua organização. Disponível nos planos Pro e Enterprise.
Base: https://honeypot.xlabs.com.br/api/v1/org
Autenticação: Authorization: Bearer xlabs_live_…
Documentação interativa: Swagger em /api/v1/org/docs · ReDoc em /api/v1/org/redoc.
Gerando chaves
- No portal, vá em Empresas → [sua empresa] → API Keys.
- Clique em Gerar chave.
- A chave aparece uma vez. Copie e armazene com segurança. Só o SHA-256 fica no banco.
Limites: Pro = 3 chaves, 120 req/min. Enterprise = 10 chaves, 300 req/min.
Endpoints principais
| Método | Path | Uso |
|---|---|---|
| GET | /me |
Empresa, plano, retenção |
| GET | /events |
Lista paginada (filtros: since, until, sensor, category, severity, ip) |
| GET | /events/stream |
Stream NDJSON — até N eventos numa conexão |
| GET | /events/{uuid} |
Detalhe HTTP completo (headers, corpo, raw_http) |
| GET | /sensors |
Sensores da empresa (IPs, bateria, status) |
| GET | /stats |
Totais (window=24h, 7d, 30d) |
Exemplo: listar eventos
curl -sS -H "Authorization: Bearer xlabs_live_…" \
"https://honeypot.xlabs.com.br/api/v1/org/events?limit=50"
Stream NDJSON
Uma linha = um evento. Com wire=1, inclui requisição HTTP completa.
curl -sS -N -H "Authorization: Bearer xlabs_live_…" \
"https://honeypot.xlabs.com.br/api/v1/org/events/stream?minutes=60&limit=500"
Telas do portal
Página Query API
Página Query API com links para Swagger / ReDoc / Manage API keys e a tabela de limites por plano.
Gerando chaves no portal
Formulário para gerar chaves (botão Create key com label) e lista de chaves ativas da empresa.