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 VMs API

Manage virtual machines including creation, update, deletion, and power state operations through the intent-based API model.

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

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

This API exposes 8 operations across 5 paths, and defines 7 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.

8 operations 5 paths 7 schemas 1 DELETE3 GET3 POST1 PUT

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 VMs 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 8

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

VMs 8

Manage virtual machines including creation, update, deletion, and power state operations through the intent-based API model.

POST
/vms/list
Nutanix List virtual machines
listVms body → 200401500
POST
/vms
Nutanix Create a virtual machine
createVm body → 202400401
GET
/vms
Nutanix List virtual machines
listVms 2 params → 200401
GET
/vms/{uuid}
Nutanix Get a virtual machine
getVm 1 param → 200401404
PUT
/vms/{uuid}
Nutanix Update a virtual machine
updateVm 1 param body → 202400401404
DELETE
/vms/{uuid}
Nutanix Delete a virtual machine
deleteVm 1 param → 202401404
GET
/vms/{id}
Nutanix Get a virtual machine
getVm 1 param → 200401404
POST
/vms/{id}/set_power_state
Nutanix Set VM power state
setVmPowerState 1 param body → 200401404

Schemas 7

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

VmSpec
object
VM specification describing the desired state.
4 properties
Reference
object
A reference to another entity.
3 properties 2 required
VmIntentInput
object
Input for creating or updating a VM with the intent model.
2 properties 2 required
VmIntentResponse
object
Response containing VM intent status and spec.
3 properties
VmListResponse
object
Response for listing VMs.
3 properties
EntityMetadata
object
Metadata for an entity.
6 properties
ListMetadata
object
Request body for list operations supporting server-side filtering, sorting, and pagination.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nutanix-vms-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 Clusters API
Nutanix Hosts API
Nutanix Images API
Nutanix Network Security Rules API