> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Nutanix API

> Read what Nutanix VMs and SP Central tenants use, add or remove CPU, memory and disk space, and manage VMs, clusters, storage and alerts in Prism Central — each change follows the approval settings you give it

The tool reaches your own Prism Central through the Nutanix v4 API, signed in with the API key of the service account you save in Neo, so each call is limited twice: by that service account's roles in Prism Central and by the agent's permission groups below.

> [!NOTE]
>
> Automatically enabled when you configure Nutanix permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find a VM by name, DNS name or the BIOS UUID an RMM shows, or a client's VMs by SP Central tenant, project, category, cluster or naming prefix
* Read the vCPUs, memory and disks a VM is given, and its CPU, memory and storage use over a period; add these up for a client
* Read an SP Central tenant's CPU, memory and storage allocation and its projects
* Add or remove vCPUs and memory, add a disk or grow one, and follow the change's task to the end
* Power a VM on, off or restart it, clone it, deploy one from a template, take and restore recovery points, and tag it with categories
* Read cluster and host load, storage container free space, subnets, open alerts, events and audits; acknowledge and resolve alerts
* Manage images and templates, clusters and hosts, storage, networking, network security policies, data protection, upgrades and licensing, users and roles, and SP Central tenants, with the access and approvals you choose

The agent calls the v4 API through the [Vendor API](/agents/tools/vendor-api) tool, with `nutanix` as the vendor id. [Sandbox](/agents/tools/built-in/sandbox) scripts can call Nutanix too, under the same permissions. Neo adds the ETag a change needs from the entity the agent read, and a fresh request id to every change.

## Permission Groups

| Group | What it covers |
| - | - |
| **Virtual Machines** | VMs on AHV and ESXi, their disks, network cards, power, guest tools, VM recovery points, categories, VM policies and statistics |
| **Images and Templates** | Disk images, ISOs, OVAs, VM templates and their placement policies |
| **Clusters and Hosts** | Clusters, hosts, controller VMs, GPUs, cluster profiles, SNMP, syslog and IP pools, with statistics |
| **Storage** | Storage containers, physical disks, volume groups, storage policies, external storage, Nutanix Files and Nutanix Objects |
| **Networking** | Subnets, VLANs, virtual switches, VPCs, floating IPs, routing, gateways, VPN and load balancer sessions |
| **Network Security Policies** | Flow network security policies and their address, service and entity groups |
| **Data Protection and Recovery** | Protection policies, recovery points, recovery plans, failovers and restores |
| **Alerts, Events and Reports** | Alerts, events, audits, health checks, log collection, reports and capacity planning |
| **Categories and Tasks** | Categories and the tasks every change runs as |
| **Users, Roles and Access** | Users, groups, roles, authorization policies, directory services, SAML providers, API key records, stored credentials and the cluster's own account passwords |
| **Upgrades and Licensing** | Life Cycle Manager inventory, prechecks, upgrades and node imaging, and licenses |
| **Prism Central, Security and Encryption** | Prism Central's registration, backups and scaling, multi-domain management, certificates, key management servers, encryption, security profiles, approval policies and security reports |
| **Tenants** | SP Central tenants, their domains, users, projects and allocations |

Every group can be Disabled, Read Only or Read/Write. Neo never sends these calls: a batch of API calls in one; a VM console token; creating an API key or an object store key, reading a claim token's secret, a VPN device's configuration or the cluster's encryption key backup; destroying a cluster; unregistering Prism Central or restoring it from a backup; and the calls that upload or download a file, such as an image download, a report file or a certificate upload. Neo removes the fields Nutanix keeps credentials in from every answer.

## Access Profiles

> **Read Only**
>
> Every group Read Only. The agent reads, and never changes anything.

> **Helpdesk**
>
> Alerts, Events and Reports and Categories and Tasks are Read/Write without approval. Virtual Machines is Read/Write with technician approval. Everything else is Read Only.

> **IT Admin**
>
> Every group Read/Write. Network Security Policies, Users, Roles and Access, Upgrades and Licensing, Prism Central, Security and Encryption, and Tenants require technician approval, and so do the changes below.

> **Full Automation**
>
> Every group Read/Write without approval, except the changes below, which still require technician approval.

## Safety Controls

These require technician approval under every access profile, whatever the group's own approval setting:

* Deleting a VM, a VM disk, a recovery point, an image, OVA or template, a storage container, a volume group or its disk, a physical disk, a file share, an object store, a node or an SP Central tenant, removing a node from a cluster, and clearing a container's reserved space.
* Uninstalling guest tools from a VM, and unregistering the vCenter extension.
* Any change in Users, Roles and Access, and in Prism Central, Security and Encryption.
* Any change to alert policies or alert email. Acknowledging or resolving an alert does not ask on its own.
* Any change that stores a credential.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.