Get server status
System
Get Server Status
Check the current operational status of the Veridox API.
GET
Get server status
Returns the operational status of the Veridox Core API server and the current API version. This endpoint is publicly accessible and requires no authentication.
Use Cases
- Health Monitoring: Use this endpoint for automated uptime monitoring and alerting.
- Load Balancing: Ideal for health probes in load balancer configurations.
- Version Verification: Confirm the current API version for compatibility checks.
Best Practices
- Caching: Cache the response briefly (30-60 seconds) for high-frequency health checks to reduce unnecessary load.
- Error Handling: Expect only network-level errors; treat any 5xx response as a critical service issue.