Health & Info#
Endpoints públicos que não requerem autenticação, úteis para monitoramento e descoberta de capacidades.
Health check — GET /health#
Autenticação: Não requerida (endpoint público).
Resposta 200:
{ "status": "ok" }
Use para probes de liveness/readiness em orquestradores como Kubernetes, Docker Compose ou plataformas como Render, Railway, etc.
# docker-compose.yml
services:
sulfite:
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
interval: 30s
timeout: 5s
retries: 3
Informações — GET /info#
Autenticação: Não requerida (endpoint público).
Retorna as capacidades do servidor:
Resposta 200:
{
"version": "0.1.0",
"formats": ["pdf", "html", "csv", "excel"],
"drivers": ["rest", "postgres", "postgrest", "sqlite3"],
"package_support": true
}
| Campo | Descrição |
|---|---|
version | Versão do sulfite_server |
formats | Formatos de renderização suportados |
drivers | Drivers de datasource disponíveis |
package_support | Suporte a pacotes .sulfite |
Auditoria de segurança — GET /api/v1/health/security#
Permissão: canSettings
Retorna o status das proteções de segurança configuradas:
{
"auth": true,
"rateLimit": true,
"ssrfGuard": true,
"encryption": true,
"corsOrigins": ["https://app.example.com"],
"corsWildcard": false
}
| Campo | Descrição |
|---|---|
auth | Autenticação habilitada (AUTH_SECRET configurado) |
rateLimit | Rate limiting ativo |
ssrfGuard | Proteção SSRF ativa (ALLOWED_HOSTS configurado) |
encryption |
Criptografia de conexões ativa (ENCRYPTION_KEY configurado) |
corsOrigins | Lista de origens CORS permitidas |
corsWildcard | Se CORS está em modo wildcard (*) |
Este endpoint é útil para verificar automaticamente se o servidor de produção está corretamente configurado. Veja o checklist de produção.