Fetch the health status of the Service Provider.
curl --request GET \
--url https://api.example.com/health \
--header 'Authorization: <api-key>'{
"status": "UP",
"version": "1.0.0",
"description": "The service is healthy.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "UP"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "UP"
}
],
"time": "2022-11-01T05:12:08.131Z"
}{
"message": "Unexpected error during processing the request."
}{
"status": "DOWN",
"version": "1.0.0",
"description": "The service is unhealthy. Several components are down.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database Memory Usage",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "DOWN"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "DOWN"
}
],
"time": "2022-11-01T05:12:08.131Z"
}Health
Fetch the health status of the Service Provider.
This endpoint is used to fetch the health status of the Service Provider.
GET
/
health
Fetch the health status of the Service Provider.
curl --request GET \
--url https://api.example.com/health \
--header 'Authorization: <api-key>'{
"status": "UP",
"version": "1.0.0",
"description": "The service is healthy.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "UP"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "UP"
}
],
"time": "2022-11-01T05:12:08.131Z"
}{
"message": "Unexpected error during processing the request."
}{
"status": "DOWN",
"version": "1.0.0",
"description": "The service is unhealthy. Several components are down.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database Memory Usage",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "DOWN"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "DOWN"
}
],
"time": "2022-11-01T05:12:08.131Z"
}Authorizations
Headers
Merchant's domain name will be sent by Chargebee
Unique id of the request will be sent by Chargebee
Response
Service is healthy.
The status of a specific component reported by the Service Adapter.
Available options:
UP, DOWN, WARN List of health status details for each component reported by the Service Adapter.
Show child attributes
Show child attributes
The timestamp of the health status reported by the Service Adapter.
Minimum string length:
1The description of the health status returned by the Service Adapter.
Maximum string length:
250