Tyk

Tyk Health API

The Health API from Tyk — 1 operation(s) for health.

OpenAPI Specification

tyk-health-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions Health 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:
- name: Health
paths:
  /health:
    get:
      summary: Tyk Health Check
      description: Returns OK if the service is up and running.
      operationId: healthGet
      responses:
        '200':
          description: Service is up and running.
          content:
            text/plain:
              schema:
                type: string
                example: OK
      tags:
      - Health
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Admin-Auth