REST API - GET Microsoft SQL Server Instance Browse

This operation browses Microsoft SQL Server instances that were backed up.

Request

Syntax

GET webservice/Client/clientId/SQL/Instance/instanceId/Browse?fromTime=fromTime&toTime=toTime HTTP/1.1
Host: host name
Accept:application/xml | application/json
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
clientId	The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.	Yes
instanceId	The instance ID for the instance. If the instance ID is not known, use the GET Instance API to retrieve it.	Yes
fromTime	The option to browse using time. This parameter can be used with the toTime parameter or by itself: Browse files backed up between two date: fromTime=1378180800&toTime=1378439999. Browse files backed up after a certain date: fromTime=1378180800. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	No
toTime	The option to browse using time. This parameter can be used with the fromTime parameter or by itself: Browse files backed up between two date: fromTime=1378180800&toTime=1378439999. Browse files backed up before a certain date: toTime=1378439999. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	No

Request Headers

Name	Description
Host	The host name of the web server.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	dThe authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
createdTime	The time the database was backed up. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	sqlDatabase
databaseId	The system-generated ID assigned to the database.	sqlDatabase
databaseName	The name of the database.	sqlDatabase
version	The version of the database.	sqlDatabase

Examples

Sample Request

GET webservice/Client/8/SQL/Instance/5/Browse?fromTime=1486022400&toTime=1488182400 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Api_SQLBrowseResponse> <sqlDatabase createdTime="1497968692" databaseId="7" databaseName="DB002" version="12.0.2000"/>
</Api_SQLBrowseResponse>

JSON

{
   "sqlDatabase": [
     {
       "databaseName": "DB002",
       "createdTime": 1497968692,
       "databaseId": 7,
       "version": "12.0.2000"
     }
   ]
 }