Skip to main content

Create MSSQL subclient

Select

SaaS
Customer Managed

This operation creates a MSSQL subclient

Request Body
  • subClientProperties object
  • contentOperationType string

    Default value: ADD

  • planEntity object
  • planId integer required

    ID of the plan to be associated

  • subClientEntity object required
  • clientName string

    Client name

  • instanceName string

    Instance name

  • displayName string

    Display name for the client

  • instanceId integer

    ID of the SQL instance

  • clientId integer

    ID of the client

  • appName string

    Default value: SQL SERVER

  • subclientName string

    Name of the subclient to be created

  • flags object
  • entityInfo object
  • companyId integer

    Company ID. Pass zero if not associated to a company

  • companyName string

    Default value: Commcell

    Company name. Pass 'Commcell' if not associated to a company

  • multiCommcellId integer
  • mssqlSubClientProp object
  • numberOfBackupStreams integer

    Default value: 2

    Number of backup streams

  • sqlSubclientType integer

    Default value: 1

  • blockSize integer

    Default value: 65536

  • numberOfTransactionLogStreams integer

    Default value: 2

  • backupRules integer

    Default value: 3

  • bufferCount integer

    Default value: 20

  • maxTransferSize integer

    Default value: 2097152

  • content object[] required
  • mssqlDbContent object
  • databaseName string

    Name of database to be added

  • commonProperties object
  • enableBackup boolean

    Default value: true

  • description string
  • storageDevice object
Responses

OK

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

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

{
"subClientProperties": {
"contentOperationType": "ADD",
"planEntity": {
"planId": 0
},
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "SQL SERVER",
"subclientName": "string",
"flags": {},
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"mssqlSubClientProp": {
"numberOfBackupStreams": 2,
"sqlSubclientType": 1,
"blockSize": 65536,
"numberOfTransactionLogStreams": 2,
"backupRules": 3,
"bufferCount": 20,
"maxTransferSize": 2097152
},
"content": [
{
"mssqlDbContent": {
"databaseName": "string"
}
}
],
"commonProperties": {
"enableBackup": true,
"description": "string",
"storageDevice": {}
}
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"contentOperationType": "ADD",
"planEntity": {
"planId": 0
},
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "SQL SERVER",
"subclientName": "string",
"flags": {},
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"mssqlSubClientProp": {
"numberOfBackupStreams": 2,
"sqlSubclientType": 1,
"blockSize": 65536,
"numberOfTransactionLogStreams": 2,
"backupRules": 3,
"bufferCount": 20,
"maxTransferSize": 2097152
},
"content": [
{
"mssqlDbContent": {
"databaseName": "string"
}
}
],
"commonProperties": {
"enableBackup": true,
"description": "string",
"storageDevice": {}
}
}
}'