Health Check

1min
GET
/developer/health
Returns the health status of the service along with upstream services. Useful for Kubernetes readiness probes.
Responses
200
HealthCheckResultDTO
status
string
*
info
object
*
All Of
HealthCheckInfoDTO  +
error
object
*
details
object
*
503
The Health Check is not successful
object
status
string
info
map<string, object>
error
map<string, object>
details
map<string, object>
Curl
JS
Ruby
Python
curl --location '/developer/health' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location '/developer/health' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
503
{
  "status": "ok",
  "info": {},
  "error": {},
  "details": {}
}
{
  "status": "ok",
  "info": {},
  "error": {},
  "details": {}
}
﻿
﻿
Updated 10 Oct 2024
Did this page help you?
Ping