PostgreSQL Restore Operations
Select
SaaS
Customer Managed
This operation is used to run PostgreSQL restores
- application/json
Request Body
taskInfo object
associations object[]
clientName stringClient Name
instanceName stringInstance Name
displayName stringbackupsetId integerBackupset ID
_type_ stringinstanceId integerInstance ID
backupsetGUID stringclientId integerClient ID
appName stringDefault value:
PostgreSQL
Application Name
backupsetName stringBackupset Name
applicationId integerDefault value:
125
Application ID
entityInfo object
companyId integercompanyName stringmultiCommcellId integerisDefaultBackupSet booleanentityName stringosType stringtask object
taskType integerinitiatedFrom integersubTasks object[]
subTask object
subTaskType integeroperationType integeroptions object
restoreOptions object
browseOption object
commCellId integerbackupset object
clientId integerbackupsetId integerdestination object
destClient object
Destination CLient Information
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integerinstanceId integerbackupsetGUID stringclientId integerappName stringbackupsetName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerisDefaultBackupSet booleanentityName stringosType stringdestinationInstance object
Destination instance information
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integerinstanceId integerbackupsetGUID stringclientId integerappName stringbackupsetName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerisDefaultBackupSet booleanentityName stringosType stringnoOfStreams integerNumber of streams to be used for restore
oracleOpt objectfileOption object
sourceItem string[]Items to restore
commonOptions objectjobIds object[]impersonation objectpostgresRstOption object
fsBackupSetRestore booleanFlag to determine if the restore is run for fsbased backupset
instanceRestore booleanisCloneRestore booleanFlag to determine clone restore
pointInTime booleanFlag to mention PIT restore
restoreToSameServer booleanstartServer booleanFlag to detrmine if server needs to be started after restore or not
tableLevelRestore booleanFlag to determine
refTime object
time integerfromTime object
time integerpointOfTime object
time integercommonOpts object
notifyUserOnJobCompletion booleanFlag to send email after job completion
prePostOpts object
preRecoveryCommand stringpostRecoveryCommand stringrunPostWhenFail boolean
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
}
Loading...