List all backup jobs

Returns all backup jobs for SQL Servers.

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 SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating them with commas.

string

Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).

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.

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

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.

Responses

400

Bad Request

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:
*/*