Skip to main content

List the databases backed up with a backup job​

Select

Customer Managed

This operation returns list of postgres databases that are backed up as part of a backup job.

Fetch the Job start and end time from Job Summary API.

Request Body
  • opType integer required
  • mode object required
  • mode integer

    Default value: 3

  • options object required
  • tableViewBrowse boolean

    Default value: true

  • hideUserHidden boolean

    Default value: true

  • restoreIndex boolean

    Default value: true

  • timeRange object required
  • toTime integer

    Job end time

  • queries object[] required
  • type integer
  • queryId string

    Default value: 0

  • advOptions object
  • copyPrecedence integer

    Copy precedence to browse

  • paths object[] required
  • path string

    Set to /TblView

  • entity object required
  • instanceName string

    Name of the instance

  • appName string

    Default value: PostgreSQL

  • clientName string

    Name of the cloud account

  • backupsetName string

    Default value: DumpBasedBackupSet

  • subclientName string

    Name of the database group

Responses

OK

Schema
  • browseResponses object[]
  • respType integer
  • workerId string
  • doClientSideSortingAndPaging boolean
  • session object
  • sessionId string
  • browseResult object
  • queryId string
  • dataResultSet object[]
  • displayName string
  • path string
  • name string
  • flags object
  • isPseudo boolean
  • directory boolean
  • isFake boolean
  • snap boolean
  • advancedData object
  • backupJobId integer
  • offset integer
  • archiveGroupId integer
  • archiveFileId integer
  • advConfig object
  • recallRequest boolean
  • browseAdvancedConfigResp object
  • commcellNumber integer
  • browseMetaData object
  • indexing object
POST /dobrowse

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "opType": 0,

  "mode": {

    "mode": 3

  },

  "options": {

    "tableViewBrowse": true,

    "hideUserHidden": true,

    "restoreIndex": true

  },

  "timeRange": {

    "toTime": 0

  },

  "queries": [

    {

      "type": 0,

      "queryId": "0"

    }

  ],

  "advOptions": {

    "copyPrecedence": 0

  },

  "paths": [

    {

      "path": "string"

    }

  ],

  "entity": {

    "instanceName": "string",

    "appName": "PostgreSQL",

    "clientName": "string",

    "backupsetName": "DumpBasedBackupSet",

    "subclientName": "string"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/dobrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "mode": {
    "mode": 3
  },
  "options": {
    "tableViewBrowse": true,
    "hideUserHidden": true,
    "restoreIndex": true
  },
  "timeRange": {
    "toTime": 0
  },
  "queries": [
    {
      "type": 0,
      "queryId": "0"
    }
  ],
  "advOptions": {
    "copyPrecedence": 0
  },
  "paths": [
    {
      "path": "string"
    }
  ],
  "entity": {
    "instanceName": "string",
    "appName": "PostgreSQL",
    "clientName": "string",
    "backupsetName": "DumpBasedBackupSet",
    "subclientName": "string"
  }
}'