v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
NAS

List all backup jobs

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

get/nas/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

hostNamestring

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.

proxyNamestring

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.

statusstring

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.

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.

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

Result schema for 200 Response of GET GetBackupJobReport

nextPageTokenstring

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