Health Check Endpoint¶

The following URI endpoint can be used for the health check of Connection Manager and Security Gateway:

/health

You can use the curl command to verify the health check status and run it on a console. The following command is an example of using the curl command:

curl -k https://cmsg-machine.local:443/health

If the command is successful, you will see the following response:
```
{"code":200,"status":"success"}
```

If the command fails, you will see the following response:

{"code":500,"status":"Error","reason":"Cannot communicate with broker"}

The following table outlines the list of possible errors and the associated status codes for the /health endpoint:

Status Code	Status	Example	Issue
200	success	{"code":200,"status":"success"}	N/A
500	error	{"code":500,"status":"Error","reason":"Cannot communicate with broker"}	Failure to communicate to Broker.
500	error	{"code":500,"status":"Error","reason":"Security Gateway is enabled but does not respond"}	Failure to communicate to Security Gateway.
500	error	{"code":500,"status":"Error","reason":"[error-related-for-configuration]"}	Misconfiguration of the Connection Manager.