Get PostgreSQL backupset properties

This operation is used to get backupset properties

Path Parameters

backupsetId string required
backupsetId of the PostgreSQL Backupset

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

backupsetProperties object[]
modifiedTime integer
applicationSize integer
totalBackupSize integer
lastBackupTime integer
firstBackupTime integer
scIdxEnabled integer
sizeOnMedia integer
dedupeRatio integer
securityAssociations object
ownerAssociations object
tagWithCompany object
providerId integer
providerDomainName string
indexSettings object
indexRetCycle integer
overrideIndexPruning integer
indexRetDays integer
isPruningEnabled integer
indexPruningType integer
currentIndexServer object
qualifyingIndexServers object[]
clientId integer
clientName string
content object[]
backupsetSecurity object
associatedUserGroups object[]
userGroupId integer
_type_ integer
userGroupName string
advancedPrivacySettings object
isPasskeyFeatureEnabled boolean
authType integer
isPrivacyFeatureEnabled boolean
passkeySettings object
enableAuthorizeForRestore boolean
expirationTime object
time integer
ownerCapabilities object
planEntity object
planType integer
planName string
Plan name
planSubtype integer
planId integer
Plan ID
commonBackupSet object
dataMigratorILMCLASS boolean
newBackupSetName string
onDemandBackupset boolean
slaStatus integer
isDeleted boolean
isFanInBackupSet boolean
isLegalHoldBackupset boolean
decompressData boolean
isNasTurboBackupSet boolean
isArchivingEnabled boolean
isWildCardContentBackupSet boolean
cDRFSDMBackupset boolean
userDescription string
associatedsubclientPolicy integer
isDedupBackupset boolean
isMyBackupSet boolean
siloCopyId integer
isDefaultBackupSet boolean
isHidden boolean
isMining boolean
isUSeDCForBackup boolean
backupSetEntity object
clientName string
Client Name
instanceName string
Instance Name
displayName string
backupsetId integer
Backupset ID
_type_ integer
instanceId integer
Instance ID
backupsetGUID string
clientId integer
Client ID
appName string
Default value: PostgreSQL
backupsetName string
Backupset Name
applicationId integer
entityInfo object
companyId integer
companyName string
multiCommcellId integer
postGresBackupSetProps object
enableGlobalObjectsBkp boolean
Flag to determine if Global object backup is enabled or not
parallelDumpOpt object
enableParallelDump boolean
Flag to determine if Pa backup is enabled or not
jobs integer
Number of parallel backup jobs
stagingPath string
Staging directory path for Parallel dump backup

{
  "backupsetProperties": [
    {
      "modifiedTime": 0,
      "applicationSize": 0,
      "totalBackupSize": 0,
      "lastBackupTime": 0,
      "firstBackupTime": 0,
      "scIdxEnabled": 0,
      "sizeOnMedia": 0,
      "dedupeRatio": 0,
      "securityAssociations": {
        "ownerAssociations": {},
        "tagWithCompany": {
          "providerId": 0,
          "providerDomainName": "string"
        }
      },
      "indexSettings": {
        "indexRetCycle": 0,
        "overrideIndexPruning": 0,
        "indexRetDays": 0,
        "isPruningEnabled": 0,
        "indexPruningType": 0,
        "currentIndexServer": {},
        "qualifyingIndexServers": [
          {
            "clientId": 0,
            "clientName": "string"
          }
        ]
      },
      "content": [
        {}
      ],
      "backupsetSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "_type_": 0,
            "userGroupName": "string"
          }
        ],
        "advancedPrivacySettings": {
          "isPasskeyFeatureEnabled": true,
          "authType": 0,
          "isPrivacyFeatureEnabled": true,
          "passkeySettings": {
            "enableAuthorizeForRestore": true,
            "expirationTime": {
              "time": 0
            }
          }
        },
        "ownerCapabilities": {}
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "commonBackupSet": {
        "dataMigratorILMCLASS": true,
        "newBackupSetName": "string",
        "onDemandBackupset": true,
        "slaStatus": 0,
        "isDeleted": true,
        "isFanInBackupSet": true,
        "isLegalHoldBackupset": true,
        "decompressData": true,
        "isNasTurboBackupSet": true,
        "isArchivingEnabled": true,
        "isWildCardContentBackupSet": true,
        "cDRFSDMBackupset": true,
        "userDescription": "string",
        "associatedsubclientPolicy": 0,
        "isDedupBackupset": true,
        "isMyBackupSet": true,
        "siloCopyId": 0,
        "isDefaultBackupSet": true,
        "isHidden": true,
        "isMining": true,
        "isUSeDCForBackup": true
      },
      "backupSetEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "instanceId": 0,
        "backupsetGUID": "string",
        "clientId": 0,
        "appName": "PostgreSQL",
        "backupsetName": "string",
        "applicationId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "postGresBackupSetProps": {
        "enableGlobalObjectsBkp": true,
        "parallelDumpOpt": {
          "enableParallelDump": true,
          "jobs": 0,
          "stagingPath": "string"
        }
      }
    }
  ]
}

