Update Subclient Properties By Name

Select

SaaS

Customer Managed

This operation updates the properties associated with a subclient.

Path Parameters

• clientname string required

  Name of the client

• appname string required

  Name of the application

• backupsetname string required

  Name of the backup set

• subclientname string required

  Name of the subclient

application/json

Request Body

• subClientProperties object

  fsIncludeFilterOperationType integer

  The type of operation to update the inclusion filters in the file system subclient backup job.

  fsExcludeFilterOperationType integer

  fsContentOperationType integer

  useLocalContent boolean

  fsSubClientProp object

  useGlobalFilters integer

  customSubclientContentFlags integer

  backupSystemState boolean

  customSubclientFlag boolean

  openvmsBackupDate boolean

  includePolicyFilters boolean

  content object[]

  path string

  excludePath string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string"
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": ""
    }
  ]
}

POST /Subclient/byName(clientName=':clientname',appName=':appname',backupsetName=':backupsetname',subclientName=':subclientname')    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientname — path required

appname — path required

backupsetname — path required

subclientname — path required

Body

• Default
• Subclient Properties - Backup Content Derived From a Plan
• Subclient Properties - Disable Encryption
• Subclient Properties - Backup Content Override From a Plan
• Subclient Properties - Disable Extend Storage Policy Retention
• Subclient Properties - Disable Backup
• Subclient Properties - For MySQL
• Subclient Properties - For Oracle
• Subclient Properties - For Sybase
• Subclient Properties - For PostgreSQL

---

{
  "subClientProperties": {
    "fsIncludeFilterOperationType": 0,
    "fsExcludeFilterOperationType": 0,
    "fsContentOperationType": 0,
    "useLocalContent": true,
    "fsSubClientProp": {
      "useGlobalFilters": 0,
      "customSubclientContentFlags": 0,
      "backupSystemState": true,
      "customSubclientFlag": true,
      "openvmsBackupDate": true,
      "includePolicyFilters": true
    },
    "content": [
      {
        "path": "string",
        "excludePath": "string"
      }
    ]
  }
}

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

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

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

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

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

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

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