eDiscovery provides legal hold and search capabilities for compliance use cases. Requires the ediscovery product property to be enabled on the account.
Legal holds contain searches; searches are always scoped to a parent legal hold.
List legal holds
Returns all legal holds for the specified account. Legal holds preserve backed-up data from deletion or modification, typically for eDiscovery or compliance requirements.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
List legal holds › Responses
success
Create legal hold
Creates a new legal hold for the specified account. A legal hold preserves backed-up data from deletion or modification, ensuring it remains available for eDiscovery and compliance purposes.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Create legal hold › Responses
success
Get legal hold
Returns details for a single legal hold identified by its ID. A legal hold preserves backed-up data from deletion or modification for eDiscovery and compliance purposes.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdGet legal hold › Responses
success
Update legal hold
Updates the properties of an existing legal hold, such as its name, description, or scope configuration.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdUpdate legal hold › Responses
success
Delete legal hold
Deletes an existing legal hold by ID. Removing a legal hold releases the preservation policy on any data items that were covered by the hold.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdDelete legal hold › Responses
success
List legal hold searches
Returns all saved search queries associated with the specified legal hold. Each search defines criteria used to identify which backed-up data items are covered by the hold.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdList legal hold searches › Responses
success
Create legal hold search
Adds a new saved search query to the specified legal hold. The search defines criteria that identify which backed-up data items are covered by the hold's preservation scope.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdCreate legal hold search › Responses
success
Get legal hold search
Returns a single saved search query associated with the specified legal hold. Searches define the criteria used to identify data items that fall under a hold's preservation scope.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
holdIdsearchIdGet legal hold search › Responses
success