--- title: "List all backup jobs" method: GET path: "/hyperv/v1/orgs/{OrgID}/reports/jobs/backups" tags: ["Hyper-V"] --- # List all backup jobs `GET /hyperv/v1/orgs/{OrgID}/reports/jobs/backups` Returns a list of all backup jobs for Hyper-V. ## Path parameters - `OrgID` integer, required ## Query parameters - `vmName` string[] - `hostName` string[] - `fromTime` integer - `toTime` integer - `sortOrder` string - `status` integer[] - `pageToken` string ## Response `200` Success - HVGetBackupJobsReportResponse - `jobs` HVHyperVBackupJob[] — List of all backup jobs run for Hyper-V. - `backupPolicyID` integer — The ID of your backup policy. - `backupPolicyName` string — The name of the backup policy attached to the backup set. - `backupsetID` integer — The ID of your backup set. - `clusterName` string — The name of Cluster. - `dataTransfer` HVHyperVBackupDataTransfer — HyperVBackupDataTransfer is the response schema for Hyper-V BackupData Transfer - `backupDuration` string — Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time. - `backupDurationInSeconds` integer — Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time. - `backupSpeed` string — Specifies the rate at which the source data is backed up to the Cloud. - `backupSpeedInKBps` number, double — Specifies the rate at which the source data is backed up to the Cloud in KBps. - `bandwidthConsumed` string — Specifies the bit rate to transfer data from the Cloud and CloudCache. - `bandwidthConsumedInKBps` number, double — Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache. - `dataTransferCache` string — Specifies the incremental data that is uploaded to CloudCache after deduplication and compression. - `dataTransferCacheInBytes` integer — Specifies the incremental data that is uploaded in bytes to CloudCache after deduplication and compression. - `dataTransferCloud` string — Specifies the incremental data that is uploaded to the Cloud after deduplication and compression. - `dataTransferCloudInBytes` integer — Specifies the incremental data that is uploaded in bytes to the Cloud after deduplication and compression. - `environmentDetails` HVHyperVEnvironmentDetails — HyperVEnvironmentDetails is the response schema for Hyper-V EnvironmentDetails - `diskReadRate` string — Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed. - `diskReadRateInKBps` number, double — Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed. - `networkRetries` integer — Specifies the number of network retries during the job. - `networkRetryDuration` string — Specifies the total time spent in the network retries. It represents the cumulative of all network session duration. - `networkRetryDurationInSeconds` integer — Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration. - `estimationDetails` HVHyperVEstimationDetails — HyperVEstimationDetails struct holds the response for GetBackupJobsReport api - `dataScanned` integer — Specifies the total data scanned during the job. - `disksAdded` integer — The number of VM disks added at the source during the job. - `disksModified` integer — The number of VM disks changed at the source during the job. - `disksRemoved` integer — The number of VM disks removed at the source during the job. - `sourceDataScanned` string — Specifies the data scanned at the source in order to backup. - `sourceDataScannedInBytes` integer — Specifies the data scanned in bytes at the source in order to backup. - `executionDetails` HVHyperVBackupExecutionDetails — HyperVBackupExecutionDetails is the response schema for Hyper-V Backup Execution Details - `endTime` string — The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ. - `errorCode` string — Specifies the error code when the backup operation fails. The possible values are:\n \"0\": If the job is successful\n : If the job has failed - `errorMessage` string — Specifies the message for rhe failed job. This field is empty if the job is successful. - `startTime` string — The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ. - `status` string — Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas. - `host` string — The name of the Hyper-V host. Multiple host names can be separated by commas. Get the list of the Hyper-V host names using the 'ListHost' API. - `jobID` integer — Specifies a unique identification number associated with the job. - `jobType` string — Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types. - `organizationID` integer — The ID of your organization. - `organizationName` string — The name of the organization. - `scvmmName` string — The name of System Center Virtual Machine Manager(SCVMM). - `vmName` string — The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas. - `nextPageToken` string — The token to access the next page of results. This parameter will be empty for the last page of results. ## Other responses - `400` — Bad Request - `404` — The requested resource was not found. - `500` — The request was not processed due to an internal error in the Cloud. --- [API](https://skmtc.dev/druva/apis/authentication.md) · [All operations](https://skmtc.dev/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/druva/authentication/revisions/2af2bf148b25/schema)