Skip to content

Health Check

Check the API health status. No authentication required.

GET /api/v1/health

Request

No headers or body required.

bash
curl https://shotprose.com/api/v1/health

Response

json
{
  "status": "ok",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "version": "1"
}
FieldTypeDescription
statusstringAlways ok when the API is operational
timestampstringCurrent server time (ISO 8601)
versionstringAPI version

Use Cases

  • Uptime monitoring
  • Load balancer health checks
  • Pre-flight checks before batch operations

Shotprose API Documentation