v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

SQLServer

Restore SQL Server database(s) to an alternate location

Performs a full restore of SQL Server database(s) to an alternate instance or availability group.

post/sqlserver/v2/orgs/{orgID}/jobs/restores/alternate

Path parameters

orgIDinteger required

Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.

Request body

backupsetIDinteger required

Specify the ID of the backup set that you want to restore. Get the ID using the 'List backup sets' API.

customDBNamestring

Specify the name for the restored database. If you skip this field, the database name created will be rst_<origitnal_database_name>.

databasesstring[] required

JSONStringList is data type to be used in model definition for data that is string:interface map in memory but stored as JSON string in DB

pitEpochinteger

Specify the point in time till which restore has to be triggered in the Unix Epoch format, such as 31536000.

sharedNetworkLocationstring

This field is required for restoring databases to an Availability Group. Specify the path of the shared network location where the availability group is located.

snapshotNamestring required

Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.

targetResourceNamestring required

Specify the name of the target resource. The target resource is either availability group or an instance.

targetResourceTypestring required

Specify the target resource type. Enter 'ag' for an availability group or 'sa' for a standalone instance.

Response

Success

jobIDinteger

TA unique identification number associated with the job.