Modify PostgreSQL Dumpbased backupset

This operation is used to modify PostgreSQL DumpBased Backupset.

Path Parameters

backupsetId string required
backupsetId of the PostgreSQL Backupset

application/json

Request Body

backupsetProperties object
backupSetEntity object
clientName string
Name of the client
instanceName string
Name of the Instance
displayName string
backupsetId integer
Backupset ID
_type_ string
instanceId integer
backupsetGUID string
clientId integer
appName string
Default value: PostgreSQL
backupsetName string
applicationId integer
Default value: 125
entityInfo object
companyId integer
companyName string
multiCommcellId integer
postGresBackupSetProps object
parallelDumpOpt object
enableParallelDump boolean
jobs integer
stagingPath string
enableGlobalObjectsBkp boolean
commonBackupSet object
isDefaultBackupSet boolean

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
errorCode integer
entity object
clientId integer
applicationId integer
Default value: 125
backupsetId integer
_type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 0,
        "applicationId": 125,
        "backupsetId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 4,
        "applicationId": 125,
        "backupsetId": 11461,
        "_type_": 0
      }
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

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

POST /backupset/:backupsetid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

backupsetId — path required

Body

Default
To enable Global Object backup
To enable parallel jobs

{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetProperties": {
    "backupSetEntity": {
      "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
      }
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": true,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'

Modify PostgreSQL Dumpbased backupset​

Authorization

Request

Modify PostgreSQL Dumpbased backupset