Overview
Health check API is useful for checking the health status of the whole system or particular products (for example: VE, CPaaS, VRx, CTR, HIDM, Payment, Notification, and Deployment).
Features
The Health Check API exposes the GET /healthCheck endpoint, which enables the API client to check API health status, including the overall system or services that use the specific backend product, and the GET /healthCheck/solutionVersion endpoint, which retrieves the current solution version information from the mounted core tag file.
- The product request parameter enables limiting the request to the services belonging to a particular product (for example, VE, CPaaS, VRx, CTR, HIDM, Payment, Notification, Deployment).
- The list of products and the corresponding services is defined in the configuration.
Use Case 1: Sample response for healthy state
Sample response for CTR https://{{host}}/healthcheck/api/v1/healthCheck?product=CTR.
All services are in a healthy state:
{
"status": "Healthy",
"totalDuration": "00:00:01.872126",
"moreDetails": [
{
"service": "https://sampleurl.com/input/hc",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0000030",
"entries": {}
}
},
{
"service": "https://sampleurl.com/output/hc",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0000422",
"entries": {}
}
},
{
"service": "https://sampleurl.com/export/hc",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0000040",
"entries": {}
}
},
{
"service": "https://sampleurl.com/events/hc",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0000030",
"entries": {}
}
},
{
"service": "https://sampleurl.com/reporting/hc",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0000028",
"entries": {}
}
}
]
}Use Case 2: Sample response for unhealthy state
Sample response for Vynamic Engage https://{{host}}/healthcheck/api/v1/healthCheck?product=VE.
One service is unavailable:
{
"status": "Unhealthy",
"totalDuration": "00:00:00.631233",
"moreDetails": [
{
"service": "http://rabbitmq:123/",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0012200",
"results": []
}
},
{
"service": "https://sampleurl.com/loyaltyprogram/health",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0740760",
"results": [
{
"Component": "LivenessHealthCheck",
"Description": null,
"Status": "Healthy"
}
]
}
},
{
"service": "https://sampleurl.com/ccvm/health",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.1775858",
"results": [
{
"Component": "LivenessHealthCheck",
"Description": null,
"Status": "Healthy"
}
]
}
},
{
"service": "https://sampleurl.com/customeraccount/health",
"response": {
"backendStatus": "<html>\r\n<head><title>503 Service Temporarily Unavailable</title></head>\r\n<body>\r\n<center><h1>503 Service Temporarily Unavailable</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n",
"status": "Unhealthy"
}
},
{
"service": "https://sampleurl.com/customermanagement/health",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.0597122",
"results": [
{
"Component": "LivenessHealthCheck",
"Description": null,
"Status": "Healthy"
}
]
}
},
{
"service": "https://sampleurl.com/segmentation/health",
"response": {
"status": "Healthy",
"totalDuration": "00:00:00.1446737",
"results": [
{
"Component": "LivenessHealthCheck",
"Description": null,
"Status": "Healthy"
}
]
}
}
]
}Security
The Health Check API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Health Check API is HTTPS.