GuidesAPI ReferenceGitHub RepositoryPartner IntegrationsWhat's New
API Reference
Product DocumentationSupportSandbox Account

List all backup jobs

get
https://govapis.druva.com/phoenix/nas/v1/orgs//reports/jobs/backups

Returns a list of all backup jobs for the NAS hosts.

Path Params
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
string

Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.

string

Specify the name of the NAS proxy. Multiple proxy names can be separated by commas. Get the list of the NAS proxy names using the 'ListProxy' API.

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.

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.

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.

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.

string

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'.

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.

Updated 10 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago