Tyk

Tyk Health Checking API

Check health status of the Tyk Gateway and loaded APIs.

GitHub OpenAPI

Documentation

📖
Documentation
https://tyk.io/docs/tyk-apis/
📖
Documentation
https://tyk.io/docs/tyk-dashboard-api
📖
Documentation
https://tyk.io/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/openapi/tyk-health-checking-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/TykTechnologies/tyk
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-analytics
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-sink

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-schema/tyk-gateway-access-definition-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-gateway-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/graphql/tyk-graphql.md
🔗
ChangeLog
https://tyk.io/docs/developer-support/release-notes/dashboard
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-mdcb-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tyk-health-checking-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tyk-health-checking-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions Health Checking API
  version: 5.3.0
  description: 'For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.


    In order to use the Dashboard Admin API, you''ll need to get the `admin_secret` value from your Tyk Dashboard configurations.


    The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:


    ```

    admin-auth: <your-secret>

    ```'
servers:
- url: http://localhost/
- url: https://localhost/
security:
- ApiKeyAuth: []
tags:
- description: 'Check health status of the Tyk Gateway and loaded APIs.

    '
  name: Health Checking
paths:
  /hello:
    get:
      description: From v2.7.5 you can now rename the `/hello`  endpoint by using the `health_check_endpoint_name` option.
      operationId: hello
      responses:
        '200':
          content:
            application/json:
              example:
                description: Tyk GW
                details:
                  redis:
                    componentType: datastore
                    status: pass
                    time: '2020-05-19T03:42:55+01:00'
                status: pass
                version: v5.5.0-dev
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
          description: Success.
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
        '405':
          content:
            application/json:
              example:
                message: Method Not Allowed
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Method Not Allowed
      summary: Check the Health of the Tyk Gateway.
      tags:
      - Health Checking
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    HealthCheckItem:
      properties:
        componentId:
          type: string
          example: '500123'
        componentType:
          type: string
          example: example_value
        output:
          type: string
          example: example_value
        status:
          enum:
          - pass
          - fail
          - warn
          type: string
          example: pass
        time:
          type: string
          example: example_value
      type: object
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      type: object
    HealthCheckResponse:
      properties:
        description:
          type: string
          example: A sample description.
        details:
          additionalProperties:
            $ref: '#/components/schemas/HealthCheckItem'
          type: object
          example: example_value
        output:
          type: string
          example: example_value
        status:
          enum:
          - pass
          - fail
          - warn
          type: string
          example: pass
        version:
          type: string
          example: example_value
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Admin-Auth