Skip to main content

Perform Restore - NAS​

Restore the NAS server from the backups

Request Body
  • taskInfo object
  • task object
  • taskType string

    Possible values: [IMMEDIATE, SCHEDULE, SAVED_REPORT, SCHEDULE_POLICY]

  • associations object[]
  • subclientId integer required

    ID of the Default NAS server client

  • clientId integer required

    Client ID of NAS

  • applicationId integer required

    Default value: 13

    13 for NAS

  • backupsetId integer required

    ID of the default backuset

  • instanceId integer required

    Instance Id of the NAS (Fetch this from Get subclient API

  • _type_ string
  • subTasks object[] required
  • subTask object required
  • subTaskType string

    Default value: RESTORE

  • operationType string

    Default value: RESTORE

  • options object
  • restoreOptions object required
  • browseOption object required
  • commCellId integer required

    Default value: 2

    Commcell ID is 2

  • backupset object required
  • backupsetId integer required

    Id of the backupset

  • clientId integer required

    Client ID

  • timeRange object required
  • toTime integer

    Get this value from the backup browse

  • browseJobCommCellId integer

    Default value: 2

  • destination object
  • destClient object

    Destination client details where you want to restore. Use GET /Client to get all cients

  • clientId integer
  • clientName string
  • destAppId integer

    Default value: 13

    13 for the NAS

  • inPlace boolean
  • fileOption object
  • sourceItem string[]

    source item to restore pick from the browse API response

  • impersonation object
  • commonOptions object
  • overwriteFiles boolean

    Default value: false

  • unconditionalOverwrite boolean

    Default value: true

  • restoreACLs boolean

    Default value: true

  • isFromBrowseBackup boolean

    Default value: true

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
{

  "taskInfo": {

    "task": {

      "taskType": "IMMEDIATE"

    },

    "associations": [

      {

        "subclientId": 0,

        "clientId": 0,

        "applicationId": 13,

        "backupsetId": 0,

        "instanceId": 0,

        "_type_": "string"

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 2,

              "backupset": {

                "backupsetId": 0,

                "clientId": 0

              },

              "timeRange": {

                "toTime": 0

              },

              "browseJobCommCellId": 2

            },

            "destination": {

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destAppId": 13,

              "inPlace": true

            },

            "fileOption": {

              "sourceItem": [

                "/nac6vs1/Mounika1/hosts"

              ]

            },

            "impersonation": {},

            "commonOptions": {

              "overwriteFiles": false,

              "unconditionalOverwrite": true,

              "restoreACLs": true,

              "isFromBrowseBackup": true

            }

          }

        }

      }

    ]

  }

}

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": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "subclientId": 0,
        "clientId": 0,
        "applicationId": 13,
        "backupsetId": 0,
        "instanceId": 0,
        "_type_": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {
                "toTime": 0
              },
              "browseJobCommCellId": 2
            },
            "destination": {
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destAppId": 13,
              "inPlace": true
            },
            "fileOption": {
              "sourceItem": [
                "/nac6vs1/Mounika1/hosts"
              ]
            },
            "impersonation": {},
            "commonOptions": {
              "overwriteFiles": false,
              "unconditionalOverwrite": true,
              "restoreACLs": true,
              "isFromBrowseBackup": true
            }
          }
        }
      }
    ]
  }
}'