Skip to main content
GET
/
api
/
integration
/
health
curl https://api.musique.app/api/integration/health \
  -H "X-API-Key: msk_live_1234567890abcdef"

{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2024-01-20T15:30:45Z",
  "services": {
    "database": "healthy",
    "storage": "healthy",
    "messaging": "healthy"
  }
}
Verify that the API is operational and responding correctly.
Use this endpoint for:
  • Uptime monitoring: Poll every 60 seconds to track availability
  • Pre-flight checks: Verify API is operational before critical operations
  • Incident response: Diagnose issues by checking service component status

​
Request

​
Headers

​
X-API-Key
string
required
Your API authentication token

​
Response

​
status
string
Overall API health status: healthy, degraded, or down
​
version
string
Current API version
​
timestamp
string
ISO 8601 timestamp of health check
​
services
object
Status of individual service components
curl https://api.musique.app/api/integration/health \
  -H "X-API-Key: msk_live_1234567890abcdef"

{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2024-01-20T15:30:45Z",
  "services": {
    "database": "healthy",
    "storage": "healthy",
    "messaging": "healthy"
  }
}

​
Status Values

StatusDescription
healthyAll systems operational
degradedSome systems experiencing issues, but API is functional
downCritical systems offline, API unavailable

​
Service Components

ServiceDescription
databasePrimary database connectivity
storageAudio file storage (CDN)
messagingDevice message delivery system