v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
AHV

List all jobs

Returns all jobs

get/ahv/v1/orgs/{OrgID}/reports/jobs

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

jobTypestring

Specify the type of the job. Set this value as "Backup", "Restore", or "Log Request". Specify multiple job types by separating them with commas.

statusstring

Specify the status of the job. Set this value as "Queued", "Running", "Successful", "Successful with errors", or "Failed". Specify multiple status values by separating them with commas.

vmNamestring

Specify the name of the VM. Specify multiple VM names by separating them with commas.

pageTokenstring

Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.

fromTimestring date-time

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.

toTimestring date-time

Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. 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.

Response

Success

nextPageTokenstring

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