SQL RestoreOptions

Select

SaaS

Customer Managed

This operation returns files for given database(s) and instance. It also returns a list of SQL instances application to be restored to.

Request Parameters

Name	Description
restoreDbType	This is to be left at zero. This will return list of SQL instances it can safely be restored to based on the user defined databases passed in list and instance version check (SQL restores can be to same instance version or higher).
sourceInstanceId	Id of source instance
selectedDatabases	List of databases to restore
pointInTime	The reference time for the restore. Valid values are UNIX-style timestamps (seconds since January 1, 1970)

[_More Details_](https://documentation.commvault.com/commvault/v11_sp20/article?p=130527.htm)

application/json

Request Body

• restoreDbType integer
• sourceInstanceId integer
• selectedDatabases object[]

  databaseName string
• pointInTime integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• sqlDbdeviceItem object[]

  fileName string

  logicalFileName string

  fileMaxSize integer

  id integer

  sqlDBInfo object

  databaseName string

  databaseId integer
• sqlDestinationInstances object[]

  serverType string

  genericEntity object

  clientName string

  instanceId integer

  clientId integer

  instanceName string

  _type_ integer

  osType string
• error object

  errorMessage string

  errorCode integer

{
  "sqlDbdeviceItem": [
    {
      "fileName": "string",
      "logicalFileName": "string",
      "fileMaxSize": 0,
      "id": 0,
      "sqlDBInfo": {
        "databaseName": "string",
        "databaseId": 0
      }
    }
  ],
  "sqlDestinationInstances": [
    {
      "serverType": "string",
      "genericEntity": {
        "clientName": "string",
        "instanceId": 0,
        "clientId": 0,
        "instanceName": "string",
        "_type_": 0,
        "osType": "string"
      }
    }
  ],
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

POST /sql/restoreoptions    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• SQL RestoreOptions

---

{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/SQL/RestoreOptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "restoreDbType": 0,
  "sourceInstanceId": 0,
  "selectedDatabases": [
    {
      "databaseName": "string"
    }
  ],
  "pointInTime": 0
}'