/hyperv
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /hyperv/cluster | Get summary of all the Hyper-V clusters. | Available | |
| GET /hyperv/cluster/{id} | Get details of a Hyper-V cluster. | Available | |
| PATCH /hyperv/cluster/{id} | Update cluster with specified properties. | Available | |
| GET /hyperv/hierarchy/{id} | Retrieve details for the specified hierarchy object. | Available | |
| GET /hyperv/hierarchy/{id}/children | Retrieve the list of immediate descendant objects for the specified parent. | Available | |
| GET /hyperv/hierarchy/{id}/descendants | Retrieve the list of descendant objects for the specified parent. | Available | |
| GET /hyperv/host | Get summary of all the Hyper-V hosts. | Available | |
| GET /hyperv/host/request/{id} | Get details about a Hyper-V host related async request. | Available | |
| GET /hyperv/host/{id} | Get details of a Hyper-V host. | Available | |
| PATCH /hyperv/host/{id} | Update host with specified properties. | Available | |
| POST /hyperv/host/{id}/refresh | Create a job to refresh the metadata for the specified Hyper-V host. | Available | |
| GET /hyperv/scvmm | Get summary of all the Hyper-V SCVMMs. | Available | |
| POST /hyperv/scvmm | Register a Hyper-V SCVMM. | Available | |
| GET /hyperv/scvmm/request/{id} | Get details about a Hyper-V SCVMM related async request. | Available | |
| GET /hyperv/scvmm/{id} | Get details of a Hyper-V SCVMM. | Available | |
| PATCH /hyperv/scvmm/{id} | Update SCVMM with specified properties. | Available | |
| DELETE /hyperv/scvmm/{id} | Delete a Hyper-V SCVMM. | Restricted | |
| POST /hyperv/scvmm/{id}/refresh | Create a job to refresh the metadata for the specified Hyper-V SCVMM. | Available | |
| GET /hyperv/vm | Get summary of all the VMs. | Available | |
| GET /hyperv/vm/request/{id} | Get details about a Hyper-V VM related async request. | Available | |
| GET /hyperv/vm/snapshot/mount | Retrieve the following information for all live mounts: ID, snapshot date, ID of source VM, name of source VM, ID of source host, status of the mount, mount event ID, and unmount event ID. | Available | |
| GET /hyperv/vm/snapshot/mount/{id} | Retrieve the following summary information for a specified live mount: ID, snapshot date, ID of source VM, name of source VM, ID of source host, status of the mount, mount event ID, and unmount event ID. | Available | |
| PATCH /hyperv/vm/snapshot/mount/{id} | Power a specified Live Mount virtual machine on or off. Pass true to power the virtual machine on and pass false to power the virtual machine off. | Available | |
| DELETE /hyperv/vm/snapshot/mount/{id} | Create a request to delete a live mount. | Restricted | |
| GET /hyperv/vm/snapshot/{id} | Retrieve detailed information about a snapshot. | Available | |
| DELETE /hyperv/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 VM. | Restricted | |
| GET /hyperv/vm/snapshot/{id}/browse | Lists all files and directories in a given path. | Available | |
| POST /hyperv/vm/snapshot/{id}/download | Download a snapshot from archival. | Available | |
| POST /hyperv/vm/snapshot/{id}/download_file | Create a download file request. | Available | |
| POST /hyperv/vm/snapshot/{id}/download_files | Start an asynchronous job to download multiple files and folders from a specified Hyper-V VM 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 'hyperv/vm/request/{id}'. | Available | |
| POST /hyperv/vm/snapshot/{id}/export | Export snapshot of a vm. | Available | |
| POST /hyperv/vm/snapshot/{id}/instant_recover | The VM will be started with networking enabled. If the VM does not exist anymore, a new VM will be created. | Available | |
| POST /hyperv/vm/snapshot/{id}/mount | Create a live mount request with given configuration. | Available | |
| POST /hyperv/vm/snapshot/{id}/restore_files | Restore files from a snapshot to the original source location. | Available | |
| GET /hyperv/vm/{id} | Detailed view of a VM. | Available | |
| PATCH /hyperv/vm/{id} | Update VM with specified properties. | Restricted | |
| GET /hyperv/vm/{id}/missed_snapshot | Retrieve the time of the day when the snapshots were missed specific to a vm. | Available | |
| POST /hyperv/vm/{id}/register_agent | Register the agent that installed in VM. | Restricted | |
| GET /hyperv/vm/{id}/search | Search for a file within the Virtual Machine. Search via full path prefix or filename prefix. | Available | |
| GET /hyperv/vm/{id}/snapshot | Retrieve the following information for all snapshots for a VM: ID, snapshot date, expiration date, type of source object, Name of VM, Name of fileset, type of snapshot, state of the cloud, level of consistency, name of snapshot VM, Index of state, total number of file, IDs of all replication location, IDs of all archival location. | Available | |
| POST /hyperv/vm/{id}/snapshot | Create an on-demand snapshot for the given VM ID. | Available | |
| DELETE /hyperv/vm/{id}/snapshot | Delete all snapshots of a virtual machine. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /hyperv/vm/batch_backup | Takes on-demand backup of multiple specified Hyper-V virtual machines. | Available | |
| POST /hyperv/vm/batch_export | Export a snapshot from each member of a set of virtual machines. | batchExportHypervVm | Available |
| POST /hyperv/vm/batch_instant_recover | Instantly recovers a batch of snapshots from a group of specified virtual machines. | mutation batchInstantRecoverHypervVm | Available |
| POST /hyperv/vm/batch_mount | Mounts a batch of snapshots from a group of specified virtual machines. | mutation batchMountHypervVm | Available |
| GET /hyperv/vm/request/{id} | Get details about a Hyper-V vm related async request. | query hypervVirtualMachineAsyncRequestStatus | Available |
| POST ??/hyperv??/vm??/snapshot??/{snapshot_id}??/{location_id}??/restore_files | Initiate a job to restore multiple files or folders. | mutation restoreHypervVirtualMachineSnapshotFiles | Available |
| POST /hyperv/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. | mutation downloadHypervVirtualMachineSnapshotFiles | Available |
| POST /hyperv/vm/snapshot/{snapshot_id}/{location_id}/download_files | Initiates a job to download one or more files or folders in an archived Hyper-V virtual machine snapshot from specified location. Returns the job instance ID. | Available | |
| POST /hyperv/vm/snapshot/{snapshot_id}/{location_id}/restore_files | Initiates a job to restore one or more files or folders in an archived Hyper-V virtual machine snapshot from the specified location. Returns the job instance ID. | mutation restoreVolumeGroupSnapshotFiles | Available |
| GET /hyperv/vm/{id}/request/force_full_snapshot | Retrieve the configuration created to force a full snapshot for a Hyper-V Virtual Machine. | Available | |
| POST /hyperv/vm/{id}/request/force_full_snapshot | Request a full snapshot during the next backup job of a Hyper-V virtual machine. | Available | |
| POST ??/hyperv??/vm??/snapshot??/{snapshot_id}??/{location_id}??/download | Download a snapshot from a replication target. | mutation downloadHypervSnapshotFromLocation | Available |