openapi: 3.1.0
info:
  title: Nutanix Prism Central API v3 Alerts API
  description: RESTful API for managing Nutanix clusters, VMs, storage, networking, and other infrastructure components through Prism Central. The v3 API uses an intent-based model where resources are defined by their desired state, and the system works to achieve that state. All list operations use POST with server-side filtering, grouping, and sorting. Authentication is via HTTP Basic Auth with Prism Central credentials.
  version: 3.1.0
  contact:
    name: Nutanix Developer Support
    email: developer@nutanix.com
    url: https://www.nutanix.dev/
  termsOfService: https://www.nutanix.com/legal/terms-of-use
servers:
- url: https://{prismCentralIp}:9440/api/nutanix/v3
  description: Prism Central Server
  variables:
    prismCentralIp:
      default: localhost
      description: IP address or FQDN of the Prism Central instance.
security:
- basicAuth: []
tags:
- name: Alerts
  description: Retrieve and manage cluster alerts for monitoring health and operational events.
paths:
  /alerts:
    get:
      operationId: listAlerts
      summary: Nutanix List alerts
      description: Retrieves a list of alerts generated by the cluster for health monitoring and operational events.
      tags:
      - Alerts
      parameters:
      - name: resolved
        in: query
        description: Filter by resolved status.
        schema:
          type: boolean
      - name: severity
        in: query
        description: Filter by alert severity.
        schema:
          type: string
          enum:
          - CRITICAL
          - WARNING
          - INFO
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
  /alerts/{id}:
    get:
      operationId: getAlert
      summary: Nutanix Get an alert
      description: Retrieves details about a specific alert by its ID.
      tags:
      - Alerts
      parameters:
      - $ref: '#/components/parameters/EntityId'
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '404':
          description: Alert not found
components:
  parameters:
    EntityId:
      name: id
      in: path
      required: true
      description: The ID of the entity.
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Prism Central username and password credentials.
externalDocs:
  description: Nutanix Prism Central v3 API Documentation
  url: https://www.nutanix.dev/api_references/prism-central-v3/