openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions Hot Reload 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: 'Force restart of the Gateway or whole cluster.

    '
  name: Hot Reload
paths:
  /tyk/reload:
    get:
      description: Tyk is capable of reloading configurations without having to stop serving requests. This means that API configurations can be added at runtime, or even modified at runtime and those rules applied immediately without any downtime.
      operationId: hotReload
      parameters:
      - description: Block a response until the reload is performed. This can be useful in scripting environments like CI/CD workflows.
        example: false
        in: query
        name: block
        required: false
        schema:
          enum:
          - true
          - false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              example:
                message: ''
                status: ok
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Reload gateway.
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
      summary: Tyk Hot-reload a Single Node.
      tags:
      - Hot Reload
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /tyk/reload/group:
    get:
      description: To reload a whole group of Tyk nodes (without using the Dashboard or host manager). You can send an API request to a single node, this node will then send a notification through the pub/sub infrastructure to all other listening nodes (including the host manager if it is being used to manage Nginx) which will then trigger a global reload.
      operationId: hotReloadGroup
      responses:
        '200':
          content:
            application/json:
              example:
                message: ''
                status: ok
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Reload the Tyk Gateway.
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
      summary: Hot-reload a Group of Tyk Nodes.
      tags:
      - Hot Reload
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Admin-Auth