/fileset
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /fileset/bulk | Create filesets for a network host. Each fileset is a fileset template applied to a host. | Available in v8.0.1 and later, but not recommended for use. Use POST /fileset/bulk/nas instead. |
|
| DELETE /fileset/bulk | Delete filesets by specifying the fileset IDs. | Restricted | |
| POST /fileset/snapshot/{id}/download_files | Start an asynchronous job to download multiple files and folders from a specified fileset backup. The response returns an asynchronous request ID. Get the URL for downloading the ZIP file containing the specific files and folders by sending a GET request to 'fileset/request/{id}'. | Available in v8.0.1 and later | |
| POST /fileset/snapshot/{id}/export_files | Starts a job that exports one or more files or folders from a fileset backup to the destination host. Returns the initial job status including the job ID. | Available in v8.0.1 and later | |
| POST /fileset/snapshot/{id}/restore_files | Initiate a job to copy files and folders from a fileset backup to the source host. Returns the job instance ID. | Available in v8.0.1 and later | |
| POST /fileset/{id}/unprotect | Remove SLA assignment from a fileset, specifying what retention policy to apply to existing snapshots. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /fileset | Retrieve summary information for each fileset. Optionally, filter the retrieved information. | query linuxFilesets/windowsFilesets | Available |
| POST /fileset | Create a fileset for a network host. A fileset is a fileset template applied to a host. | mutation bulkCreateFilesets | Available in v8.0.1 and later, but not recommended for use. Use POST /fileset/bulk/nas instead. |
| GET /fileset/request/{id} | Get details about a fileset related async request. | Available | |
| GET /fileset/snapshot/{id} | Retrieve summary information for a fileset snapshot by specifying the snapshot ID. | query filesetSnapshot | Available |
| DELETE /fileset/snapshot/{id} | Delete a fileset snapshot. A snapshot is deleted only if it is an on-demand snapshot, a snapshot of an unprotected fileset or a local snapshot that was downloaded from an archive location. | Restricted | |
| GET /fileset/snapshot/{id}/browse | Lists all files and directories in a given path. | mutation filesetSnapshotFiles | Available |
| POST /fileset/snapshot/{id}/download | Create a download fileset snapshot from archival request. | mutation downloadFilesetSnapshot | Available |
| POST /fileset/snapshot/{id}/download_file | "Initiate a job to download a file from a backup of a fileset. Returns a job instance ID. An email notification will be sent out when the download is ready. When the download is ready, the file can be downloaded from the corresponding event which includes the job instance ID as the value of jobInstanceId. | mutation filesetDownloadSnapshotFiles | Available |
| POST /fileset/snapshot/{id}/export_file | Initiate a job to copy a file or folder from a fileset backup to a destination host other than the source host. Returns the job instance ID. | mutation filesetExportSnapshotFiles | Available |
| POST /fileset/snapshot/{id}/restore_file | Initiate a job to copy a file or folder from a fileset backup to the source host. Returns the job instance ID. | mutation filesetRecoverFiles | Available |
| POST /fileset/snapshot/{snapshot_id}/{location_id}/download_files | Initiates a job to download files and folders from an archived Fileset snapshot. Returns the job instance ID. | mutation downloadFilesetSnapshotFromLocation | Available in v8.0.1 and later |
| POST /fileset/snapshot/{snapshot_id}/{location_id}/export_files | Initiates a job to export files and folders from an archived Fileset snapshot to a destination host. Returns the job instance ID. | Available in v8.0.1 and later | |
| POST /fileset/snapshot/{snapshot_id}/{location_id}/restore_files | Initiate a job to copy files and folders in a fileset backup from a specified archival location to the source host. Returns the job instance ID. | Available in v8.0.1 and later | |
| GET /fileset/{id} | Retrieve summary information for a fileset by specifying the fileset ID. | query linuxFileset/windowsFileset | Available in v8.0.1 and later |
| PATCH /fileset/{id} | Update a Fileset with the specified properties. | Available in v8.0.1 and later | |
| DELETE /fileset/{id} | Delete a fileset by specifying the fileset ID. | mutation bulkDeleteFileset | Restricted |
| GET /fileset/{id}/missed_snapshot | Retrieve summary information about all missed snapshots for a fileset. | Available | |
| GET /fileset/{id}/request/force_full_snapshot | Retrieves the configuration for upcoming forced full snapshot of a specified Fileset. | Available | |
| POST /fileset/{id}/request/force_full_snapshot | Sets the configuration for taking a forced full snapshot of a specified Fileset in the next backup job. The specification is cleared automatically after the next successful backup. | Available | |
| GET /fileset/{id}/search | Search for a file within the fileset. Search via full path prefix or filename prefix. | Available | |
| POST /fileset/{id}/snapshot | Create an on-demand backup request for the given fileset. | mutation createFilesetSnapshot | Available |
| DELETE /fileset/{id}/snapshot | "Delete all snapshots that were created based on a fileset by providing the fileset ID. Requires an unprotected fileset. Remove the fileset from all SLA Domains. | mutation deleteFilesetSnapshots | Restricted |
v2 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /fileset/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 |