This operation returns 1-Touch Recovery points that are associated with a client.
Request
Syntax
Send the request using client ID, client name, client name and backupset name, client name and additional parameters, or backupset ID.
-
ID
GET <webservice>/client/{{clientId}} HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> -
Client name
GET <webservice>/client/byName(clientName='{{clientName}}') HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> -
Client name and backupset name
GET <webservice>/byName(clientName='{{clientName}}' appName='File System' backupsetName='{{backupsetName}}') HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> -
Client name and additional parameters
GET <webservice>/byName(clientName='{{clientName}}' appName='File System' backupsetName='{{backupsetName}}') HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> -
backupset ID
GET <webservice>/client/{{clientId}}?backupsetId={{backupsetId}} HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token>
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
clientId |
The system-generated ID of the Index Server client. |
Yes |
|
ClientName |
Yes |
|
|
backupsetName |
Yes |
|
|
groupName |
No |
|
|
time |
No |
|
|
timeZoneId |
No |
|
|
backupsetId |
Yes |
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 information about receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
platform |
clients |
|
|
isBlockLevelBackup |
clients |
|
|
indexCachePath |
clients |
|
|
isClientMA |
clients |
|
|
clone |
clients |
|
|
isIndexCacheInUSB |
clients |
|
|
firewallCS |
clients |
|
|
backupsetId |
backupSet |
|
|
_type_ |
backupSet |
|
|
backupsetName |
backupSet |
|
|
netconfig |
clients |
|
|
persistence |
netconfig |
|
|
wins |
netconfig |
|
|
useDhcp |
wins |
|
|
firewall |
netconfig |
|
|
certificatePath |
firewall |
|
|
certificateBlob |
firewall |
|
|
configureBlob |
firewall |
|
|
dns |
netconfig |
|
|
suffix |
dns |
|
|
useDhcp |
dns |
|
|
ipinfo |
netconfig |
|
|
defaultgw |
ipinfo |
|
|
interfaces |
ipinfo |
|
|
adapter |
interfaces |
|
|
networkLabel |
interfaces |
|
|
vlan |
interfaces |
|
|
macAddressType |
interfaces |
|
|
isEnabled |
interfaces |
|
|
name |
interfaces |
|
|
mac |
interfaces |
|
|
classicname |
interfaces |
|
|
wins |
interfaces |
|
|
dns |
interfaces |
|
|
protocols |
interfaces |
|
|
gw |
protocols |
|
|
subnetId |
protocols |
|
|
netmask |
protocols |
|
|
networkAddress |
protocols |
|
|
useDhcp |
protocols |
|
|
ip |
protocols |
|
|
address |
ip |
|
|
family |
ip |
|
|
platformConfig |
clients |
|
|
platformCfgBlob |
platformConfig |
|
|
win_passPhrase |
platformConfig |
|
|
type |
platformConfig |
|
|
goToMiniSetUp |
platformConfig |
|
|
Win_DomainCreds |
platformConfig |
|
|
isClientInDomain |
Win_DomainCreds |
|
|
DomainCreds |
Win_DomainCreds |
|
|
password |
DomainCreds |
|
|
domainName |
DomainCreds |
|
|
ConfirmPassword |
DomainCreds |
|
|
userName |
DomainCreds |
|
|
firewallLocal |
clients |
|
|
client |
clients |
|
|
hostName |
client |
|
|
clientName |
client |
|
|
type |
client |
|
|
clientGUID |
client |
|
|
indexPathCreds |
clients |
|
|
password |
indexPathCreds |
|
|
domainName |
indexPathCreds |
|
|
confirmPassword |
indexPathCreds |
|
|
username |
indexPathCreds |
|
|
newclient |
clients |
|
|
_type_ |
newclient |
|
|
firewallPort |
csinfo |
|
|
cvdPort |
csinfo |
|
|
evmgrPort |
csinfo |
|
|
fwClientGroupName |
csinfo |
|
|
mediaAgentInfo |
csinfo |
|
|
_type_ |
mediAgentInfo |
|
|
mediaAgentIP |
csinfo |
|
|
ip |
csinfo |
|
|
address |
ip |
|
|
commserveInfo |
csinfo |
|
|
hostName |
commserveInfo |
|
|
ClientName |
commserveInfo |
|
|
_type_ |
commserveInfo |
|
|
creds |
csinfo |
|
|
password |
creds |
|
|
domainName |
creds |
|
|
confirmPassword |
creds |
|
|
userName |
creds |
|
|
minMemoryMB |
hwconfig |
|
|
vmName |
hwconfig |
|
|
magicno |
hwconfig |
|
|
enableDynamicMemory |
hwconfig |
|
|
bootFirmware |
hwconfig |
|
|
version |
hwconfig |
|
|
mem_size |
hwconfig |
|
|
cpu-count |
hwconfig |
|
|
maxMemoryMB |
hwconfig |
|
|
nic_count |
hwconfig |
|
|
overwriteVm |
hwconfig |
|
|
useMtptSelection |
hwconfig |
|
|
ide_count |
hwconfig |
|
|
mtpt_count |
hwconfig |
|
|
scsi_count |
hwconfig |
|
|
diskType |
hwconfig |
|
|
optimizeStorage |
hwconfig |
|
|
scsi_disks |
hwconfig |
|
|
forceProvision |
scsi_disks |
|
|
bus |
scsi_disks |
|
|
refcnt |
scsi_disks |
|
|
size |
scsi_disks |
|
|
scsiControllerType |
scsi_disks |
|
|
name |
scsi_disks |
|
|
dataStoreName |
scsi_disks |
|
|
vm_disk_type |
scsi_disks |
|
|
slot |
scsi_disks |
|
|
diskType |
scsi_disks |
|
|
tx_type |
scsi_disks |
|
|
systemDisk |
hwconfig |
|
|
cpu_list |
hwconfig |
|
|
cpu_arch |
cpu_list |
|
|
cpu_speed |
cpu_list |
|
|
mtpt_list |
hwconfig |
|
|
alwaysEnabled |
mtpt_list |
|
|
mtpt_type |
mtpt_list |
|
|
mtpt_name |
mtpt_list |
|
|
mtpt_size |
mtpt_list |
|
|
enabled |
mtpt_list |
|
|
mtpt_GUID |
mtpt_list |
|
|
diskname_list |
mtpt_list |
|
|
diskName |
diskname_list |
|
|
mtpt_size |
diskname_list |
|
|
Persistence |
netconfig |
|
|
wins |
netconfig |
|
|
firewall |
netconfig |
|
|
dns |
netconfig |
|
|
ipinfo |
netconfig |
Examples
Sample Request
POST <webservice>/client/purescsi_2
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 3c633bc300b7cbdcf31f918d4ce4934722d620774b81e87e543c517177302b23a0742c0b7e74bd7dc43731ca2b83fe44a43b5fcb24633fab54842eaeb8ddaa6d85674a17692ea6cd559b1d70a4f589552e59c10fc79701debf79d85cda
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<ResponseFile_ResponseFileBean copyPrecedence="0" version="10.0" platform="1" dateCreated="" automationTest="0" autoReboot="1" autoScaleStorage="0">
<clients platform="1" isBlockLevelBackup="0" indexCachePath="" isClientMA="0" clone="0" isIndexCacheInUSB="1" firewallCS="">
<backupSet backupsetId="1485" _type_="6" backupsetName="defaultBackupSet" />
<netconfig persistence="0">
<wins useDhcp="0" />
<firewall certificatePath="" certificateBlob="" configBlob="" />
<dns suffix="" useDhcp="0" />
<ipinfo defaultgw="">
<interfaces adapter="0" networkLabel="" vlan="0" macAddressType="0" isEnabled="1" name="Ethernet" mac="00:15:5D:3D:31:4A" classicname="">
<wins useDhcp="0">
<nameservers address="172.16.69.32" family="32" />
<nameservers address="172.16.67.114" family="32" />
<nameservers address="172.16.26.31" family="32" />
<nameservers address="172.19.59.7" family="32" />
<nameservers address="172.19.59.32" family="32" />
</wins>
<dns suffix="" useDhcp="0">
<nameservers address="172.16.69.32" family="32" />
<nameservers address="172.16.67.114" family="32" />
<nameservers address="172.19.59.32" family="32" />
<nameservers address="172.16.26.31" family="32" />
<nameservers address="172.19.59.7" family="32" />
<nameservers address="172.16.41.18" family="32" />
<nameservers address="172.16.73.247" family="32" />
</dns>
<protocols gw="172.16.60.1" subnetId="" netmask="255.255.252.0" networkAddress="" useDhcp="1">
<ip address="172.16.62.96" family="32" />
</protocols>
</interfaces>
</ipinfo>
</netconfig>
<platformConfig platformCfgBlob="" win_passPhrase="" win_licenceKey="" type="1" goToMiniSetUp="0">
<Win_DomainCreds isClientInDomain="1">
<DomainCreds password="" domainName="idcprodcert.loc" confirmPassword="" userName="" />
</Win_DomainCreds>
</platformConfig>
<firewallLocal />
<client hostName="purescsi.idcprodcert.loc" clientName="purescsi_2" type="0" _type_="3" clientGUID="2DDB3B51-5407-473C-A998-F55E58CD7E22" />
<indexPathCreds password="" domainName="" confirmPassword="" userName="" />
<newclient _type_="3" />
</clients>
<csinfo firewallPort="0" cvdPort="0" evmgrPort="0" fwClientGroupName="">
<mediaAgentInfo _type_="3" />
<mediaAgentIP />
<ip address="172.16.62.69" />
<commservInfo hostName="idcFsAutoCs.idcprodcert.loc" clientName="idcfsautocs" _type_="3" />
<creds password="3d0047590ea2e8894130282dc5dc54a2854a52e5b013c981587115b702eec96d698748b4956a4ca25" domainName="" confirmPassword="" userName="admin" />
</csinfo>
<hwconfig minMemoryMB="0" vmName="" magicno="WINHWCONFIG" enableDynamicMemory="0" bootFirmware="1" version="10.0" mem_size="4096" cpu_count="1" maxMemoryMB="0" nic_count="1" overwriteVm="0" useMtptSelection="1" ide_count="0" mtpt_count="3" scsi_count="2" diskType="1" optimizeStorage="0">
<scsi_disks forceProvision="0" bus="0" refcnt="1" size="53688" scsiControllerType="0" name="\\?\PhysicalDrive0" dataStoreName="" vm_disk_type="1" slot="0" diskType="1" tx_type="1" />
<scsi_disks forceProvision="0" bus="0" refcnt="0" size="6007" scsiControllerType="0" name="" dataStoreName="" vm_disk_type="0" slot="1" diskType="1" tx_type="1" />
<systemDisk forceProvision="0" bus="0" refcnt="1" size="53688" scsiControllerType="0" name="\\?\PhysicalDrive0" dataStoreName="" vm_disk_type="1" slot="0" diskType="1" tx_type="1" />
<cpu_list cpu_arch="1" cpu_speed="2195" />
<mtpt_list alwaysEnabled="1" mtpt_type="0" mtpt_name="" mtpt_size="471859200" enabled="1" mtpt_GUID="">
<diskname_list diskName="\\?\PhysicalDrive0" mtpt_size="471859200" />
</mtpt_list>
<mtpt_list alwaysEnabled="1" mtpt_type="0" mtpt_name="" mtpt_size="103809024" enabled="1" mtpt_GUID="">
<diskname_list diskName="\\?\PhysicalDrive0" mtpt_size="103809024" />
</mtpt_list>
<mtpt_list alwaysEnabled="1" mtpt_type="10" mtpt_name="C" mtpt_size="53092462592" enabled="1" mtpt_GUID="{C5515277-1BD4-4B5C-8B2B-491FCDE88D5C}">
<diskname_list diskName="\\?\PhysicalDrive0" mtpt_size="53092462592" />
</mtpt_list>
</hwconfig>
<netconfig persistence="0">
<wins useDhcp="0" />
<firewall />
<dns suffix="" useDhcp="0" />
<ipinfo defaultgw="" />
</netconfig>
<dataBrowseTime _type_="55" />
<maInfo clientName="" />
<datastoreList />
</ResponseFile_ResponseFileBean>
