Skip to main content

Get Client Properties By Name​

Select

SaaS
Customer Managed

This operation returns the properties associated with a client.

Path Parameters
  • clientname string required

    Name of the client

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • clientProperties object[]
  • clusterClientProperties object
  • configureClusterClient boolean
  • showAllAgents boolean
  • pseudoClientInfo object
  • edgeDrivePseudoClientProperties object
  • systemDriveType integer
  • impersonateUser object
  • outlookAddinStoreInfo object
  • openVMSProperties object
  • cvdPort integer
  • userAccount object
  • password string
  • userName string
  • virtualServerClientProperties object
  • virtualServerInstanceInfo object
  • vsInstanceType integer
  • vmBackupInfo object
  • distributedClusterInstanceProperties object
  • clusterConfig object
  • ibmiInstallOptions object
  • jobProirity integer
  • jobQueue string
  • createJobQueue boolean
  • subsysDescription string
  • dataFolder string
  • runPriority integer
  • userProfile object
  • userName string
  • clientProps object
  • isMA boolean
  • webSearchServiceUrl string
  • AutoUpdateLocation string
  • JobResultsDiskCapThreshold integer
  • CipherType integer
  • RetryFrequencyInSecOnNetworkError integer
  • isWebServerInstalled boolean
  • RestoreAccessFlag integer
  • isRemoteCacheEnabled boolean
  • SnapBackupMAInstalled boolean
  • PathToExchangeMiningTool string
  • is1TouchClient boolean
  • RestoreAccessSynFull boolean
  • AltCachePartitionForQSnap string
  • cacheSource integer
  • ClientInterface string
  • EncryptKeyLength integer
  • isIndexingV2 boolean
  • IsQsnapUNIX boolean
  • dm2CacheDiskCapThreshold integer
  • EnableContentIndexing boolean
  • OptimizeDataForSearch boolean
  • recallService string
  • CenteraResourceFilename string
  • isQsnapInstalled integer
  • ContentIndexEngineInstalled boolean
  • dm2CacheRetentionDays integer
  • IsDCInstalled boolean
  • encryptionSettings integer
  • IsExchangeOnePassClient boolean
  • isExchangePseudoClient boolean
  • RetryCountOnNetworkError integer
  • DirectMediaAccessFlag integer
  • isPersonalWorkstation boolean
  • isIndexingV2NAS boolean
  • JobResultsThresholdMB integer
  • JobResultsRetentionDays integer
  • EnableSnapBackups boolean
  • BlockLevelCacheDir string
  • StorePatchLocally boolean
  • isFastSearchSupported boolean
  • isDescriptionInHTMLFormat boolean
  • BinarySetID integer
  • IsCommServer boolean
  • IsDeletedClient boolean
  • iswebSearchServerInstalled boolean
  • EnableCollectDelegateInfo boolean
  • fileLevelAnalyticsLicense boolean
  • EnableRetryOnNetworkError boolean
  • dm2CacheThresholdMB integer
  • queueJobsIfOtherConflictingJobsAreActive boolean
  • IsVirtualClient boolean
  • JobPriority integer
  • overrideGlobalDesktopGuiProperties boolean
  • enableAccessControl boolean
  • CDRLogFileLocation string
  • EndUserUrl string
  • ClientNoPhysicalMachine boolean
  • byteOrder string
  • RestoreAccessPubKey boolean
  • networkThrottle object
  • enableThrottle boolean
  • throttle object
  • webSearchServerForSuperSearch object
  • clientId integer
  • clientName string
  • securityAssociations object
  • associations object[]
  • userOrGroup object[]
  • userGroupName string
  • userGroupId integer
  • _type_ integer
  • userId integer
  • userName string
  • properties object
  • isCreatorAssociation boolean
  • role object
  • _type_ integer
  • roleId integer
  • roleName string
  • ownerAssociations object
  • categoryPermission object
  • categoriesPermissionList object[]
  • permissionId integer
  • permissionName string
  • categoryName string
  • _type_ integer
  • categoryId integer
  • owners object[]
  • userId integer
  • _type_ integer
  • userName string
  • userGroupName string
  • userGroupId integer
  • entityOwners object[]
  • flags integer
  • ownerUser object
  • _type_ integer
  • userName string
  • userId integer
  • ownerUserGroup object
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • clientSecurity object
  • enableDataSecurity boolean
  • clientUserGroupOwners string[]
  • clientOwners string[]
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • individualCapabilities integer[]
  • registryKeys object[]
  • relativepath string
  • keyName string
  • isInheritedFromClientGroup boolean
  • comment string
  • type string
  • value string
  • enabled integer
  • sourceEntity object
  • dlpPropertise object
  • dlpScanIntervalMins integer
  • dlpStolen boolean
  • dlpEnableAutomaticDecryption boolean
  • dlpUnlockMethod integer
  • enableDLP boolean
  • dlpEnableClientKeys boolean
  • dlpMinFileAgeMins integer
  • dlpRMProperties object
  • enableRmDLP boolean
  • dlpRmNow boolean
  • dlpRmOfflineDays integer
  • firewallConfiguration object
  • configureFirewallSettings boolean
  • isTrivialConfig boolean
  • reachMeVia object
  • reachMeViaSelected boolean
  • fwTrivialConfig object
  • firewallTrivialDetailsCS object
  • networkType integer
  • connectionType integer
  • proxyEntity object
  • clientName string
  • clientId integer
  • firewallTrivialDetailsMA object
  • networkType integer
  • connectionType integer
  • proxyEntity object
  • clientName string
  • clientId integer
  • firewallOptions object
  • isRoamingClient boolean
  • extendedProperties string
  • tunnelconnectionPort integer
  • foreceSSL boolean
  • tunnelInitSeconds integer
  • lockdown boolean
  • bindOpenPortsOnly boolean
  • isDMZ boolean
  • keepAliveSeconds integer
  • tppm object[]
  • deDuplicationProperties object
  • performClientSideDeduplication boolean
  • enableHighLatencyOptimization boolean
  • cacheBufferSize integer
  • maxCacheDb integer
  • clientSideDeduplication integer
  • enableVariableContentAlignment boolean
  • enableClientSideDiskCache boolean
  • spWebServerProperties object
  • enableOnlineSearch boolean
  • spWebServerUserPassword object
  • activityControl object
  • EnableDataRecovery boolean
  • EnableDataManagement boolean
  • EnableOnlineContentIndex boolean
  • advancedClientProperties object
  • slaCopyFallenBehindDays integer
  • rpoMinutes integer
  • mailServerRole integer
  • rtoMinutes integer
  • slaCopyRedundancy integer
  • excludeFromSLA boolean
  • dm2CacheDir object
  • path string
  • userAccount object
  • userName string
  • rightManagementServiceProperties object
  • SMTPAddressOfTheRMSSuperUser string
  • decryptRMSDocumentDuringContentIndexing boolean
  • smtpAddressOfRMSSuperUser string
  • rmsCredentials object
  • password string
  • userName string
  • clientActivityControl object
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • jobThrottleSettings object
  • isJobThrottleEnabledAtCS integer
  • isJobThrottleEnabled integer
  • dataThreshold integer
  • excludeImmidiateJobs integer
  • logThreshold integer
  • webSearchServer object
  • hostName string
  • clientId integer
  • emailWebAppProperties object
  • enableEmailWebApp boolean
  • exchangeAdminSmtpAddress string
  • exchangeAdministratorAccount object
  • userName string
  • client object
  • displayName string
  • installDirectory string
  • ClockSkewInSeconds integer
  • timezoneSetByUser boolean
  • clientDescription string
  • evmgrcPort integer
  • cvdPort integer
  • jobResulsDir object
  • path string
  • userAccount object
  • userName string
  • origCommCell object
  • commCellId integer
  • clientEntity object
  • hostName string
  • clientId integer
  • clientName string
  • commCellName string
  • clientGUID string
  • versionInfo object
  • UpdateStatus integer
  • version string
  • GalaxyRelease object
  • ReleaseString string
  • PatchStatus object[]
  • BaselineUpdates string
  • BaselineStatus integer
  • packageInfo object
  • packageId integer
  • packageName string
  • TimeZone object
  • TimeZoneID integer
  • TimeZoneName string
  • osInfo object
  • Type string
  • SubType string
  • osId integer
  • OsDisplayInfo object
  • ProcessorType string
  • OSName string
  • clientGroups object[]
  • clientGroupId integer
  • clientGroupName string
  • AdvancedFeatures object[]
  • LicenseName string
  • LicenseId integer
  • ActivePhysicalNode object
  • hostName string
  • clientId integer
  • clientName string
GET /client/byName(clientName=':clientname')

Authorization

type: apiKeyname: Authtokenin: header

Request

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