Modify Subclient

Select

SaaS

Customer Managed

Modifies the properties of subclient (content group)

Path Parameters

subclientID string required
ID of the subclient which needs to be modified

application/json

Request Body

This request enables modifications to the subclient (content group) name, the number of streams, ACL backup settings (enable/disable), backup job start time, and the assigned plan.

newName string
name of the content group
subClientProperties object
commonProperties object
numberOfBackupStreams integer
number of streams to be configured for backups
jobStartTime integer
The jobStartTime represents the number of seconds since midnight (00:00:00 UTC) of the same day. jobStartTime=(Hour×3600)+(Minutes×60)+Seconds Eg - 9:00 PM → 75600 seconds
planEntity object
planName string
name of the plan
planId integer
ID of the plan
cloudAppsSubClientProp object
collectACL boolean
Set to True/False to enable/disable backup of ACLs.
instanceType string
Possible values: [AMAZON_S3, ALIBABA_OSS, GOOGLE_CLOUD]
Type of the object storage instance.

Responses

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": ""
    }
  ]
}

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

{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "newName": "string",
  "subClientProperties": {
    "commonProperties": {
      "numberOfBackupStreams": 0,
      "jobStartTime": 0
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "cloudAppsSubClientProp": {
      "collectACL": true,
      "instanceType": "AMAZON_S3"
    }
  }
}'

Modify Subclient​

Request

Modify Subclient