Health Check
Check the health status of the Shinzo Platform API. These endpoints do not require authentication and can be used to verify connectivity.Basic Health Check
Fast health check endpoint with cached database status.Endpoint
Authentication
No authentication required.Example Request
Response
Status Codes
Deep Health Check
Comprehensive health check that queries the database and reports latency metrics.Endpoint
Authentication
No authentication required.Example Request
Response
Response Fields
Status Codes
Use Cases
- Load balancer health checks: Use
/healthfor fast checks - Monitoring and alerting: Use
/health/deepfor detailed status - Connectivity verification: Use either endpoint to verify API reachability