PostgreSQL Restore Operations
Select
SaaS
Customer Managed
This operation is used to run PostgreSQL restores
- application/json
Request Body
taskInfo object
Responses
- 200
- 400
- 401
- 403
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
- taskId integer
- jobIds string[]
JobId of install job triggered
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 2176,
"jobIds": [
"35886"
]
}
Bad Request
- application/json
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "User [Remote User] does not have required capability [In Place Recover] for this subclient and this operation.",
"errorCode": 587204041
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to start backups as no eligible subclients were found. ",
"errorCode": 587207178
}
POST /createtask
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
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": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": 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": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"clientId": 0,
"backupsetId": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"isDefaultBackupSet": true,
"entityName": "string",
"osType": "string"
},
"noOfStreams": 0
},
"oracleOpt": {},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {},
"jobIds": [
{}
],
"impersonation": {},
"postgresRstOption": {
"fsBackupSetRestore": true,
"instanceRestore": true,
"isCloneRestore": true,
"pointInTime": true,
"restoreToSameServer": true,
"startServer": true,
"tableLevelRestore": true,
"refTime": {
"time": 0
},
"fromTime": {
"time": 0
},
"pointOfTime": {
"time": 0
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true,
"prePostOpts": {
"preRecoveryCommand": "string",
"postRecoveryCommand": "string",
"runPostWhenFail": true
}
}
}
}
]
}
}'