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 cloud account

  instanceName string

  Name of the Instance

  displayName string

  Display name of the cloud account

  _type_ string

  Possible values: [BACKUPSET_ENTITY]

  backupsetName string

  Default value: DumpBasedBackupSet

  applicationId integer

  Default value: 125

  postGresBackupSetProps object

  parallelDumpOpt object

  enableParallelDump boolean

  Default value: false

  To use pg_dump -j option to backup the database

  jobs integer

  No of parallel jobs

  stagingPath string

  staging path on the acce

  enableGlobalObjectsBkp boolean

  Default value: false

  commonBackupSet object

  isDefaultBackupSet boolean

  Default value: true

Responses

• 200
• 401
• 404

---

OK

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": 444,
        "applicationId": 125,
        "backupsetId": 1320,
        "_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
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "No Backup Set is specified.",
  "errorCode": 4
}

POST /backupset/:backupsetid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

backupsetId — path required

Body

• Default
• To enable Global Object backup
• To enable parallel jobs

---

{
  "backupsetProperties": {
    "backupSetEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "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",
      "_type_": "BACKUPSET_ENTITY",
      "backupsetName": "DumpBasedBackupSet",
      "applicationId": 125
    },
    "postGresBackupSetProps": {
      "parallelDumpOpt": {
        "enableParallelDump": false,
        "jobs": 0,
        "stagingPath": "string"
      },
      "enableGlobalObjectsBkp": false
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    }
  }
}'