Modifies the Object Lock legal hold status for an existing file
Used to enable legal hold for a file in an Object Lock-enabled bucket, preventing it from being deleted, or to disable legal hold protections for a file.
This API endpoint can be called using a
GET request by converting the parameters in the request body to query parameters.
An account authorization token, obtained from b2_authorize_account.
The token must have the
The name of the file.
on to enable legal hold for the file,
off to disable it.
The request succeeded.
The response headers include the Content-Type that was specified when the file was uploaded. They also include the X-Bz-FileName and X-Bz-Content-Sha1 headers, plus X-Bz-Info-* headers for any custom file info that was provided with the upload. The X-Bz-FileName uses percent-encoding, as if it were a URL parameter.
The unique identifier for this version of this file.
The name of this file.
The updated value of the legal hold status, indicating whether the file has a legal hold in place.
|400||bad_request||The request had the wrong fields or illegal values. The message returned with the error will describe the problem.|
|400||metadata_exceeded||This operation is not allowed because of the current file metadata size. If needed, use b2_copy_file with |
The numeric HTTP status code. Always matches the status in the HTTP response.
A single-identifier code that identifies the error.
A human-readable message, in English, saying what went wrong.
|403||access_denied||The auth token used is valid, but does not authorize this call with these parameters. The capabilities of an auth token are determined by the application key used with b2_authorize_account.|
|403||cap_exceeded||Usage cap exceeded.|
|405||method_not_allowed||This operation is not allowed because the specified file is a "hide marker."|