mc legalhold clear
Syntax
The mc legalhold clear
command removes the current legal hold setting for an object or objects.
Removing the legal hold on object(s) does not remove any other GOVERNANCE Mode and COMPLIANCE Mode retention settings in place for the object(s)
The following command removes the legal hold on all objects in the
mydata
bucket on the myminio
MinIO deployment:
mc legalhold clear --recursive myminio/mydata
The command has the following syntax:
mc [GLOBALFLAGS] legalhold clear \
[--recursive] \
[--rewind] \
[--version-id] \
ALIAS
Brackets
[]
indicate optional parameters.Parameters sharing a line are mutually dependent.
Parameters separated using the pipe
|
operator are mutually exclusive.
Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.
Parameters
- ALIAS
- Required
The MinIO alias and path to the object or objects on which to remove the legal hold. For example:
mc legalhold clear play/mybucket/myobjects/objects.txt
- --recursive, r
- Optional
Removes the legal hold on all objects in the
ALIAS
bucket or bucket prefix.
- --rewind
- Optional
Directs
mc legalhold clear
to operate only on the object version(s) that existed at specified point-in-time.To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp. For example:
--rewind "2020.03.24T10:00"
.To rewind a duration in time, specify the duration as a string in
#d#hh#mm#ss
format. For example:--rewind "1d2hh3mm4ss"
.
--rewind
requires that the specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.
- --version-id, vid
- Optional
Directs
mc legalhold clear
to operate only on the specified object version.--version-id
requires that the specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.
Global Flags
This command supports any of the global flags.
Examples
Retrieve the Legal Hold Status Objects
Use mc legalhold clear
to retrieve the legal hold status of an object.
Include --recursive
to return the legal hold
status of the contents of a bucket:
mc legalhold clear [--recursive] ALIAS/PATH
Replace
PATH
with the path to the bucket or object on the S3-compatible host. If specifying the path to a bucket or bucket prefix, include the--recursive
option.
Behavior
S3 Compatibility
The mc commandline tool is built for compatibility with the AWS S3 API and is tested with MinIO and AWS S3 for expected functionality and behavior.
MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.