Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Create a Legal Hold policy - v4

Creates a Legal Hold policy in Druva inSync.

post/legalholds/v4/policies

Request body

namestring required

Name of Legal Hold policy to be created. Example - Feb_2021.

legalHoldTypestring

Type of Legal Hold to be created. This parameter is optional. If not specified it is set to '--'. Example- Human Resources.

webDavAccessType'All Collected Data' | 'Last Collected Data' | 'Data within a Date Range' required

The data access type of the legal hold policy. Use any of the following:

startDatestring mmm DD YYYY required

The start date in the range in which the data is to be accessed if webdav access type selected is 'Data within a Date Range'. This parameter is optional if webdav access type is not 'Data within a Date Range'. Example - Apr 11 2021

endDatestring mmm DD YYYY required

The end date in the range in which the data is to be accessed if webdav access type selected is 'Data within a Date Range'. This parameter is optional if webdav access type is not 'Data within a Date Range'. Example - May 11 2021

deletedFilesOnlytrue | false

Use 'true' if you want to access only deleted files. Otherwise, use 'false'. This parameter is optional.

isADCEnabledtrue | false

Use 'true' if you want to enable Additional Data Collection for this Legal Hold. Otherwise, use 'false'. This parameter is optional.

collectionFrequency'One time' | 'Recurring'

Choose collection frequency of additional data collection from one of the following option. To use this parameter isADCEnabled should be set to true. This parameter is optional.

accessBackupDataboolean

Use 'true' if you want to enable Backup Data Access for this Legal Hold policy. The accessBackupData and accessAdditionalData parameters cannot be set to false simultaneously. The default value is set to 'true'.

accessAdditionalDataboolean

Use 'true' if you want to enable Additional Data Collection access for this Legal Hold policy. The isADCEnabled value must be set to 'true' to enable this option. The default value is set to 'false'.

Example request

{
  "name": "Feb_2021",
  "legalHoldType": "Human Resources",
  "webDavAccessType": "Data within a Date Range",
  "startDate": "Apr 11 2021",
  "endDate": "May 11 2021",
  "collectionFrequency": "Recurring",
  "accessBackupData": true
}

Response

policyIdinteger

The unique ID of the created Legal Hold policy. Example - 12359

Example response

{
  "policyId": 12359
}