Health Checking

Check the health of the Tyk Gateway.

Changed on

From v2.7.5 you can now rename the /hello endpoint by using the health_check_endpoint_name option.

get/hello

Request

  • Base URL
    https://localhost:8080
  • URL
    https://localhost:8080/hello
  • Auth
    API key in header X-Tyk-Authorization

Response

Success.

descriptionstring
detailsobject
outputstring
status'pass' | 'fail' | 'warn'
versionstring

Changes