v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
SQLServer

List all jobs

Returns all jobs for SQL.

get/sqlserver/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. The possible values for the job type are: "Backup", "Restore", "Log Request", and "Defreeze". Specify multiple job types by separating the values with commas. For more information, see <a href=https://help.druva.com/en/articles/8651417-monitor-sql-jobs>Job Types.</a>

resourceNamestring

Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating the values with commas.

resourceTypestring

Specify the resource type of the SQL Server. The possible values for the resource type are "SA" and "AG".

statusstring

Specify the status of the job. The possible values for status are: "Queued", "Running", "Successful", "Successful with errors" and "Failed". Specify multiple job statuses by separating the values 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 a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all jobs created after this date and time. 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 a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all jobs created before this date and time. The timestamp must be within six months from the current date.

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