Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Lists all the devices of a Legal Hold policy - v4

Returns the list of all Legal Hold devices.

get/legalholds/v4/policies/{policyId}/collection-stream

Path parameters

policyIdinteger required

Specify the unique ID of the Legal Hold policy for which you want the list of devices. Get the ID of a Legal Hold policy using the 'List Legal Hold policies' API. Example - 12529

Query parameters

pageNumberinteger

Search the list of devices on Legal Hold according to the page number. Default value - 1 Example - 10.

pageSizeinteger

Search the list of devices on Legal Hold according to their page size. The maximum page size should not exceed 500. The minimum page size should be greater than or equal to 1. Example: 100.

searchStringstring

Search the list of devices on Legal Hold according to the device name. Example - DESKTOP1-device.

collectionType'Backup' | 'Additional'

Filter the list of devices on Legal Hold according to device type. Example - Backup.

collectionStatus'Successful' | 'Failed' | 'Collected with Errors' | 'Never Collected' | 'Collection Throttled' | 'Inactive'

Filter the list of devices on Legal Hold according to device collection status. Example - Failed.

sortBy'custodianName' | 'deviceName' | 'totalCollectedData' | 'lastCompletedCollection' | 'deviceStatus'

Sort to filter the list of devices on Legal Hold. Example - custodianName.

sortOrder'asc' | 'desc'

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

Response

OK

Example response

{
  "results": {
    "streamsList": [
      {
        "deviceName": "Desktop1-john",
        "collectionType": "Backup",
        "collectionStatus": "Successful",
        "totalCollectedDataInBytes": 1800010372,
        "linkId": 10008179,
        "custodianName": "John Doe",
        "platformIcon": "windows.png",
        "deviceStatus": "Enabled",
        "custodianId": 10005623,
        "deviceId": 10008211,
        "lastCompletedCollection": "Sep 05 2024, 02:55",
        "platformName": "win32",
        "totalCollectedData": "2.12 GB"
      }
    ],
    "totalResults": 1
  },
  "pageInfo": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 100
  }
}