mc version

Description

The mc version command enables, suspends, and retrieves the versioning configuration for a MinIO bucket.

The following command enables, suspends, and retrieves versioning for the mydata bucket on the myminio MinIO deployment:

mc version enable myminio/mydata
mc version info myminio/mydata
mc version suspend myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] version                    \
                 [enable | suspend | info]  \
                 ALIAS
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated 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

enable

Enables versioning on the MinIO bucket specified to ALIAS.

Mutually exclusive with suspend and info

suspend

Disables versioning on the MinIO bucket specified to ALIAS.

Mutually exclusive with suspend and info

info

Returns the versioning configuration for the MinIO bucket specified to ALIAS.

Mutually exclusive with suspend and info

ALIAS

Required The alias of a MinIO deployment and the full path to the bucket for which to set the versioning configuration. For example:

mc version enable myminio/mybucket

Global Flags

--JSON
Optional

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND

Examples

Enable Bucket Versioning

Use mc version suspend to enable versioning on a bucket:

mc version ALIAS/PATH
  • Replace ALIAS with the alias of a configured MinIO deployment.

  • Replace PATH with the bucket on which to enable versioning.

Disable Bucket Versioning

Use mc version suspend to suspend versioning on a bucket:

mc version ALIAS/PATH
  • Replace ALIAS with the alias of a configured MinIO deployment.

  • Replace PATH with the bucket on which to suspend versioning.

Get Bucket Versioning Status

Use mc version info to enable versioning on a bucket:

mc version ALIAS/PATH
  • Replace ALIAS with the alias of a configured MinIO deployment.

  • Replace PATH with the bucket on which to retrieve the versioning status.

Behavior

Object Locking Enables Bucket Versioning

While bucket versioning is disabled by default, configuring object locking on a bucket or an object in that bucket automatically enables versioning for the bucket. See mc retention for more information on configuring object locking.

Bucket Versioning with Existing Data

Enabling bucket versioning on a bucket with existing data immediately applies a versioning ID to any unversioned object.

Disabling bucket versioning on a bucket with existing versioned data does not remove any versioned objects. Applications can continue to access versioned data after disabling bucket versioning. Use mc rm --versions ALIAS/BUCKET/OBJECT to delete an object and all its versions.

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested 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.