Health Checks

API Health Checks

The CIMcloud API supports the following two health checks.  These are both GET requests.

Canary

Description: No authentication token needed, allows you to check the status of the API layer to determine if the API layer is down or running.

Endpoint: https://api.cimcloud.com/{sitename}/healthcheck/canary

Healthcheck

Description: Requires the Authentication Bearer Token to be passed.  Similar to the canary, but allows you to verify the token is still available.

Endpoint: https://api.cimcloud.com/{sitename}/healthcheck

Was this article helpful

Related Articles

Subscribe to receive email updates of what's new in the CIMcloud Help Center.