/nutanix
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /nutanix/cluster | Retrieve information for each managed Nutanix cluster. | Available | |
| POST /nutanix/cluster | Create a Nutanix cluster object by providing an address and account credentials for Prism. Initiates an asynchronous job to establish a connection with the cluster and retrieve all metadata. Use GET /nutanix_cluster/{id}/status to check status. | Available | |
| GET /nutanix/cluster/request/{id} | Get details about a Nutanix cluster-related async request. | Available | |
| GET /nutanix/cluster/{id} | Retrieve detailed information for a Nutanix Cluster object. | Available | |
| PATCH /nutanix/cluster/{id} | Patch the host, credentials, and/or CA certs of the specified Nutanix cluster object. | Available | |
| DELETE /nutanix/cluster/{id} | Initiates an asynchronous job to remove a Nutanix cluster object. The Nutanix cluster cannot have VMs mounted through the Rubrik cluster. | Restricted | |
| GET /nutanix/cluster/{id}/container | Query the nutanix cluster to get the list of containers, used for export purposes. | Available | |
| POST /nutanix/cluster/{id}/refresh | Create a job to refresh the metadata for the specified Nutanix cluster. | Available | |
| GET /nutanix/hierarchy/{id} | Retrieve details for the specified hierarchy object. | Available | |
| GET /nutanix/hierarchy/{id}/children | Retrieve the list of immediate descendant objects for the specified parent. | Available | |
| GET /nutanix/hierarchy/{id}/descendants | Retrieve the list of descendant objects for the specified parent. | Available | |
| GET /nutanix/pc | Retrieve information for each managed Nutanix Prism Central. | Restricted | |
| POST /nutanix/pc | Create a Nutanix Prism Central object and refresh the Prism Elements present in it. | Restricted | |
| POST /nutanix/pc/ping | Check connectivity status to the Nutanix Prism Central host and details of the included Prism Elements. | Restricted | |
| GET /nutanix/pc/request/{id} | Retrieve the status for the Nutanix Prism Central async request. | Restricted | |
| GET /nutanix/pc/{id} | Retrieve summary of the Managed Nutanix Prism Central object. | Restricted | |
| PATCH /nutanix/pc/{id} | Patch the host and credentials of Nutanix Prism Central. | Restricted | |
| DELETE /nutanix/pc/{id} | Initiates an asynchronous job to remove a Nutanix Prism Central object. The Nutanix Clusters attached to the Prism Central cannot have Virtual Machines mounted through the Rubrik cluster. | Restricted | |
| GET /nutanix/pc/{id}/cluster | Get summary of each Nutanix cluster object in the given Nutanix Prism Central object. | Restricted | |
| POST /nutanix/pc/{id}/cluster | Add a new Nutanix Cluster object to the Nutanix Prism Central object. | Restricted | |
| POST /nutanix/pc/{id}/refresh | Initiates a job to refresh the metadata for the specified Nutanix Prism Central and all its associated clusters. | Restricted | |
| GET /nutanix/vm | Get summary of all the virtual machines. | Available | |
| GET /nutanix/vm/request/{id} | Get details about a Nutanix virtual machine-related async request. | Available | |
| GET /nutanix/vm/snapshot/{id} | Retrieve detailed information about a snapshot. | Available | |
| DELETE /nutanix/vm/snapshot/{id} | Delete a snapshot by expiring it. Snapshot is expired only if it is a manual snapshot or a snapshot of an unprotected virtual machine. | Restricted | |
| GET /nutanix/vm/snapshot/{id}/browse | Lists all files and directories in a given path. | Available | |
| POST /nutanix/vm/snapshot/{id}/download | Download a snapshot from archival. | mutation downloadNutanixVmFromLocation | Available |
| POST /nutanix/vm/snapshot/{id}/download_files | Start an asynchronous job to download multiple files and folders from a specified Nutanix virtual machine backup. The response returns an asynchronous request ID. Get the URL for downloading the zip file including the specific files/folders by sending a GET request to 'nutanix/vm/request/{id}'. | mutation downloadFilesNutanixSnapshot | Available |
| POST /nutanix/vm/snapshot/{id}/export | Export snapshot of a virtual machine. | Available | |
| POST /nutanix/vm/snapshot/{id}/restore_files | Restore files from a snapshot to the source Nutanix virtual machine. | mutation restoreFilesNutanixSnapshot | Available |
| GET /nutanix/vm/{id} | Detailed view of a Nutanix virtual machine. | Available | |
| PATCH /nutanix/vm/{id} | Patch virtual machine with specified properties. | Available | |
| GET /nutanix/vm/{id}/missed_snapshot | Retrieve the time of the day when the snapshots were missed specific to a virtual machine. | Available | |
| POST /nutanix/vm/{id}/register_agent | Register the agent installed on the Nutanix virtual machine. | Available | |
| GET /nutanix/vm/{id}/search | Search for a file within the Nutanix Virtual Machine. Search via full path prefix or filename prefix. | Available | |
| GET /nutanix/vm/{id}/snapshot | Retrieve the following information for all snapshots for a virtual machine: ID, snapshot date, expiration date, type of source object, name of virtual machine, type of snapshot, state of the cloud, level of consistency, name of snapshot virtual machine, index state, total number of files, IDs of all replication location, IDs of all archival locations. | Available | |
| POST /nutanix/vm/{id}/snapshot | Create an on-demand snapshot for the given virtual machine ID. | Available | |
| DELETE /nutanix/vm/{id}/snapshot | Delete all snapshots of a virtual machine. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /nutanix/cluster/{id}/network | Retrieves the list of networks by querying the Nutanix cluster. The list of networks is used for restore purposes. | Available | |
| POST /nutanix/vm/batch_export | Export a snapshot from each member of a set of virtual machines. | mutation batchExportNutanixVm | Available |
| POST /nutanix/vm/batch_mount | Mounts a batch of snapshots from a group of specified virtual machines. | mutation batchMountNutanixVm | Available |
| POST /nutanix/vm/bulk_backup | Take bulk backups for multiple Nutanix virtual machines. | Available | |
| GET /nutanix/vm/request/{id} | Retrieve details about a Nutanix virtual machine-related async request. | query nutanixVmAsyncRequestStatus | Available |
| GET /nutanix/vm/snapshot/mount | Retrieves summary information about Nutanix Live Mounts. | query nutanixMounts | Available |
| GET /nutanix/vm/snapshot/mount/{id} | Retrieves the detailed information of a Nutanix Live Mount. | Available | |
| PATCH /nutanix/vm/snapshot/mount/{id} | Changes the power status of a mounted Nutanix virtual machine. | mutation patchNutanixMountV1 | Available |
| DELETE /nutanix/vm/snapshot/mount/{id} | Initiates a request to remove a Live Mount of a Nutanix virtual machine snapshot identified by the ID of the Live Mount. | mutation deleteNutanixMountV1 | Available |
| POST /nutanix/vm/snapshot/mount/{id}/migrate | Initiate a request to migrate the virtual disks of a specified Nutanix Live Mount to another storage container. The destination storage container has been specified when the Live Mount was created. The Live Mount will be deleted when the relocation succeeds. | mutation migrateNutanixMountV1 | Available |
| POST /nutanix/vm/snapshot/{id}/mount | Initiates a request to perform a Live Mount of a Nutanix virtual machine snapshot identified by the snapshot ID. | mutation mountNutanixSnapshotV1 | Available |
| POST /nutanix/vm/snapshot/{snapshot_id}/{location_id}/download | Initiates a job to download a snapshot from the specified location when the snapshot does not exist locally. The specified location has to be a replication target connected to this Rubrik cluster. If an SLA Domain is not provided, the snapshot will be retained forever. | Available | |
| POST /nutanix/vm/snapshot/{snapshot_id}/{location_id}/download_files | Initiates a job to download one or more files or folders from an archived Nutanix virtual machine snapshot. Returns the job instance ID. | Available | |
| POST /nutanix/vm/snapshot/{snapshot_id}/{location_id}/restore_files | Initiates a job to restore one or more files or folders from an archived Nutanix virtual machine snapshot. Returns the job instance ID. | Available | |
| GET /nutanix/vm/{id}/request/force_full_snapshot | Retrieves the configuration created to force a full snapshot for a Nutanix Virtual Machine. | Available | |
| POST /nutanix/vm/{id}/request/force_full_snapshot | Requests a full snapshot during the next backup job of a Nutanix virtual machine. | Available |