Skip to main content

Health Check

Health Check page

The admin area "Health Check" page shows you the the status of the services used by your GitGuardian to function. In case one of those services is somehow unreachable they will be indicated as failing.

The feature also comes with a public REST endpoint. It is protected using the API keys mechanism since this will be typically exposed outside of your network. The URL of that endpoint is displayed on the admin page.

It is easy to use the endpoint, for instance using curl (XXXX should be replaced with your API key):

curl -H "Authorization: Token XXXX" https://gitguardian.mynetwork.com/exposed/v1/readiness