PostgreSQL Backup Operations

Select

SaaS

Customer Managed

This operation is used to run PostgreSQL backups

application/json

Request Body

taskInfo object
associations object[]
subclientId integer
Subclient ID
displayName string
clientId integer
Client ID
instanceName string
Instance Name
appName string
Default value: PostgreSQL
Aplication Name
applicationId integer
Application ID
clientName string
Client Name
backupsetId integer
Backupset ID
instanceId integer
Instance ID
subclientName string
Subclient Name
backupsetName string
Backupset Name
task object
taskType integer
subTasks object[]
subTask object
subTaskType integer
operationType integer
options object
backupOpts object
backupLevel string
Backup level to run
incrementalDataWithLogs boolean
Run incremental backup with data - For Block level backups
commonOpts object
notifyUserOnJobCompletion boolean
adminOpts object
clientInstallOption object
installerOption object
User object
userId integer
userName string

Responses

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
}

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Body

Default
PostgreSQL Dump Backup
PostgreSQL FsBased Backup
PostgreSQL Snap/Block level backups

{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "PostgreSQL",
        "applicationId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "incrementalDataWithLogs": true
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

PostgreSQL Backup Operations​

Authorization

Request

PostgreSQL Backup Operations