Skip to content

API Health Check

GET
/api/v1/status

Check API health status and dependent services

API status

object
success
required
boolean
data
required
object
status
required

Overall API health status

string
Allowed values: healthy degraded unhealthy
Example
healthy
version
required

API version

string
Example
1.0.0
environment
required

Current environment

string
Allowed values: development staging production
Example
production
uptime
required

API uptime in seconds

number
Example
86400
services
required

Status of dependent services

Array<object>
object
name
required

Service name

string
Example
database
status
required

Service health status

string
Allowed values: healthy degraded unhealthy
Example
healthy
latency

Response latency in milliseconds

number
Example
15
message

Status message

string
Example
Connected
lastChecked
required

Last health check timestamp

string format: date-time
Example
2024-01-15T10:30:00Z
meta
required
object
timestamp
required

Timestamp in ISO 8601 format

string format: date-time
Example
2024-01-15T10:30:00Z
requestId

Request tracking ID

string