List all restore jobs

get https://apis.druva.com/phoenix/sqlserver/v1/orgs/{OrgID}/reports/jobs/restores

Returns all restore jobs for SQL Servers.

Path Params

OrgID

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

resourceName

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.

resourceType

string

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

status

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.

sortOrder

string

Sort the API results based on start time of the job, either in the ascending or descending order. Set its value to ASC or DESC. The default value is ASC.

pageToken

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

fromTime

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.

toTime

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.

destServerName

string

Specify the name of the SQL server to which the restore job is initiated. Specify multiple server names by separating them with commas.

Responses

400

Bad Request

404

The requested resource was not found.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apis.druva.com/phoenix/sqlserver/v1/orgs/OrgID/reports/jobs/restores \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Success

500The request was not processed due to an internal error in the Cloud.