System
Health checks, readiness, and operational endpoints.
GET /v1/health#
Liveness check. Always returns 200 if the API process is running — doesn't inspect dependencies.
1 | |
Response:
1 2 3 4 | |
No authentication. Use for load balancer health checks.
GET /v1/health/ready#
Readiness check. 200 only if ScaiVault can serve traffic (DB, Redis, encryption all OK).
Response (200 OK):
1 2 3 4 5 6 7 8 | |
Response (503):
1 2 3 4 5 6 7 8 9 | |
No authentication. Use for Kubernetes readiness probes.
GET /v1/health/detailed#
Full component status with latencies and resource stats.
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | |
Scope: admin.
GET /v1/metrics#
Prometheus-format metrics. Served on the main port or a separate metrics port depending on deployment config.
Metrics include request counts/latencies per endpoint class, active leases, cache hit rates, rotation queue depth, KMS call counts.
Authentication: configurable. By default, unauthenticated on internal-only port.
GET /v1/version#
Returns version info. No auth.
1 2 3 4 5 6 | |