mc legalhold requires that the specified bucket has
object locking enabled. You can only enable
object locking at bucket creation. See
mc mb --with-lock for
documentation on creating buckets with object locking enabled.
The following command enables legalhold WORM locking on all objects
mydata bucket on the
myminio MinIO deployment:
mc legalhold set --recursive myminio/mydata
The command has the following syntax:
mc [GLOBALFLAGS] legalhold set \ [--recursive] \ [--rewind] \ [--version-id] \ ALIAS
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.
Required The MinIO alias and path to the object or objects on which to enable the legal hold. For example:
mc legalhold set play/mybucket/myobjects/objects.txt
- --recursive, r
Optional Applies the legal hold to all objects in the
ALIASbucket or bucket prefix.
mc legalhold setto 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:
To rewind a duration in time, specify the duration as a string in
#d#hh#mm#ssformat. For example:
This command supports any of the global flags.
mc legalhold set to enable legal hold on objects:
mc legalhold set [--recursive] ALIAS/PATH
Legal Holds are indefinite and enforce complete immutability for locked objects.
Only privileged users with the
s3:PutObjectLegalHold can set or
lift the Legal Hold.
Legal holds are complementary to both GOVERNANCE Mode and
COMPLIANCE Mode retention settings. An object held under
both legal hold and a
GOVERNANCE/COMPLIANCE retention rule remains WORM
locked until the legal hold is lifed and the rule expires.
GOVERNANCE locked objects, the legal hold prevents mutating the object
even if the user has the necessary privileges to bypass retention.
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.