Skip to main content

Update DB2 Backupset Properties​

Select

SaaS
Customer Managed

This operation is used to update the DB2 backupset properties

Path Parameters
  • BackupsetID integer required

    ID of the backupset

Request Body
  • backupsetProperties object required
  • backupSetEntity object
  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer

    ID of the backupset for which properties needs to be modified

  • _type_ string
  • instanceId integer

    ID of the instance for which backupset belongs to

  • backupsetGUID string
  • clientId integer

    ID of the client for which backupset belongs to

  • appName string

    DB2

  • backupsetName string
  • applicationId integer

    Possible values: [62, 37]

    application ID for DB2 Unix is 62 and application ID for DB2 windows is 37

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • db2BackupSet object

    pass this object if you want to connect to DB2 backupset as a different user

  • db2SqlConnectInfo object

    Pass this object if you want to connect to DB2 Backupset as a different user

  • userName string

    Username of new user

  • savedCredential object
  • password string

    Password in base64 encoding

  • useSQLConnect boolean

    True if you want to connect to DB2 backupset as a different user

  • commonBackupSet object
  • isDefaultBackupSet boolean
  • planEntity object

    pass this object if you want to update the plan of backupset

  • planId integer

    New plan ID

  • planName string

    Plan name of the new plan

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • errorCode integer
  • entity object

    Common backupset properties for which properties have been modified

  • clientId integer
  • applicationId integer
  • backupsetId integer
  • _type_ integer
POST /backupset/:backupsetid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "backupsetProperties": {

    "backupSetEntity": {

      "clientName": "string",

      "instanceName": "string",

      "displayName": "string",

      "backupsetId": 0,

      "_type_": "string",

      "instanceId": 0,

      "backupsetGUID": "string",

      "clientId": 0,

      "appName": "string",

      "backupsetName": "string",

      "applicationId": 62,

      "entityInfo": {

        "companyId": 0,

        "companyName": "string",

        "multiCommcellId": 0

      }

    },

    "db2BackupSet": {

      "db2SqlConnectInfo": {

        "userName": "string",

        "savedCredential": {},

        "password": "string"

      },

      "useSQLConnect": true

    },

    "commonBackupSet": {

      "isDefaultBackupSet": true

    },

    "planEntity": {

      "planId": 0,

      "planName": "string"

    }

  }

}

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": "string",
      "backupsetName": "string",
      "applicationId": 62,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      }
    },
    "db2BackupSet": {
      "db2SqlConnectInfo": {
        "userName": "string",
        "savedCredential": {},
        "password": "string"
      },
      "useSQLConnect": true
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    }
  }
}'