Vertica Health API

openapi: 3.1.0
info:
  title: Vertica Node Management Agent (NMA) Health API
  version: '1'
  description: 'The Vertica Node Management Agent (NMA) exposes a REST API for

    programmatic cluster and database operations. The agent listens on

    port 5554 and runs on every node in the cluster. Authentication uses

    mutual TLS with client certificates generated during the Vertica

    installation process.

    '
  contact:
    name: Vertica NMA Documentation
    url: https://docs.vertica.com/latest/en/admin/managing-db/node-management-agent/
servers:
- url: https://{node}:5554
  description: NMA endpoint on a Vertica node
  variables:
    node:
      default: localhost
security:
- mtls: []
tags:
- name: Health
paths:
  /v1/health:
    get:
      tags:
      - Health
      summary: Health check
      operationId: getHealth
      responses:
        '200':
          description: NMA is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  healthy:
                    type: string
                    example: 'true'
components:
  securitySchemes:
    mtls:
      type: mutualTLS
      description: Mutual TLS using NMA client/server certificates