Health Checking

Check if the Tyk Gateway is ready to serve requests.

Changed on

The /ready endpoint is used for readiness checks and can be renamed using the readiness_check_endpoint_name configuration option.

get/ready

Request

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

Response

Success.

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

Changes