Skip to main content

Restore a YugabyteDB instance​

Select

SaaS
Customer Managed

This API is used to restore YugabyteDB instance

Request Body
  • taskInfo object
  • associations object[]
  • subclientId integer
  • applicationId integer
  • clientName string
  • backupsetId integer
  • instanceId integer
  • instanceName string
  • clientId integer
  • _type_ integer
  • task object
  • taskType integer
  • initiatedFrom integer
  • subTasks object[]
  • subTask object
  • subTaskType integer
  • operationType integer
  • options object
  • restoreOptions object
  • commonOptions object
  • preserveLevel integer
  • stripLevelType integer
  • browseOption object
  • commCellId integer
  • backupset object
  • backupsetId integer
  • clientId integer
  • timeRange object
  • destination object
  • noOfStreams integer
  • destClient object
  • clientId integer
  • clientName string
  • destinationInstance object
  • clientId integer
  • clientName string
  • applicationId integer
  • appName string
  • instanceId integer
  • instanceName string
  • fileOption object
  • sourceItem string[]
  • distributedAppsRestoreOptions object
  • distributedRestore boolean
  • isMultiNodeRestore boolean
  • clientType integer
  • dataAccessNodes object
  • dataAccessNodes object[]
  • clientId integer
  • clientName string
  • noSQLGenericRestoreOptions object
  • tableMap object[]
  • fromTable string
  • toTable string
  • yugabyteDBRestoreOptions object
  • kmsConfigName string
  • kmsConfigUUID string
  • qrOption object
  • destAppTypeId integer
  • cloudAppsRestoreOptions object
  • instanceType string
  • commonOpts object
  • notifyUserOnJobCompletion boolean
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "subclientId": 0,

        "applicationId": 0,

        "clientName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "instanceName": "string",

        "clientId": 0,

        "_type_": 0

      }

    ],

    "task": {

      "taskType": 0,

      "initiatedFrom": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 0,

          "operationType": 0

        },

        "options": {

          "restoreOptions": {

            "commonOptions": {

              "preserveLevel": 0,

              "stripLevelType": 0

            },

            "browseOption": {

              "commCellId": 0,

              "backupset": {

                "backupsetId": 0,

                "clientId": 0

              },

              "timeRange": {}

            },

            "destination": {

              "noOfStreams": 0,

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "clientId": 0,

                "clientName": "string",

                "applicationId": 0,

                "appName": "string",

                "instanceId": 0,

                "instanceName": "string"

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "distributedAppsRestoreOptions": {

              "distributedRestore": true,

              "isMultiNodeRestore": true,

              "clientType": 0,

              "dataAccessNodes": {

                "dataAccessNodes": [

                  {

                    "clientId": 0,

                    "clientName": "string"

                  }

                ]

              },

              "noSQLGenericRestoreOptions": {

                "tableMap": [

                  {

                    "fromTable": "string",

                    "toTable": "string"

                  }

                ]

              },

              "yugabyteDBRestoreOptions": {

                "kmsConfigName": "string",

                "kmsConfigUUID": "string"

              }

            },

            "qrOption": {

              "destAppTypeId": 0

            },

            "cloudAppsRestoreOptions": {

              "instanceType": "string"

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://localhost/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "instanceName": "string",
        "clientId": 0,
        "_type_": 0
      }
    ],
    "task": {
      "taskType": 0,
      "initiatedFrom": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "restoreOptions": {
            "commonOptions": {
              "preserveLevel": 0,
              "stripLevelType": 0
            },
            "browseOption": {
              "commCellId": 0,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "string",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 0,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "clientId": 0,
                    "clientName": "string"
                  }
                ]
              },
              "noSQLGenericRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              },
              "yugabyteDBRestoreOptions": {
                "kmsConfigName": "string",
                "kmsConfigUUID": "string"
              }
            },
            "qrOption": {
              "destAppTypeId": 0
            },
            "cloudAppsRestoreOptions": {
              "instanceType": "string"
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'