Check the health of the Tyk Gateway.

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

GET /hello

Try it

Check the health of the Tyk Gateway.

cURL

curl --request GET \
  --url https://{tenant}/hello \
  --header 'X-Tyk-Authorization: <api-key>'

200

{
  "description": "<string>",
  "details": {},
  "output": "<string>",
  "status": "pass",
  "version": "<string>"
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Response

200

application/json

Success.

description · string

details · object

Show child attributes

details. {key} · object

Show child attributes

details.{key}. componentId · string

details.{key}. componentType · string

details.{key}. output · string

details.{key}. status · enum<string>

Available options: pass, fail, warn

details.{key}. time · string

output · string

status · enum<string>

Available options: pass, fail, warn

version · string