GET
/
api
/
v1
/
health
Check Healthy
curl --request GET \
  --url https://prv.explorer.biya.io/api/v1/health \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "service": "<string>",
  "timestamp": "<string>",
  "details": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
service
string

Optional: service name to check

Response

200 - application/json

OK

CheckHealthyResponse contains the health status of the service

​
status
string

Health status: "healthy", "degraded", "unhealthy"

​
service
string

Service name

​
timestamp
string

Timestamp of the health check

​
details
object

Health details for each component (database, redis, etc.)