Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Get eDiscovery Download Client details - v4

Returns details of a eDiscovery Download Client.

get/legalholds/v4/clients/{clientId}

Path parameters

clientIdinteger required

Client ID for which details are to be fetched. Example - 54.

Response

Details of the client requested.

ddClientHostNamestring

The name of the device where the client is installed. Example - John-8765-Windows-PC

clientSecretIdstring

API secret part of API credentials. Example - E1AMfwKbQUXGY6sbPB9igPyDL3CbhyWa

cplatformstring

The operating system of the device where the client is installed. Example - win32

namestring

Name of the eDiscovery Download Client machine. Example - client1_PF_123

clientVersionstring

Version of the eDiscovery Download Client. Example - 1.1.1

ipstring

IP address of the eDiscovery Download Client machine. Example - 110.11.14.10

clientIdinteger

Client ID part of API credentials. Example-59

connectionStatus'Not Registered' | 'Connected' | 'Disconnected'

Connection status of the eDiscovery Download Client. There can be the following statuses:

createdBystring

Name of admin who created the eDiscovery Download Client. Example - John Doe

defaultDownloadLocationstring

Default download location for eDiscovery download. Example - 'D:\Data'

activationTimeinteger

Timestamp when the eDiscovery Download Client machine was activated. Example - 1624887294

Example response

{
  "ddClientHostName": "John-8765-Windows-PC",
  "clientSecretId": "E1AMfwKbQUXGY6sbPB9igPyDL3CbhyWa",
  "client_features": {
    "metadata_download": true,
    "zip_download": true,
    "data_download": true,
    "integrity_check": true
  },
  "cplatform": "win32",
  "name": "client1_PF_123",
  "clientVersion": "1.1.1",
  "ip": "110.11.14.10",
  "clientId": 59,
  "connectionStatus": "Connected",
  "createdBy": "John Doe",
  "defaultDownloadLocation": "D:\\Data",
  "activationTime": 1624887294
}