v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Hyper-V

List all backup jobs

Returns a list of all backup jobs for Hyper-V.

get/hyperv/v1/orgs/{OrgID}/reports/jobs/backups

Path parameters

OrgIDinteger required

Specify the organization ID of your organization. Set it to "0" to select all organizations. Get the ID of an organization using the 'List all organizations' API.

Query parameters

vmNamestring[]

The name of the virtual machine (VM) for which the job has been initiated. Specify multiple VM names by separating them with commas.

hostNamestring[]

The name of the Hyper-V host on which the FLR proxy is deployed. Multiple host names can be separated by commas.

fromTimeinteger

Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.

toTimeinteger

Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.

sortOrderstring

Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.

statusinteger[]

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.

pageTokenstring

Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.

Response

Success

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of results.