List all restore jobs

get

https://apis.druva.com/phoenix/ahv/v1/orgs/{OrgID}/reports/jobs/restores

Returns all restore jobs

Path Params

OrgID

int32

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 Params

status

string

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

vmName

string

Specify the name of the virtual machine. Specify multiple virtual machine names by separating names with commas.

pageToken

string

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.

fromTime

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.

toTime

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.

sortOrder

string

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.

Responses

400

Bad Request

401

The request did not include an authentication token or the authentication token was expired.

403

Forbidden

404

The requested resource was not found.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

500The request was not processed due to an internal error in Cloud.