Weka Health API

openapi: 3.0.3
info:
  title: '@weka-api Active Directory Health API'
  version: '5.1'
  description: "\n<div>\n  The WEKA system provides a RESTful API, enabling efficient\n  automation and integration into existing workflows or monitoring systems. To access\n  the REST API documentation within the cluster, navigate to <code>/api/v2/docs</code>\n  on port 14000 (e.g.,\n  <code>https://weka01:14000/api/v2/docs</code>).\n  <br>\n  <br>\n  For detailed guidance on using the REST API, including CLI command equivalents and related concepts, refer to the official\n  documentation:\n  <a href=\"https://docs.weka.io/getting-started-with-weka/getting-started-with-weka-rest-api\">Getting Started with the WEKA REST API</a>.\n  <br>\n  <br>\n  <div style=\"margin-top: 15px;\">\n    <b>Important:</b>\n    WEKA uses 64-bit numbers, which requires careful handling when interacting with the API across different programming languages.\n    In JavaScript, for instance, the\n    <code>\"json-bigint\"</code>\n    library is recommended.\n  </div>\n</div>"
servers:
- url: /api/v2
security:
- bearerAuth: []
tags:
- name: Health
paths:
  /healthcheck:
    get:
      tags:
      - Health
      summary: Check REST API status
      description: Verifies the availability of the REST API.
      operationId: getApiHealth
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                example: ok
  /ui/healthcheck:
    get:
      tags:
      - Health
      summary: Check GUI status
      description: Verifies the availability of the GUI.
      operationId: getUIHealth
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                example: ok
        '503':
          description: Error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT