v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

PBS

List all jobs

Returns all jobs for Phoenix Backup Stores.

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

Path parameters

OrgIDinteger required

The 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

jobTypeinteger[]

The type of the job. This parameter can be set to one or more of the following values: Backup, Restore and Log Request. Specify multiple job types by separating them with commas. See <a href=https://help.druva.com/en/articles/8651604-view-oracle-jobs>Job Types.</a>

serverNamestring[]

The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.

statusinteger[]

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.

fromTimeinteger

The date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and the timestamp must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.

toTimeinteger

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

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. Keep this field blank in the first request. The value of this parameter is NULL for the last set of results.