Tyk Dataplanes API

openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions Dataplanes 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: Dataplanes
paths:
  /dataplanes:
    get:
      summary: Tyk Retrieve Information of All the Connected Data Plane Nodes.
      description: Provides a list of all the data plane nodes connected to MDCB. Data plane nodes are Tyk Gateways that make your APIs available to your consumers. MDCB offers centralised management of your data plane nodes. This endpoint offers metadata and status for all connected data plane nodes, allowing for monitoring and troubleshooting.
      operationId: dataplanesGet
      parameters:
      - in: header
        name: x-tyk-authorization
        description: Secret value set in sink.conf
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of the connected data planes.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/Node'
        '401':
          description: Forbidden access due to invalid or missing administrative key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Dataplanes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Health:
      type: object
      properties:
        redis:
          $ref: '#/components/schemas/ComponentStatus'
        rpc:
          $ref: '#/components/schemas/ComponentStatus'
    Stats:
      type: object
      properties:
        apis_count:
          type: integer
          example: 1
        policies_count:
          type: integer
          example: 0
    ComponentStatus:
      type: object
      properties:
        status:
          type: string
          example: pass
        componentType:
          type: string
          example: datastore
        time:
          type: string
          format: date-time
          example: '2024-02-23T08:51:23-03:00'
    Error:
      type: object
      properties:
        error:
          type: string
          example: Attempted administrative access with invalid or missing key!
    HostDetails:
      type: object
      properties:
        Hostname:
          type: string
          example: Peter-MacBook-Pro.local
        PID:
          type: integer
          example: 62663
        Address:
          type: string
          example: 203.0.113.0
    Node:
      type: object
      properties:
        node_id:
          type: string
          example: solo-uid
        api_key:
          type: string
          example: c5e9b9ed8dee42fb668f81cef7f905bb
        group_id:
          type: string
          example: Redis Cluster Slave 1
        node_version:
          type: string
          example: v5.3.0-dev
        ttl:
          type: integer
          example: 10
        tags:
          type: array
          items:
            type: string
          example:
          - tag1
          - tag2
        health:
          $ref: '#/components/schemas/Health'
        stats:
          $ref: '#/components/schemas/Stats'
        host_details:
          $ref: '#/components/schemas/HostDetails'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Admin-Auth