/volume_group
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /volume_group/host_layout/{snapshot_id} | Use a snapshot ID to retrieve the host layout for the source host, including the layout of all disks and all volumes on the host. | Available | |
| GET /volume_group/request/{id} | Get details about a Volume Group-related async request. | Available | |
| DELETE /volume_group/snapshot/mount/{id} | Create a request to delete a mount. If there are volumes mounted on a target host, this will use best-effort to unmount those volumes from the host, and proceed to unmount storage on Rubrik. | Available | |
| DELETE /volume_group/snapshot/{id} | Delete a snapshot by expiring it. A snapshot can only be expired if it is an on-demand snapshot or a snapshot of an unprotected Volume Group. | Restricted | |
| GET /volume_group/snapshot/{id}/browse | Lists all files and directories in a given path. | Available | |
| POST /volume_group/snapshot/{id}/download | Download a snapshot from archival. | Available | |
| POST /volume_group/snapshot/{id}/download_files | Create a download files request. | Available | |
| POST /volume_group/snapshot/{id}/mount | Create a live mount request for a Volume Group snapshot. | Available | |
| POST /volume_group/snapshot/{id}/restore_files | Restore filess to the original Host. | Available | |
| GET /volume_group/{host_id}/host_layout | Retrieve the host layout for a specified host. | Available | |
| GET /volume_group/{id}/missed_snapshot | Retrieve the time of the day when the snapshots were missed specific to a Volume Group. | Available | |
| GET /volume_group/{id}/search | Search for a file within the Volume Group. Search via full path prefix or filename prefix. | Available | |
| DELETE /volume_group/{id}/snapshot | Delete all snapshots of a Volume Group. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /volume_group | Get summary of all Volume Groups. | volumeGroupConnection | Available |
| GET /volume_group/snapshot/mount | Retrieves information for each Volume Group mount. The information returned includes the following items, when available. ID (the unique ID of the mount), name (the name of the Volume Group), snapshotDate (the snapshot date), sourceVolumeGroupId (the ID of the Volume Group from which this snapshot was created), sourceHostId (the ID of the source host), sourceHostName (the name of the source host), mountedDate (the date when the mount was created), mountedVolumes (information on the mounted volumes), targetHostId (the ID of the mounted volumes host), targetHostName (the name of the mounted volumes host), mountRequestId (the ID of the job instance that initiated the mount), unmountRequestId (the ID of the job instance that initiated the request to remove the mount), isReady (whether the Volume Group mount is ready to use), and restoreScriptSmbPath (the link to the script that can perform bare-metal recovery). | volumeGroupMounts | Available |
| GET /volume_group/snapshot/mount/{id} | Retrieve information on a specific Volume Group mount. The information returned includes the following items, when available. ID (the unique ID of the mount), name (the name of the Volume Group), snapshotDate (the snapshot date), sourceVolumeGroupId (The ID of the Volume Group from which this snapshot was created), sourceHostId (the ID of the source host), sourceHostName (the name of the source host), mountedDate (the date when the mount was created), mountedVolumes (the mounted volumes information), targetHostId (the ID of the mounted volumes host), targetHostName (the name of the mounted volumes host), mountRequestId (the ID of the job instance that initiated the mount), unmountRequestId (the ID of the job instance that intiated the request to remove the mount), isReady (whether the Volume Group mount is ready to use), and restoreScriptSmbPath (the link to the script that can perform bare-metal recovery). | Available | |
| GET /volume_group/snapshot/{id} | Retrieve detailed information about a snapshot. | Available | |
| POST /volume_group/snapshot/{id}/restore_volumes | Restore volumes to a host running the Rubrik backup agent. | Available | |
| POST /volume_group/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. | downloadVolumeGroupSnapshotFromLocation | Available |
| POST /volume_group/snapshot/{snapshot_id}/{location_id}/download_files | Initiates a job to download one or more files or folders from an archived Volume Group snapshot. Returns the job instance ID. | downloadManagedVolumeFiles | Available |
| POST /volume_group/snapshot/{snapshot_id}/{location_id}/restore_files | Initiates a job to restore one or more files or folders from an archived Volume Group snapshot. Returns the job instance ID. | restoreVolumeGroupSnapshotFiles | Available |
| GET /volume_group/{id} | Detailed view of a Volume Group. | volumeGroup | Available |
| PATCH /volume_group/{id} | Patch Volume Group with specified properties. | Restricted | |
| GET /volume_group/{id}/latest_snapshot | Retrieve the latest snapshot summary of a Volume Group. | createOnDemandVolumeGroupBackup | Available |
| GET /volume_group/{id}/request/force_full_snapshot | Retrieve the configuration for forcing a full snapshot for a Volume Group. | Available | |
| POST /volume_group/{id}/request/force_full_snapshot | Request a full snapshot to be taken during the next backup job of a Volume Group. | Available | |
| GET /volume_group/{id}/snapshot | Retrieve snapshot details for a Volume Group. | physicalHost | Available |
| POST /volume_group/{id}/snapshot | Create an on-demand snapshot for the given Volume Group ID. | createOnDemandVolumeGroupBackup | Available |