Skip to main content

Create Task (Restore)​

This operation restores virtual server data obtained through a backup.

More Details

Request Body required
  • taskInfo object
  • associations object[]
  • appName string
  • backupsetName string
  • clientName string
  • clientSidePackage boolean
  • consumeLicense boolean
  • instanceName string
  • subclientName string
  • type integer
  • subTasks object[]
  • options object
  • adminOpts object
  • updateOption object
  • invokeLevel integer
  • restoreOptions object
  • browseOption object
  • backupset object
  • appName string
  • backupsetName string
  • clientName string
  • instanceName string
  • commCellId integer
  • fromTime integer
  • listMedia boolean
  • mediaOption object
  • copyPrecedence object
  • copyPrecedence integer
  • noImage boolean
  • toTime integer
  • useExactIndex boolean
  • commonOptions object
  • clusterDBBackedup boolean
  • detectRegularExpression boolean
  • isFromBrowseBackup boolean
  • overwriteFiles boolean
  • preserveLevel integer
  • restoreACLs boolean
  • stripLevel integer
  • stripLevelType integer
  • unconditionalOverwrite boolean
  • destination object
  • destClient object
  • clientName string
  • commCellName string
  • inPlace boolean
  • isLegalHold boolean
  • fileOption object
  • sourceItem string[]
  • restoreACLsType integer
  • virtualServerRstOption object
  • diskLevelVMRestoreOption object
  • advancedRestoreOptions object[]
  • Datastore string
  • disks object[]
  • Datastore string
  • name string
  • esxHost string
  • guid string
  • name string
  • newName string
  • resourcePoolPath string
  • esxServerName string
  • passUnconditionalOverride boolean
  • powerOnVmAfterRestore boolean
  • isDiskBrowse boolean
  • userPassword object
  • userName string
  • viewType integer
  • volumeRstOption object
  • volumeLeveRestore boolean
  • volumeLevelRestoreType integer
  • subTask object
  • operationType integer
  • subTaskName string
  • subTaskType integer
  • task object
  • initiatedFrom integer
  • policyType integer
  • taskFlags object
  • disabled boolean
  • taskType integer
Responses

OK

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

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body required
{

  "taskInfo": {

    "associations": [

      {

        "appName": "string",

        "backupsetName": "string",

        "clientName": "string",

        "clientSidePackage": true,

        "consumeLicense": true,

        "instanceName": "string",

        "subclientName": "string",

        "type": 0

      }

    ],

    "subTasks": [

      {

        "options": {

          "adminOpts": {

            "updateOption": {

              "invokeLevel": 0

            }

          },

          "restoreOptions": {

            "browseOption": {

              "backupset": {

                "appName": "string",

                "backupsetName": "string",

                "clientName": "string",

                "instanceName": "string"

              },

              "commCellId": 0,

              "fromTime": 0,

              "listMedia": true,

              "mediaOption": {

                "copyPrecedence": {

                  "copyPrecedence": 0

                }

              },

              "noImage": true,

              "toTime": 0,

              "useExactIndex": true

            },

            "commonOptions": {

              "clusterDBBackedup": true,

              "detectRegularExpression": true,

              "isFromBrowseBackup": true,

              "overwriteFiles": true,

              "preserveLevel": 0,

              "restoreACLs": true,

              "stripLevel": 0,

              "stripLevelType": 0,

              "unconditionalOverwrite": true

            },

            "destination": {

              "destClient": {

                "clientName": "string",

                "commCellName": "string"

              },

              "inPlace": true,

              "isLegalHold": true

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "restoreACLsType": 0,

            "virtualServerRstOption": {

              "diskLevelVMRestoreOption": {

                "advancedRestoreOptions": [

                  {

                    "Datastore": "string",

                    "disks": [

                      {

                        "Datastore": "string",

                        "name": "string"

                      }

                    ],

                    "esxHost": "string",

                    "guid": "string",

                    "name": "string",

                    "newName": "string",

                    "resourcePoolPath": "string"

                  }

                ],

                "esxServerName": "string",

                "passUnconditionalOverride": true,

                "powerOnVmAfterRestore": true

              },

              "isDiskBrowse": true,

              "userPassword": {

                "userName": "string"

              },

              "viewType": 0

            },

            "volumeRstOption": {

              "volumeLeveRestore": true,

              "volumeLevelRestoreType": 0

            }

          }

        },

        "subTask": {

          "operationType": 0,

          "subTaskName": "string",

          "subTaskType": 0

        }

      }

    ],

    "task": {

      "initiatedFrom": 0,

      "policyType": 0,

      "taskFlags": {

        "disabled": true

      },

      "taskType": 0

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "appName": "string",
        "backupsetName": "string",
        "clientName": "string",
        "clientSidePackage": true,
        "consumeLicense": true,
        "instanceName": "string",
        "subclientName": "string",
        "type": 0
      }
    ],
    "subTasks": [
      {
        "options": {
          "adminOpts": {
            "updateOption": {
              "invokeLevel": 0
            }
          },
          "restoreOptions": {
            "browseOption": {
              "backupset": {
                "appName": "string",
                "backupsetName": "string",
                "clientName": "string",
                "instanceName": "string"
              },
              "commCellId": 0,
              "fromTime": 0,
              "listMedia": true,
              "mediaOption": {
                "copyPrecedence": {
                  "copyPrecedence": 0
                }
              },
              "noImage": true,
              "toTime": 0,
              "useExactIndex": true
            },
            "commonOptions": {
              "clusterDBBackedup": true,
              "detectRegularExpression": true,
              "isFromBrowseBackup": true,
              "overwriteFiles": true,
              "preserveLevel": 0,
              "restoreACLs": true,
              "stripLevel": 0,
              "stripLevelType": 0,
              "unconditionalOverwrite": true
            },
            "destination": {
              "destClient": {
                "clientName": "string",
                "commCellName": "string"
              },
              "inPlace": true,
              "isLegalHold": true
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "restoreACLsType": 0,
            "virtualServerRstOption": {
              "diskLevelVMRestoreOption": {
                "advancedRestoreOptions": [
                  {
                    "Datastore": "string",
                    "disks": [
                      {
                        "Datastore": "string",
                        "name": "string"
                      }
                    ],
                    "esxHost": "string",
                    "guid": "string",
                    "name": "string",
                    "newName": "string",
                    "resourcePoolPath": "string"
                  }
                ],
                "esxServerName": "string",
                "passUnconditionalOverride": true,
                "powerOnVmAfterRestore": true
              },
              "isDiskBrowse": true,
              "userPassword": {
                "userName": "string"
              },
              "viewType": 0
            },
            "volumeRstOption": {
              "volumeLeveRestore": true,
              "volumeLevelRestoreType": 0
            }
          }
        },
        "subTask": {
          "operationType": 0,
          "subTaskName": "string",
          "subTaskType": 0
        }
      }
    ],
    "task": {
      "initiatedFrom": 0,
      "policyType": 0,
      "taskFlags": {
        "disabled": true
      },
      "taskType": 0
    }
  }
}'