Nutanix Clusters API

openapi: 3.2.0
info:
  title: Nutanix Clusters API
  contact:
    name: Nutanix Developer Support
    email: developer@nutanix.com
    url: https://www.nutanix.dev/
  termsOfService: https://www.nutanix.com/legal/terms-of-use
  version: '1.0'
  description: 'Operations tagged Clusters across 2 of this provider''s published API definitions: nutanix-prism-central-v3-openapi.yml, nutanix-prism-element-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
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.
- url: https://{clusterIp}:9440/PrismGateway/services/rest/v2.0
  description: Prism Element Server
  variables:
    clusterIp:
      default: localhost
      description: IP address or FQDN of the Nutanix cluster or CVM.
security:
- basicAuth: []
tags:
- name: Clusters
  description: Retrieve and manage Nutanix cluster configurations and metadata across the Prism Central deployment.
paths:
  /clusters/list:
    post:
      operationId: listClusters
      summary: Nutanix List clusters
      description: Retrieves a list of clusters managed by Prism Central with optional filtering and pagination.
      tags:
      - Clusters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMetadata'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterListResponse'
        '401':
          description: Unauthorized
    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.
  /clusters/{uuid}:
    get:
      operationId: getCluster
      summary: Nutanix Get a cluster
      description: Retrieves the configuration and status of a specific cluster by UUID.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/Uuid'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterIntentResponse'
        '401':
          description: Unauthorized
        '404':
          description: Cluster not found
    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.
  /cluster:
    get:
      operationId: getCluster
      summary: Nutanix Get cluster information
      description: Retrieves detailed information about the local Nutanix cluster including configuration, health status, and resource utilization.
      tags:
      - Clusters
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '401':
          description: Unauthorized
    servers:
    - url: https://{clusterIp}:9440/PrismGateway/services/rest/v2.0
      description: Prism Element Server
      variables:
        clusterIp:
          default: localhost
          description: IP address or FQDN of the Nutanix cluster or CVM.
components:
  schemas:
    ListMetadata:
      type: object
      description: Request body for list operations supporting server-side filtering, sorting, and pagination.
      properties:
        kind:
          type: string
          description: The entity kind to list.
        offset:
          type: integer
          description: Offset from the start of the entity list.
          minimum: 0
        length:
          type: integer
          description: The number of records to retrieve.
          minimum: 1
          maximum: 500
        filter:
          type: string
          description: The filter criteria in FIQL format.
        sort_order:
          type: string
          description: The sort order.
          enum:
          - ASCENDING
          - DESCENDING
        sort_attribute:
          type: string
          description: The attribute to sort results by.
    ClusterListResponse:
      type: object
      description: Response for listing clusters.
      properties:
        api_version:
          type: string
        metadata:
          $ref: '#/components/schemas/ListMetadata'
        entities:
          type: array
          items:
            $ref: '#/components/schemas/ClusterIntentResponse'
    Reference:
      type: object
      description: A reference to another entity.
      required:
      - kind
      - uuid
      properties:
        kind:
          type: string
          description: The kind of entity being referenced.
        uuid:
          type: string
          format: uuid
          description: The UUID of the referenced entity.
        name:
          type: string
          description: The name of the referenced entity.
    EntityMetadata:
      type: object
      description: Metadata for an entity.
      properties:
        kind:
          type: string
          description: The kind of entity.
        uuid:
          type: string
          format: uuid
          description: The UUID of the entity.
        spec_version:
          type: integer
          description: Version number of the spec.
        categories:
          type: object
          additionalProperties:
            type: string
          description: Categories assigned to the entity as key-value pairs.
        owner_reference:
          $ref: '#/components/schemas/Reference'
        project_reference:
          $ref: '#/components/schemas/Reference'
    ClusterIntentResponse:
      type: object
      description: Response containing cluster intent status and spec.
      properties:
        status:
          type: object
          description: The current status of the cluster.
        spec:
          type: object
          description: The cluster specification.
        metadata:
          $ref: '#/components/schemas/EntityMetadata'
    Cluster:
      type: object
      description: Nutanix cluster information.
      properties:
        id:
          type: string
          description: The unique identifier of the cluster.
        uuid:
          type: string
          description: The UUID of the cluster.
        name:
          type: string
          description: The name of the cluster.
        cluster_external_ipaddress:
          type: string
          description: External IP address of the cluster.
        num_nodes:
          type: integer
          description: Number of nodes in the cluster.
        version:
          type: string
          description: AOS version running on the cluster.
        hypervisor_types:
          type: array
          items:
            type: string
          description: Hypervisor types in the cluster.
  parameters:
    Uuid:
      name: uuid
      in: path
      required: true
      description: The UUID of the entity.
      schema:
        type: string
        format: uuid
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Prism Central username and password credentials.
x-refined-from:
- nutanix-prism-central-v3-openapi.yml
- nutanix-prism-element-v2-openapi.yml