/managed_volume
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /managed_volume | Retrieve summary information for all managed volumes that are created within a Rubrik cluster. | Available | |
| POST /managed_volume | Create a managed volume. | mutation addManagedVolume | Available |
| GET /managed_volume/snapshot/export | Returns a list of summary information for all exports of all managed volume snapshots, sorted and filtered. | query managedVolumeLiveMounts | Available |
| GET /managed_volume/snapshot/export/{id} | Retrieve detailed information about a managed volume snapshot export by specifying the snapshot export ID. | Available | |
| GET /managed_volume/snapshot/{id} | Retrieve detailed information about a snapshot. | Available | |
| DELETE /managed_volume/snapshot/{id} | Delete a managed volume snapshot. | Restricted | |
| GET /managed_volume/snapshot/{id}/browse | Lists all files and directories in a given path. | Available | |
| POST /managed_volume/snapshot/{id}/download | Create a download managed volume snapshot from archival request. | mutation exportManagedVolumeSnapshot | Available |
| POST /managed_volume/snapshot/{id}/download_file | Create a download file request. | Available | |
| POST /managed_volume/snapshot/{id}/download_files | Start an asynchronous job to download multiple files and folders from a specified managed volume 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 'managed-volume/request/{id}'. | mutation downloadManagedVolumeFiles | Available |
| GET /managed_volume/{id} | Details of a managed volume. | query managedVolumes | Available |
| PATCH /managed_volume/{id} | Update managed volume with specified properties. | Restricted | |
| DELETE /managed_volume/{id} | Delete a managed volume. | mutation deleteManagedVolume | Restricted |
| GET /managed_volume/{id}/inflight_snapshot | Returns summary information about the in-flight snapshot if the managed volume is open for write operations. When the managed volume is in any other state, returns a 404 error. | query managedVolumes | Available |
| POST /managed_volume/{id}/resize | Resize the managed volume to a larger size. Once a volume size has been increased, it can not be decreased. | mutation resizeManagedVolume | Restricted |
| GET /managed_volume/{id}/search | Search a managed volume for files. | Available | |
| GET /managed_volume/{id}/snapshot | Returns a list of summary information for snapshots of a managed volume. | query managedVolumes | Available |
| POST /managed_volume/{id}/snapshot | Create a job for an on-demand snapshot of an SLA Managed Volume. The response returns a request ID. To see the status of the request, poll 'managed-volume/request/{id}' with the request ID obtained in the response. | Available | |
| GET /managed_volume/{id}/snapshot/{snapshot_id}/reference | Get information about references to an in-flight snapshot of a managed volume. This is for internal use only. | Available | |
| GET /managed_volume/{id}/snapshot/{snapshot_id}/reference/{reference_id} | Get information about a reference to an in-flight snapshot of a managed volume. | Restricted | |
| PUT /managed_volume/{id}/snapshot/{snapshot_id}/reference/{reference_id} | Add a reference to an in-flight snapshot of a managed volume. | Restricted | |
| PATCH /managed_volume/{id}/snapshot/{snapshot_id}/reference/{reference_id} | Update a reference to an in-flight snapshot of a managed volume. | Restricted | |
| DELETE /managed_volume/{id}/snapshot/{snapshot_id}/reference/{reference_id} | Remove a reference to an in-flight snapshot of a managed volume. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /managed_volume | Start an asynchronous job to create a Managed Volume stack. | Available | |
| GET /managed_volume/request/{id} | Retrieve the status of a Managed Volume async request. | Available | |
| DELETE /managed_volume/snapshot/export/{id} | Deletes an exported Managed Volume snapshot, identified by the snapshot ID. | mutation deleteManagedVolumeSnapshotExport | Available |
| POST /managed_volume/snapshot/export/{id}/script | Start an asynchronous job to generate and download a script to unify export paths across channels in Managed Volume export. | Restricted | |
| POST /managed_volume/snapshot/{id}/export | Exports a Managed Volume snapshot as a share. | mutation exportManagedVolumeSnapshot | Available |
| POST /managed_volume/snapshot/{id}/restore | Exports an SLA Managed Volume snapshot as a share and mounts it on a given host. | mutation exportSlaManagedVolumeSnapshot | Available |
| POST /managed_volume/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 remote target connected to this Rubrik cluster. | Available | |
| POST /managed_volume/snapshot/{snapshot_id}/{location_id}/download_files | Initiates a job to download one or more files or folders from an archived Managed Volume snapshot. Returns the job instance ID. | Available | |
| DELETE /managed_volume/{id} | Delete a Managed Volume. | Restricted | |
| POST /managed_volume/{id}/begin_snapshot | Opens the Managed Volume for writes. All data written to the Managed Volume until the next end-snapshot call will be part of this snapshot. | mutation beginManagedVolumeSnapshot | Available |
| POST /managed_volume/{id}/configure_log_export | For a specific SLA Managed Volume, this endpoint creates a log export if it does not already exist, otherwise it updates the existing log export. | Restricted | |
| POST /managed_volume/{id}/end_snapshot | Close a Managed Volume for writes. A snapshot will be created containing all writes since the last begin-snapshot call. | mutation endManagedVolumeSnapshot | Available |
| POST /managed_volume/{id}/restore_logs | This endpoint restores logs for the given time window for a SLA Managed Volume. This API returns an error if no logs are available in the specified time range. | Restricted |