Place a legal hold
POST/v1/legal-holds
Keeps one backup, or every backup of a plan or a project, past its expiry date, and stops it being deleted until the hold is lifted. scope is point, plan or project, and target_id names what is held. reason is required.
Operator only: needs a system-scoped token.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 413
- 415
- 422
- default
Created
Bad Request.
invalid_request: The body is not a single JSON object, names a field this operation does not take, or gives a value of the wrong type.
Unauthorized.
unauthenticated: The token is missing, expired or not valid.
Forbidden.
forbidden: The token's roles do not grant legal_hold:write.
Not Found.
not_found: scope is point or plan, and no backup or plan has target_id.
Request Entity Too Large.
body_too_large: The body is larger than the service accepts.
Unsupported Media Type.
unsupported_media_type: The body is not sent as application/json.
Unprocessable Entity.
validation_failed: scope is not point, plan or project. target_id or reason is missing. target_id is not a UUID for scope point or plan.
An error, as an RFC 7807 problem document.