{
  "backupsetProperties": [
    {
      "modifiedTime": 1702636858,
      "applicationSize": 0,
      "totalBackupSize": 6182016,
      "lastBackupTime": 1711553412,
      "firstBackupTime": 1711380795,
      "scIdxEnabled": 0,
      "sizeOnMedia": 41754586,
      "dedupeRatio": -102,
      "securityAssociations": {
        "ownerAssociations": {},
        "tagWithCompany": {
          "providerId": 0,
          "providerDomainName": "Commcell"
        }
      },
      "indexSettings": {
        "indexRetCycle": -1,
        "overrideIndexPruning": 0,
        "indexPath": "/opt/commvault/MediaAgent/IndexCache/CvIdxDB/7CDF2FEA-1A3C-4009-9D24-0F7FAAF44DEC/7CDF2FEA-1A3C-4009-9D24-0F7FAAF44DEC",
        "indexRetDays": -1,
        "isPruningEnabled": 1,
        "indexPruningType": 0,
        "currentIndexServer": {
          "clientId": 4,
          "clientName": "mysqlperftest"
        },
        "qualifyingIndexServers": [
          {
            "clientId": 4,
            "clientName": "mysqlperftest"
          }
        ]
      },
      "content": [
        {}
      ],
      "backupsetSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 1,
            "_type_": 15,
            "userGroupName": "master"
          }
        ],
        "advancedPrivacySettings": {
          "isPasskeyFeatureEnabled": false,
          "authType": 1,
          "isPrivacyFeatureEnabled": false,
          "passkeySettings": {
            "enableAuthorizeForRestore": false,
            "expirationTime": {
              "time": 0
            }
          }
        },
        "ownerCapabilities": {}
      },
      "planEntity": {
        "planType": 2,
        "planName": "sudheer_plan",
        "planSubtype": 33554437,
        "planId": 5
      },
      "commonBackupSet": {
        "dataMigratorILMCLASS": false,
        "newBackupSetName": "DumpBasedBackupSet",
        "onDemandBackupset": false,
        "slaStatus": 2,
        "isDeleted": false,
        "isFanInBackupSet": false,
        "isLegalHoldBackupset": false,
        "decompressData": false,
        "isNasTurboBackupSet": false,
        "isArchivingEnabled": false,
        "isWildCardContentBackupSet": false,
        "cDRFSDMBackupset": false,
        "userDescription": "",
        "associatedsubclientPolicy": 0,
        "isDedupBackupset": false,
        "isMyBackupSet": false,
        "siloCopyId": 0,
        "isDefaultBackupSet": true,
        "isHidden": false,
        "isMining": false,
        "isUSeDCForBackup": false
      },
      "backupSetEntity": {
        "clientName": "test-ALI-Linux",
        "instanceName": "pgm-6gj1yy9fmpsm49d9[ap-south-1]",
        "displayName": "test-ALI-Linux",
        "backupsetId": 774,
        "_type_": 6,
        "instanceId": 608,
        "backupsetGUID": "7CDF2FEA-1A3C-4009-9D24-0F7FAAF44DEC",
        "clientId": 263,
        "appName": "PostgreSQL",
        "backupsetName": "DumpBasedBackupSet",
        "applicationId": 125,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "postGresBackupSetProps": {
        "enableGlobalObjectsBkp": true,
        "parallelDumpOpt": {
          "enableParallelDump": true,
          "jobs": 5,
          "stagingPath": "/tmp"
        }
      }
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

GET /backupset/:backupsetid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

backupsetId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get PostgreSQL backupset properties​

Authorization

Request

Get PostgreSQL backupset properties