Health Check API
Use the healthcheck API to get the CT-VL status. This endpoint integrates with load balancers to ensure all the nodes are running and the tokenization server is healthy. Any HTTP response code other than 200 indicates a failure in CT-VL. The HTTP response provides the status of all services in JSON format.
Note
The healthcheck API runs in an unauthenticated mode.
healthcheck Endpoint Details
| Data | Description |
|---|---|
| HTTP Request | https://IP_Address/healthcheck |
| Method | GET |
| CT-VL IP Address | The IP address of the CT-VL machine to access with the API call. |
| Response Format | JSON |
healthcheck Response Parameters
| Data | Type | Description |
|---|---|---|
| status | string | • 200 (if request succeeded) • 503 (if one of the daemons is not running) |
| string | Configured services are listed along with their respective statuses (for example: {“name”: “vaed”, “status”: “started”}) |
healthcheck Example
Example Request
curl -k -X GET https://10.207.xxx.xxx/healthcheck
Example Response
{
"status": "Started","services": [
{
"name": "vtsauthz",
"status": "Started"
},
{
"name": "nginx",
"status": "Started"
},
{
"name": "cryptod",
"status": "Started"
},
{
"name": "haproxy",
"status": "Started"
},
{
"name": "iam",
"status": "Started"
},
{
"name": "kmd",
"status": "Started"
},
{
"name": "uwsgi-adminapi",
"status": "Started"
},
{
"name": "uwsgi-vts",
"status": "Started"
},
{
"name": "vaed",
"status": "Started"
},
{
"name": "vtsauthz",
"status": "Started"
},
{
"name": "postgresql",
"status": "Started"
}
]
}
