Loading...

REST API - GET Microsoft SQL Server Backup Job

This operation returns a backup job based on a point in time (PIT) value. Use the end time of the backup job as the "to time" for a Microsoft SQL Server restore.

Request

Syntax

GET <webservice>/Client/{clientId}/SQL/Instance/{instanceId}/ReferenceTimeForPITRestore/{PointInTimeVal}?databaseName={database} 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

PointInTimeVal

The reference time for the restore.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

Yes

databaseName

The name of the database. If the database name is not known, use the GET Microsoft SQL Server Instance Browse API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

jobid

The job ID for the backup job.

root

backup_size

The size in bytes of the database that was backed up.

root

backupStartDate

The time the backup job started.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

root

DatabaseName

The name of the database.

root

backupMethod

The backup method used.

Valid values are:

  • VDI, Virtual Device Interface
  • VSS, Volume Shadow Copy Service
  • SNAP, IntelliSnap

root

type

The type of backup job.

Valid values are:

  • D, full
  • I, differential
  • L, transaction log

root

backupFinishDate

The time the backup job ended.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

root

backupsetId

The system-generated ID assigned to the backup set.

backupset

Examples

Sample Request

GET <webservice>/Client/24/SQL/Instance/26/ReferenceTimeForPITRestore/1525482215?Database=test001
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" ?>
<root>
  <jobid>278946</jobid>
  <backup_size>90553344</backup_size>
  <backupStartDate>1525717024</backupStartDate>
  <DatabaseName>test001</DatabaseName>
  <backupMethod>VDI</backupMethod>
  <type>D</type>
  <backupFinishDate>1525717026</backupFinishDate>
  <backupset>
    <backupsetId>106512</backupsetId>
  </backupset>
</root>

JSON

{
  "jobid": 278946,
  "backup_size": 90553344,
  "backupStartDate": 1525717024,
  "DatabaseName": "test001",
  "backupMethod": "VDI",
  "type": "D",
  "backupFinishDate": 1525717026,
  "backupset": {
    "backupsetId": 106512
  }
}

Last modified: 6/16/2020 3:34:18 PM