> Essential > Developer Tools > REST API > REST API Reference > Client Operations

REST API - GET Client

This operation returns a list of clients.

Request

Syntax

GET <webservice>/Client?PseudoClientType={VSPseudo|CloudApps} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

PseudoClientType

Include this parameter to specify the type of pseudo client to return.

Valid values are:

  • VSPseudo to return a list of virtualization clients, including clients with VMware or Microsoft Hyper-V instances and clients with the V9 Virtual Server agent installed.

  • CloudApps to return a list of all cloud apps pseudo clients.

No

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

cvdPort

The TCP port number for the Communications Service (CVD).

client

evmgrcPort

The TCP port number for the Client Manager Service (ClMgrS).

Applies to upgraded clients or clients from previous Commvault versions.

client

_type_

The type of CommCell object.

Valid value is CLIENT_ENTITY.

clientEntity

cloudAppsInstanceType

Instance type of the cloud apps client.

Valid values are 1 for Gmail, 2 for Google Drive, and 3 for Salesforce.

PseudoClientType

hostName

The long name of the client, for example, client.domain.company.com.

clientEntity

clientId

The system-generated ID assigned to the client.

clientEntity

clientName

The name of the client.

clientEntity

displayName

Display name of the client.

clientEntity

clientGUID

The globally unique identifier for the client.

clientEntity

enableAccessControl

The option to enable access control. Enabling access control allows end-users to browse and restore data for which they have permissions (also referred as ACL-based browse and restore operations).

Valid values are True/False.

clientProps

Examples

Sample Request

This request returns all clients.

GET <webservice>/Client HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request returns virtualization clients.

GET <webservice>/Client?PseudoClientType=VSPseudo HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request returns cloud apps pseudo clients.

GET <webservice>/Client?PseudoClientType=CloudApps HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the request is for all clients.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetClientPropertiesResponse>
  <clientProperties>
    <client cvdPort="0" evmgrcPort="0">
      <clientEntity _type_="CLIENT_ENTITY" clientGUID="99A58B29-C0C3-434B-AC9D-11759D9CCEE7" clientId="2" clientName="client001" hostName="client001.company.com"/>
    </client>
    <clientProps enableAccessControl="false"/>
  </clientProperties>
 </App_GetClientPropertiesResponse>

This is the response when the request is for virtualization clients. For descriptions of the response parameters, see the GET Virtualization Clients API.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_VSPseudoClientsResponse>
   <VSPseudoClientsList VSInstanceType="2">
     <client clientGUID="E4AEC929-0F5C-4013-8B2E-EATEST123655" clientName="Vclient001" hostName="DOCLABHVHOST.commvault.com" clientId="2" />
     <clientActivityControl>
       <entity _type_="3" />
       <activityControlOptions enableAfterADelay="0" enableActivityType="1" activityType="1" />
       <activityControlOptions activityType="2" enableActivityType="1" enableAfterADelay="0" />
     </clientActivityControl>
   </VSPseudoClientsList>
 </App_VSPseudoClientsResponse>

This is the response when the request is for cloud apps pseudo clients.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 {
   "CloudAppsClientsList": [
     {
       "cloudAppsInstanceType": 2,
       "client": {
         "hostName": "New-Gdrive",
         "clientId": 1039,
         "clientName": "New-Gdrive",
         "displayName": "New-Gdrive",
         "clientGUID": "9DA2A048-B4B5-4D29-A5FB-F8E2758CAA3C"
       }
     },
     {
       "cloudAppsInstanceType": 1,
       "client": {
         "hostName": "New-Gmail",
         "clientId": 1035,
         "clientName": "New-Gmail",
         "displayName": "New-Gmail",
         "clientGUID": "BA761DDD-9E78-4BC9-89BC-8A8431209778"
       }
     }
   ]
 }

Loading...