Create Subclient
Create a Subclient for a file server.
- application/json
Request Body
subClientProperties object
subClientEntity object required
Subclient Entity
clientId integer requiredClient Id
clientName string requiredClient Name
applicationId integer requiredApplication ID. 33 for FileSystem
backupsetId integer requiredBackupSet ID. Retrieve it using Get Backupset API
backupsetName string requiredBackupSet Name
subclientName stringName of the new subclient
planEntity object
Plan association
planId integerPlan ID
content object[]
Array of paths and exclude paths to override backup content. path, excludePath, includePath are mutually exclusive . See examples for more info
path stringContent path to backup
excludePath stringContent path to exclude from backup
includePath stringAdd an exception to a path that should be protected
commonProperties object
description stringDescription of the subclient
enableBackup booleanFlag to enable or disable backups
numberOfBackupStreams integerDefault value:
4
Number of backup streams default
prepostProcess object
preBackupCommand stringPath to the script to run before backup
postBackupCommand stringPath to the script to run after backup
contentOperationType stringPossible values: [
ADD
]Content operations type
useLocalContent boolean requiredSet to true for override backup content inherited from plan
fsSubClientProp object
useGlobalFilters stringPossible values: [
ON
,OFF
,USE_CELL_LEVEL_POLICY
]
- 200
- 422
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerId of the created subclient
_type_ string
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"_type_": "string"
}
}
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 47,
"_type_": "ROOT_ENTITY"
}
}
}
Unprocessable Entity (WebDAV)
- application/json
- Schema
- Example (from schema)
- Duplicate content in the subclient
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Unable to add content; duplicate content is available for the same client.",
"errorCode": 17
}