Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

List eDiscovery Download Clients - v4

Returns a list of all the eDiscovery Download Clients that are configured in inSync.

get/legalholds/v4/clients

Query parameters

sortBy'name' | 'clientVersion' | 'cplatform' | 'createdBy'

Key to sort the results. You can sort by: name/clientVersion/cplatform/createdBy

sortOrder'asc' | 'desc'

Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.

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

The connection status of the client. It can be 'Connected', 'Disconnected', or 'Not Registered'.

searchBystring

Search by the name of the eDiscovery Download Client. Example - Client1

pageNumberinteger

Search by Page Number. Example - 1

pageSizeinteger

Search by Page Size. Example - 100

Response

OK

totalPagesinteger

Total number of pages for the API Response. Example - 1

totalResultsinteger

Total number of results. Example - 1

pageNumberinteger

Page number for which API response is expected. Example - 1

pageSizeinteger

Page Size for API response. Example - 100

Example response

{
  "totalPages": 1,
  "totalResults": 1,
  "clients": [
    {
      "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
    }
  ],
  "pageNumber": 1,
  "pageSize": 100
}