Skip to main content

Get Subclient Properties​

Select

SaaS
Customer Managed

This operation returns the properties associated with a subclient.

More Details

Path Parameters
  • subclientId string required
Responses

OK

Schema
  • subClientProperties object[]
  • hcSubclientProp object
  • impersonateUser object
  • userName string
  • proxyClient object
  • subClientEntity object
  • clientName string
  • instanceName string
  • backupsetId integer
  • _type_ integer
  • instanceId integer
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • dfsSubclientProp object
  • distributedDataAccessNodes object
  • fsSubClientProp object
  • catalogACL boolean
  • syncQueue string
  • archiverRetention boolean
  • blockLevelSPOSBackup integer
  • backupPrivateAuthority boolean
  • enableFolderLevelMultiThread boolean
  • bigFileSize integer
  • backupAsObjects boolean
  • useGlobalFilters integer
  • backupFilesQualifiedForArchive boolean
  • syncAllLibForBackup boolean
  • backupFileTimeZoneName string
  • vssOptions integer
  • useVSSForSystemState boolean
  • olderFileVersionsMode integer
  • blockLevelBackup integer
  • backupRetentionMode integer
  • deletePSTFileOnly boolean
  • txtlibSyncCheckPoint string
  • customSubclientContentFlags integer
  • saveAccessPath string
  • unixCtime boolean
  • keepVersions integer
  • backupRetention boolean
  • scanOption integer
  • backupFilesAsExtents boolean
  • backupSystemState boolean
  • afterDeletionKeepItemsForNDays integer
  • saveWhileActiveOpt string
  • useIncremental boolean
  • unixMtime boolean
  • useVssForAllFilesOptions integer
  • runTrueUpJobAfterJobsForFS integer
  • catalogAdditional boolean
  • oneTouchSubclient boolean
  • extendRetentionForNDays integer
  • customSubclientFlag boolean
  • isTrueUpOptionEnabledForFS boolean
  • enableOCSBackupOnSubclient boolean
  • folderLevelThreadCount integer
  • targetReleaseForBackupData string
  • retentionPolicy integer
  • backupSaveFileData boolean
  • activeWaitTime integer
  • archiverRetentionMode integer
  • backupFilesOnOrAfter boolean
  • extentSize integer
  • enableOnePass boolean
  • runTrueUpJobAfterDaysForFS integer
  • useVSS boolean
  • isSynthfullRunAfterOnePassEnabledOnSubclient boolean
  • useSCPFilters boolean
  • extendStoragePolicyRetention boolean
  • backupSpooledFileData boolean
  • backupQueueData boolean
  • oneTouchServerDirectory string
  • keepOlderVersionsForNDays integer
  • ibmiSubclientprop object
  • SRBootServerDir string
  • backupConfiguration object
  • oneTouchServer object
  • clientId integer
  • _type_ integer
  • backupFilesOnOrAfterDate object
  • _type_ integer
  • diskCleanupRules object
  • stubPruningOptions integer
  • afterArchivingRule integer
  • stubRetentionDaysOld integer
  • enableRedundancyForDataBackedup boolean
  • patternMatch string
  • rulesToSatisfy integer
  • entityMatch string
  • ocsUserName object
  • userName string
  • planEntity object
  • content object[]
  • path string
  • commonProperties object
  • encryptionFlag integer
  • numberOfBackupStreams integer
  • nextBackupTime integer
  • isTurboSubclient boolean
  • isKeepItemPastExpiryTime boolean
  • onDemandSubClient boolean
  • totalBackupSize integer
  • lastBackupTime integer
  • indexingBackupSubClient boolean
  • description string
  • subClientPropertiesFlag integer
  • lastBackupSize integer
  • onlyBackupQualifiedArchivingFiles boolean
  • allowVssForSnapbackup boolean
  • enableBackupAfterDelay boolean
  • expandSymbolicLinks boolean
  • enableAppleDoubleSupport boolean
  • allowMultipleDataReaders boolean
  • indexCycleToEveryBackupJobs integer
  • excludeFromSLA boolean
  • readBuffersize integer
  • enableBackup boolean
  • securityAssociations object
  • ownerAssociations object
  • enableBackupAtDateTime object
  • TimeZoneID integer
  • time integer
  • turboNASClient object
  • clientId integer
  • _type_ integer
  • associatedSnapShotSCId object
  • _type_ integer
  • subclientId integer
  • snapCopyInfo object
  • snapToTapeProxyToUseSource boolean
  • isSnapBackupEnabled boolean
  • backupCopyInterface integer
  • IsOracleSposDriverEnabled boolean
  • isRMANEnableForTapeMovement boolean
  • useProxyForSQLIntegrity object
  • sybaseUser object
  • snapToTapeSelectedEngine object
  • _type_ integer
  • sqlUser object
  • snapToTapeProxyToUse object
  • clientId integer
  • _type_ integer
  • quiesceImpersonateUser object
  • separateProxyForSnapToTape object
  • _type_ integer
  • configuredSybaseInstance object
  • _type_ integer
  • prepostProcess object
  • runPostScan integer
  • runPostBackup integer
  • runPostLog integer
  • prepostUserName object
  • security object
  • clientOwners string[]
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • storageDevice object
  • networkAgents integer
  • overrideIncrementalDataPath boolean
  • applicableReadSize integer
  • softwareCompression integer
  • overrideDataPath boolean
  • throttleNetworkBandwidth integer
  • dataBackupStoragePolicy object
  • _type_ integer
  • storagePolicyName string
  • storagePolicyId integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature integer
  • logBackupStoragePolicy object
  • _type_ integer
  • performanceMode object
  • perfSPName string
  • multiplexingValid boolean
  • enableMultiplexing boolean
  • perfCopyName string
  • perfClientName string
  • streamsOverMux boolean
  • pipelineBufferSize integer
  • numOfPipelineBuffers integer
  • muxFactor integer
  • lookAheadReaderSlots integer
  • perfCRCDetails object[]
  • crcOverMedia boolean
  • perfMaId integer
  • crcOverNetwork boolean
  • perfMa string
  • associatedPolicy object
  • subclientPolicyId integer
  • analyticsSubclientProp object
GET /subclient/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
subclientId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'