Edit Subclient Backup Content

Select

SaaS

Customer Managed

Modifies the backup content of a subclient (content group)

Path Parameters

• subclientId integer required

  ID of the subclient on which the content needs to be modified

application/json

Request Body

This request modifies the subclient content by adding an array of paths while allowing configuration of exclusions and exceptions as needed.

• subClientProperties object

  cloudAppsSubClientProp object

  instanceType string required

  Possible values: [AZURE_BLOB, AZURE_DATA_LAKE, AMAZON_S3, GOOGLE_CLOUD, ALIBABA_OSS, ORACLE_STORAGE_SERVCE, IBM_COS]

  Type of the object storage instance

  objectStorageSubclient object

  Exclusive to tag-based content configured for subclient.

  objectStorageTagFilter object

  tagFilters object[]

  A list of filtering rules based on object tags

  ruleItemType integer required

  Default value: 2

  Specifies the type of rule being applied. This is required only when configuring tag-based backups.

  rules object[]

  A list of key-value pairs defining the tags used for filtering objects.

  name string

  The key of the tag to filter by.

  value string

  The corresponding value of the tag.

  content object

  Array of objects representing the paths included in the subclient configuration. Each object specifies a path for backup, exclusion, or exception. . See examples for more info

  path string required

  Defines a path to be included in the backup.

  excludePath string

  Content path to exclude from backup.

  includePath string

  Add an exception to a path that should be protected.

  fsContentOperationType string required

  Default value: OVERWRITE

  Defines the operation type for content modification.

  fsExcludeFilterOperationType string

  Default value: CLEAR

  Configures exclusions for the subclient. Set to OVERWRITEto apply changes.

  fsIncludeFilterOperationType string

  Default value: CLEAR

  Configures exceptions for the subclient. Set to OVERWRITEto apply changes.

Responses

• 200
• 404

---

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": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Failed to get any subclient for given association. Check if it is valid",
  "errorCode": 4
}

POST /subclient/:subclientid    

Request

Click Edit to configure Base URL

https://CommandCenterHostName/webconsole/api

subclientId — path required

Body

• Default
• Modify backup content with exclusions and exceptions
• Modify backup content
• Modify tag-based backup content

---

{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "AZURE_BLOB",
      "objectStorageSubclient": {
        "objectStorageTagFilter": {
          "tagFilters": [
            {
              "ruleItemType": 2,
              "rules": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "content": {
      "path": "string",
      "excludePath": "string",
      "includePath": "string"
    },
    "fsContentOperationType": "OVERWRITE",
    "fsExcludeFilterOperationType": "CLEAR",
    "fsIncludeFilterOperationType": "CLEAR"
  }
}'