Skip to main content

Create Subclient​

Select

SaaS
Customer Managed

Create a Subclient for a file server.

Request Body
  • subClientProperties object
  • subClientEntity object required

    Subclient Entity

  • clientId integer required

    Client Id

  • clientName string required

    Client Name

  • applicationId integer required

    Application ID. 33 for FileSystem

  • backupsetId integer required

    BackupSet ID. Retrieve it using Get Backupset API

  • backupsetName string required

    BackupSet Name

  • subclientName string

    Name of the new subclient

  • planEntity object

    Plan association

  • planId integer

    Plan 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 string

    Content path to backup

  • excludePath string

    Content path to exclude from backup

  • includePath string

    Add an exception to a path that should be protected

  • commonProperties object
  • description string

    Description of the subclient

  • enableBackup boolean

    Flag to enable or disable backups

  • numberOfBackupStreams integer

    Default value: 4

    Number of backup streams default

  • prepostProcess object
  • preBackupCommand string

    Path to the script to run before backup

  • postBackupCommand string

    Path to the script to run after backup

  • contentOperationType string

    Possible values: [ADD]

    Content operations type

  • useLocalContent boolean required

    Set to true for override backup content inherited from plan

  • fsSubClientProp object
  • useGlobalFilters string

    Possible values: [ON, OFF, USE_CELL_LEVEL_POLICY]

Responses

OK

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

    Id of the created subclient

  • _type_ string
POST /subclient

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "subClientProperties": {

    "subClientEntity": {

      "clientId": 0,

      "clientName": "string",

      "applicationId": 0,

      "backupsetId": 0,

      "backupsetName": "string",

      "subclientName": "string"

    },

    "planEntity": {

      "planId": 0

    },

    "content": [

      {

        "path": "string",

        "excludePath": "string",

        "includePath": "string"

      }

    ],

    "commonProperties": {

      "description": "string",

      "enableBackup": true,

      "numberOfBackupStreams": 4,

      "prepostProcess": {

        "preBackupCommand": "string",

        "postBackupCommand": "string"

      }

    },

    "contentOperationType": "ADD",

    "useLocalContent": true,

    "fsSubClientProp": {

      "useGlobalFilters": "ON"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "backupsetId": 0,
      "backupsetName": "string",
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "description": "string",
      "enableBackup": true,
      "numberOfBackupStreams": 4,
      "prepostProcess": {
        "preBackupCommand": "string",
        "postBackupCommand": "string"
      }
    },
    "contentOperationType": "ADD",
    "useLocalContent": true,
    "fsSubClientProp": {
      "useGlobalFilters": "ON"
    }
  }
}'