Restoring a couchbase instance
Select
SaaS
Customer Managed
This API is used to restore couchbase instance
- application/json
Request Body
taskInfo object
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 59,
"jobIds": [
"33"
]
}
POST /createtask
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"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": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"instanceId": 0,
"clientId": 0
}
],
"task": {
"taskType": 1,
"initiatedFrom": 1
},
"subTasks": [
{
"subTask": {
"subTaskType": 3,
"operationType": 1001
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 2,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"timeRange": {}
},
"commonOptions": {
"unconditionalOverwrite": true,
"isFromBrowseBackup": true,
"preserveLevel": 1,
"stripLevelType": 0,
"overwriteFiles": true
},
"distributedAppsRestoreOptions": {
"distributedRestore": true,
"isMultiNodeRestore": true,
"clientType": 29,
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string"
}
]
},
"stageFreeRestoreOptions": {
"restoreItems": [
{
"srcEntityName": "string",
"destEntityName": "string"
}
]
}
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"clientId": 0,
"clientName": "string",
"applicationId": 64,
"appName": "string",
"instanceId": 0,
"instanceName": "string"
}
},
"fileOption": {
"sourceItem": [
"string"
]
},
"qrOption": {
"destAppTypeId": 64
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'