v8

OpenAPI 3.1.0raw.githubusercontent.com2026-08-034690258.3 KB
Legal Holds

Set a legal hold.

Creates a named hold that blocks deletion and purge of the specified evidence until the hold is released. The reference must be unique for the calling user. Two scope types are supported: 'document_chain' protects a specific document's ledger chain; 'user' protects all governance evidence owned by the user. Admins may place a hold on another user's evidence via the owner parameter.

post/api/holds

Query parameters

ownerstring

Headers

Authorizationstring required

Request body

reasonstring
referencestring
scopeTypestring
scopeValuestring

Response

The hold was set and is now active.

reasonstring
referencestring
scopeTypestring
scopeValuestring
setAtstring date-time