Skip to main content
GET
/
status
Get server status
curl --request GET \
  --url https://api.uk.veridox.ai/status
{
  "status": "ok",
  "version": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.veridox.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

  1. Caching: Cache the response briefly (30-60 seconds) for high-frequency health checks to reduce unnecessary load.
  2. Error Handling: Expect only network-level errors; treat any 5xx response as a critical service issue.

Response

200 - application/json

Server status

​
status
enum<string>
required
Available options:
ok
​
version
string
required