Manage Legal Hold Files - Netskope Technical Documentation

This endpoint allows different operations to be performed on legal hold files.

Request Endpoint

https://<tenant-URL>/api/v1/legalhold

Valid parameters are:

Key	Value	Description
`token`	string	Required. The token obtained from the REST API page in the Netskope UI ( Settings > Tools > Rest API v1) is required. We recommend that you place the token in the body of the request, not in the endpoint URL.
`op`	`get-files \| download-url \| take-action`	`get-files`: Will get list of legal hold files. `download-url`: Will get the URL to be used in the download of a file. The response here will be HTTP Redirect (Response Code 302) `take-action`: Action to be take on a SINGLE legal hold file.
`legal_hold_profile_id`	ID of a legal hole profile	This is needed for `op=download-url`. Also needed for `op=take-action`.
`starttime`	Unix epoch time (rounded off to nearest period).	Use for `op=get-files`. Get files last modified within a certain time period. These are optional parameters. If not provided `starttime` is assumed to be 0 and `endtime` is assumed to be the current time.
`endtime`	Unix epoch time (rounded off to nearest period).	Use for `op=get-files`. Get files last modified within a certain time period. These are optional parameters. If not provided `starttime` is assumed to be 0 and `endtime` is assumed to be the current time.
`file_id`	ID of a file, needed to identify a file.	Needed for `op=download-url`. Needed for `op=take-action`.
`action`	`mark-processed`	Action to be performed on a legal hold file. `action=mark-processed` means the legal hold file will be marked as processed. Once the file is marked as processed, it won’t show up in legal hold page under Skope IT in the tenant.
`type`	`processed \| unprocessed`	Use for `op=get-files`. Get file that is either marked processed or unprocessed

The downloaded legal hold file operates the same way as a quarantine file. Refer to the Quarantine section for more details.