Device42 Health Status API

openapi: 3.2.0
info:
  title: Device42 Health Status API
  version: '2.0'
  description: 'API Overview


    RESTful APIs are supported in Device42 as one of the primary methods of entering, editing and retrieving data.'
  contact:
    name: Device42
    email: support@device42.com
servers:
- url: https://<host>
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Health Status
paths:
  /healthstats/:
    servers:
    - url: https://<host>:4343
    get:
      operationId: getHealthstats
      security: []
      description: 'Note: This endpoint does not require authentication.


        This will return the health status of Device42 including:

        - current version number

        - current used CPU percentage

        - current database size

        - current disk space used

        - current memory usage

        - the status of each remote collector including version number and state

        - the status of recent backups

        - the status of system packages and runtime environements (if requesting full stats)

        - the status of last upgrade (if requesting full stats)


        Note - backup status response can also include:

        - Please save backup destination settings first\ @ 2020-12-05 09:26:43

        - Backup not run since last reboot. Please check.'
      summary: Get
      tags:
      - Health Status
      parameters:
      - name: full
        required: false
        description: Check full set of health stats on appliance? yes/no.  Additional information includes system package status and last upgrade status in form of OK/NOK.  Additional statuses are static and do not change between upgrades.
        in: query
        schema:
          type: string
          enum:
          - 'yes'
          - 'no'
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthstat_status'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  responses:
    NotFound:
      description: Not Found (The specified resource could not be found)
      content:
        application/json:
          example:
            errors:
            - code: 404
              reason: Not Found
              title: Not Found
              detail: The specified resource could not be found.
    InternalServerError:
      description: Internal Server Error (A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.)
      content:
        application/json:
          example:
            errors:
            - code: 500
              reason: Internal Server Error
              title: Internal Server Error
              detail: A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.
    ServiceUnavailable:
      description: Service Unavailable (Please check if your Device42 instance is working normally.)
      content:
        application/json:
          example:
            errors:
            - code: 503
              reason: Service Unavailable
              title: Service Unavailable
              detail: Please check if your Device42 instance is working normally.
  schemas:
    healthstat_status:
      type: object
      properties:
        version:
          example: 18.10.00.1690226275
        backup_status:
          type: array
          items:
            type: object
            properties:
              id:
                example: 1
              job_name:
                example: Demo Backup
              status:
                example: Good @  2019-01-10 18:51:31
        cpu_used_percent:
          example: '2.51904'
        dbsize:
          example: 84 MB
        disk_used_percent:
          example: '8'
        memory_in_MB:
          type: object
          properties:
            buffers:
              example: 92
            cached:
              example: 254
            memfree:
              example: 1728
            memtotal:
              example: 3948
            swapfree:
              example: 8187
            swaptotal:
              example: 8187
        rc_stats:
          type: array
          items:
            type: object
            properties:
              rc_name:
                example: DC1-RC
              state:
                example: disconnected
              version:
                example: 18.10.00-1690226275
        nvenv:
          type: object
          properties:
            core-app:
              example: OK
            app_mgr:
              example: NOK
            superset:
              example: OK
            rc_python:
              example: OK
        system_pkg:
          type: object
          properties:
            status:
              example: OK
        last_upgrade:
          type: object
          properties:
            status:
              example: NOK
            from_version:
              example: 18.08.00.1686665414
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication using a Device42 user's username and password.
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /tauth/1.0/token/ using an API Client's key/secret as Basic auth credentials.