Skip to main content

PostgreSQL Restore Operations

Select

SaaS
Customer Managed

This operation is used to run PostgreSQL restores

Request Body
  • taskInfo object
  • associations object[]
  • clientName string

    Client Name

  • instanceName string

    Instance Name

  • displayName string
  • backupsetId integer

    Backupset ID

  • _type_ string
  • instanceId integer

    Instance ID

  • backupsetGUID string
  • clientId integer

    Client ID

  • appName string

    Default value: PostgreSQL

    Application Name

  • backupsetName string

    Backupset Name

  • applicationId integer

    Default value: 125

    Application ID

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string
  • osType string
  • task object
  • taskType integer
  • initiatedFrom integer
  • subTasks object[]
  • subTask object
  • subTaskType integer
  • operationType integer
  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • backupset object
  • clientId integer
  • backupsetId integer
  • destination object
  • destClient object

    Destination CLient Information

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ integer
  • instanceId integer
  • backupsetGUID string
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string
  • osType string
  • destinationInstance object

    Destination instance information

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ integer
  • instanceId integer
  • backupsetGUID string
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string
  • osType string
  • noOfStreams integer

    Number of streams to be used for restore

  • oracleOpt object
  • fileOption object
  • sourceItem string[]

    Items to restore

  • commonOptions object
  • jobIds object[]
  • impersonation object
  • postgresRstOption object
  • fsBackupSetRestore boolean

    Flag to determine if the restore is run for fsbased backupset

  • instanceRestore boolean
  • isCloneRestore boolean

    Flag to determine clone restore

  • pointInTime boolean

    Flag to mention PIT restore

  • restoreToSameServer boolean
  • startServer boolean

    Flag to detrmine if server needs to be started after restore or not

  • tableLevelRestore boolean

    Flag to determine

  • refTime object
  • time integer
  • fromTime object
  • time integer
  • pointOfTime object
  • time integer
  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Flag to send email after job completion

  • prePostOpts object
  • preRecoveryCommand string
  • postRecoveryCommand string
  • runPostWhenFail boolean
Responses

OK

Response Headers

    Schema
    • taskId integer
    • jobIds string[]

      JobId of install job triggered

    POST /createtask    

    Authorization

    type: apiKeyname: Authtokenin: header

    Request

    Click Edit to configure Base URL
    https://CommandCenterHostName/commandcenter/api
    token
    Body

    {
    "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
    }
    }
    }
    }
    ]
    }
    }'