PostgreSQL Backup Operations
This operation is used to run PostgreSQL backups
- application/json
Request Body
taskInfo object
associations object[]
subclientId integerSubclient ID
displayName stringclientId integerClient ID
instanceName stringInstance Name
appName stringDefault value:
PostgreSQL
Aplication Name
applicationId integerApplication ID
clientName stringClient Name
backupsetId integerBackupset ID
instanceId integerInstance ID
subclientName stringSubclient Name
backupsetName stringBackupset Name
task object
taskType integersubTasks object[]
subTask object
subTaskType integeroperationType integeroptions object
backupOpts object
backupLevel stringBackup level to run
incrementalDataWithLogs booleanRun incremental backup with data - For Block level backups
commonOpts object
notifyUserOnJobCompletion booleanadminOpts object
clientInstallOption object
installerOption object
User object
userId integeruserName string
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": 71945,
"jobIds": [
"3587112"
]
}
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 [Data Protection/Management Operations] for this client [pgsql_win] and this operation.",
"errorCode": 587203022
}
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...