Retrieve to Client (Restore)

This operation restores data obtained through a backup.

More Details

application/json

Request Body

• mode integer
• serviceType integer
• userInfo object

  userGuid string
• advanced object

  restoreDataAndACL boolean

  restoreDeletedFiles boolean
• header object

  destination object

  clientId integer

  clientName string

  inPlace boolean

  destPath string[]

  filePaths string[]

  srcContent object

  subclientId integer

  clientId integer

  instanceId integer

  backupSetId integer

  appTypeId integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• jobId integer

{
  "jobId": 0
}

{
  "jobId": 76278
}

POST /retrievetoclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Retrieve to Client (Restore) - Out Of Place

---

{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/retrieveToClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mode": 0,
  "serviceType": 0,
  "userInfo": {
    "userGuid": "string"
  },
  "advanced": {
    "restoreDataAndACL": true,
    "restoreDeletedFiles": true
  },
  "header": {
    "destination": {
      "clientId": 0,
      "clientName": "string",
      "inPlace": true,
      "destPath": [
        "string"
      ]
    },
    "filePaths": [
      "string"
    ],
    "srcContent": {
      "subclientId": 0,
      "clientId": 0,
      "instanceId": 0,
      "backupSetId": 0,
      "appTypeId": 0
    }
  }
}'