Skip to main content
GET
/
readiness
Check system readiness status
curl --request GET \
  --url https://{tenant}/readiness \
  --header 'X-Tyk-Authorization: <api-key>'
{
  "status": "pass",
  "status_code": 200,
  "components": [
    {
      "name": "postgres",
      "status": "pass",
      "observation_ts": "2024-07-29T13:58:56.699052-04:00"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Tyk-Authorization
string
header
required

Response

System is ready. All critical components are operational and the system is capable of handling requests.

​
status
string
Example:

"pass"

​
status_code
integer
Example:

200

​
components
object[]