DRdruva
Legal Hold

Get details of a legal hold policy - v3

Returns details of a legal hold policy configured in Druva inSync.

get/legalholds/v3/policies/{policyId}

Request

  • Base URL
    https://apis.druva.com/insync
  • URL
    https://apis.druva.com/insync/legalholds/v3/policies/{policyId}
  • Auth
    API key in header Authorization

Path parameters

policyIdinteger required

Specify the unique ID of the legal hold policy to get its details. Get the ID of a legal hold policy using the 'List legal hold policies' API.

Response

OK

type'All Backup Data' | 'Last Backup Data' | 'Data within a Date Range'

The data access type of the legal hold policy

namestring

The name of the legal hold policy

policyIdinteger

The ID of the Legal hold policy

cullingType'Include All Files' | 'Include Only Deleted Files'

The filter type of the legal hold policy. :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.

startDatestring date

The start date in the range in which the data is to be accessed. Format: YYYY-MM-DD :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.

endDatestring date

The end date in the range in which the data is to be accessed. Format: YYYY-MM-DD :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.

Example response

{
  "type": "Data within a Date Range",
  "name": "LH Policy 1",
  "cullingType": "Include Only Deleted Files",
  "startDate": "2019-03-19",
  "endDate": "2019-10-25"
}

Changes

No recorded changes to this operation across all 1 revision of this API.