Restore an MSSQL database from snapshot or backup.

post/backup-recovery/v1beta1/mssql-databases/{db-id}/restore

Restores a virtual machine from selected snapshot.

Securitybearer
Request
path Parameters
db-id
required
string

UUID string uniquely identifying the MSSQL Database

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Request Body schema: application/json
required
backupId
string

UUID string uniquely identifying the backup.

recoveryMode
string

The recovery mode the database will be in at the end of restore operation

Enum: "WITH_RECOVERY" "NO_RECOVERY"
restoreType
required
string

Specifies the type of restore needs to be performed.

Enum: "PARENT" "ALTERNATE"
restoreUntil
string <date-time>

Time in UTC upto which the recovery needs to be done. This attribute is required only if restore from log backup is intended.

restoreWithTailLog
boolean

Flag to indicate if the backup operation should backup the tail log

snapshotId
string

UUID string uniquely identifying the snapshot.

object (AlternateMSSQLDatabaseRestoreRequestParams)

Provides the details about target VM location, compute, etc These inputs are required only if the restore type is 'ALTERNATE'.

Responses
202

Accepted

400

Bad request

401

Unauthorized

403

Forbidden

409

Conflict

412

Precondition failed (if the generation number is invalid)

500

Internal / unexpected error

Request samples
application/json
{
  • "backupId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  • "recoveryMode": "WITH_RECOVERY",
  • "restoreType": "PARENT",
  • "restoreUntil": "2020-03-03T06:03:08.902Z",
  • "restoreWithTailLog": false,
  • "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  • "targetDatabaseInfo": {
    }
}
Response samples
application/json
{ }