Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nutanix Clusters API

Retrieve and manage Nutanix cluster configurations and metadata across the Prism Central deployment.

Nutanix Clusters API is one of 21 APIs that Nutanix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 3.1.0.

Requests are made against a single base URL, https://{prismCentralIp}:9440/api/nutanix/v3.

3 operations 3 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.1.0
Base URL
https://{{prism-central-ip}}:9440/api/nutanix/v3
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Nutanix Clusters API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Prism Central username and password credentials.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Clusters 3

Retrieve and manage Nutanix cluster configurations and metadata across the Prism Central deployment.

POST
/clusters/list
Nutanix List clusters
listClusters body → 200401
GET
/clusters/{uuid}
Nutanix Get a cluster
getCluster 1 param → 200401404
GET
/cluster
Nutanix Get cluster information
getCluster → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Cluster (7 properties), EntityMetadata (6 properties), ListMetadata (6 properties), ClusterIntentResponse (3 properties). Each schema is shown below with its type and property counts.

Reference
object
A reference to another entity.
3 properties 2 required
ListMetadata
object
Request body for list operations supporting server-side filtering, sorting, and pagination.
6 properties
EntityMetadata
object
Metadata for an entity.
6 properties
ClusterListResponse
object
Response for listing clusters.
3 properties
ClusterIntentResponse
object
Response containing cluster intent status and spec.
3 properties
Cluster
object
Nutanix cluster information.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nutanix-clusters-api-openapi.yml Raw ↑

Other APIs Nutanix publishes across the network.

Nutanix Prism Central API V4
Nutanix Karbon API
Nutanix Database Service API
Nutanix Cloud Clusters API
Nutanix NCM Self-Service API
Nutanix Foundation API
Nutanix Alerts API
Nutanix Categories API
Nutanix Hosts API
Nutanix Images API
Nutanix Network Security Rules API
Nutanix Projects API