Skip to main content
GET
/
api
/
health
curl -X GET "https://app.usatimbre.com/api/health"

{
  "status": "ok",
  "timestamp": "2024-01-21T10:30:00Z",
  "version": "1.0.1"
}

​
Overview

Check the health status of the Timbre API. This endpoint does not require authentication and can be used to verify that the API is operational.
This is the only endpoint that does not require authentication.

​
Response

​
status
string
Health status. Returns ok when the API is operational.
​
timestamp
string
ISO 8601 timestamp of the health check
​
version
string
API version
curl -X GET "https://app.usatimbre.com/api/health"

{
  "status": "ok",
  "timestamp": "2024-01-21T10:30:00Z",
  "version": "1.0.1"
}

​
Use Cases

  • Monitoring: Use this endpoint for uptime monitoring and alerting
  • Load Balancer Health Checks: Configure load balancers to check API availability
  • Integration Testing: Verify API connectivity before running integration tests