Modify MSSQL subclient properties

Select

SaaS

Customer Managed

This operation modifies the properties of a MSSQL subclient

Path Parameters

subclientId string required
Id of the subclient

application/json

Request Body

subClientProperties object
planEntity object
planId integer
mssqlSubClientProp object
subclientRecoveryType integer
numberOfBackupStreams integer
numberOfTransactionLogStreams integer
useBlockLevelBackupWithOptimizedRecovery boolean
sqlSubclientType string
blockSize integer
backupRules string
bufferCount integer
disableAutoDiscovery boolean
maxTransferSize integer
disableLogConsistencyCheck boolean
content object[]
mssqlDbContent object
databaseName string
commonProperties object
enableBackupAfterDelay boolean
enableBackup boolean
encryptionFlag integer
description string
allowMultipleDataReaders boolean
excludeFromSLA boolean
security object
associatedUserGroups object[]
userGroupId integer
userGroupName string
enableBackupAtDateTime object
TimeZoneID integer
time integer
prepostProcess object
runPostBackup integer
runAs integer
postBackupCommand string
preBackupCommand string
prepostUserName object
userName string
prepostCredentialinfo object
credentialId integer
credentialName string
storageDevice object
networkAgents integer
applicableReadSize integer
softwareCompression integer
overrideDataPath boolean
throttleNetworkBandwidth integer
dataPathOperationType integer
dataBackupStoragePolicy object
storagePolicyName string
deDuplicationOptions object
enableDeduplication boolean
generateSignature integer
logBackupStoragePolicy object
storagePolicyName string

Responses

application/json

Schema
Example (from schema)
Example

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

Bad Request

application/json

Schema
Example

Schema

string

Request body is empty or format is invalid.

Unauthorized

application/json

Schema
Example (from schema)
Example

Schema

errorMessage string
errorCode integer

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

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

Unprocessable Entity (WebDAV)

application/json

Schema
Example (from schema)
Database already exists in content

Schema

errorMessage string
errorCode integer

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

{
  "errorMessage": "Same content[vislxe1] is available in another subclient[71143][SubclientExample]. Please delete the content[vislxe1] from subclient[SubclientExample]",
  "errorCode": 17
}

POST /subclient/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

subclientId — path required

Body

Default
Add databases
Delete databases

{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planId": 0
    },
    "mssqlSubClientProp": {
      "subclientRecoveryType": 0,
      "numberOfBackupStreams": 0,
      "numberOfTransactionLogStreams": 0,
      "useBlockLevelBackupWithOptimizedRecovery": true,
      "sqlSubclientType": "string",
      "blockSize": 0,
      "backupRules": "string",
      "bufferCount": 0,
      "disableAutoDiscovery": true,
      "maxTransferSize": 0,
      "disableLogConsistencyCheck": true
    },
    "content": [
      {
        "mssqlDbContent": {
          "databaseName": "string"
        }
      }
    ],
    "commonProperties": {
      "enableBackupAfterDelay": true,
      "enableBackup": true,
      "encryptionFlag": 0,
      "description": "string",
      "allowMultipleDataReaders": true,
      "excludeFromSLA": true,
      "security": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ]
      },
      "enableBackupAtDateTime": {
        "TimeZoneID": 0,
        "time": 0
      },
      "prepostProcess": {
        "runPostBackup": 0,
        "runAs": 0,
        "postBackupCommand": "string",
        "preBackupCommand": "string",
        "prepostUserName": {
          "userName": "string"
        }
      },
      "prepostCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      },
      "storageDevice": {
        "networkAgents": 0,
        "applicableReadSize": 0,
        "softwareCompression": 0,
        "overrideDataPath": true,
        "throttleNetworkBandwidth": 0,
        "dataPathOperationType": 0,
        "dataBackupStoragePolicy": {
          "storagePolicyName": "string"
        },
        "deDuplicationOptions": {
          "enableDeduplication": true,
          "generateSignature": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyName": "string"
        }
      }
    }
  }
}'

Modify MSSQL subclient properties​

Authorization

Request

Modify MSSQL subclient properties