Create a legal hold

Authorization

Send a personal access token with every request.

• Authorization: Bearer PAT

Header parameters

• Idempotency-Keystring

  Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

• scopeTypestringrequired
  Allowed values

  tenant

  project

  dataset

  datasetVersion

  storageObject
• scopeIdstring (uuid) | null
• reasonstringrequired

Responses

{
  "data": {
    "id": "string",
    "tenantId": "string",
    "scopeType": "tenant",
    "scopeId": "string",
    "reason": "string",
    "placedBy": "string",
    "placedAt": "string",
    "releasedBy": "string",
    "releasedAt": "string",
    "authority": "tenant",
    "status": "active",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "meta": {
    "requestId": "string"
  }
}