Reference

• 1: mc ilm add
• 2: mc quota clear
• 3: MinIO Custom Resource Definition
• 4: Silo Client (mcli / mc)
  • 4.1: mc alias list
  • 4.2: mc anonymous set
  • 4.3: mc batch cancel
  • 4.4: mc encrypt clear
  • 4.5: mc event add
  • 4.6: mc idp ldap accesskey disable
  • 4.7: mc idp ldap add
  • 4.8: mc idp ldap policy attach
  • 4.9: mc ilm restore
  • 4.10: mc ilm rule add
  • 4.11: mc ilm tier add
  • 4.12: mc legalhold clear
  • 4.13: mc license info
  • 4.14: mc replicate add
  • 4.15: mc retention set
  • 4.16: mc share download
  • 4.17: mc support callhome
  • 4.18: mc support top api
  • 4.19: mc tag set
  • 4.20: mc version enable
  • 4.21: Silo Client Settings
  • 4.22: mc alias
  • 4.23: mc alias remove
  • 4.24: mc anonymous get
  • 4.25: mc batch describe
  • 4.26: mc encrypt info
  • 4.27: mc event ls
  • 4.28: mc idp ldap accesskey edit
  • 4.29: mc idp ldap disable
  • 4.30: mc idp ldap policy detach
  • 4.31: mc ilm rule
  • 4.32: mc ilm rule edit
  • 4.33: mc ilm tier check
  • 4.34: mc legalhold info
  • 4.35: mc license register
  • 4.36: mc replicate backlog
  • 4.37: mc retention info
  • 4.38: mc share upload
  • 4.39: mc support diag
  • 4.40: mc support top locks
  • 4.41: mc tag list
  • 4.42: mc version info
  • 4.43: mc alias set
  • 4.44: mc anonymous
  • 4.45: mc anonymous list
  • 4.46: mc batch generate
  • 4.47: mc encrypt set
  • 4.48: mc event rm
  • 4.49: mc idp ldap accesskey enable
  • 4.50: mc idp ldap enable
  • 4.51: mc idp ldap policy entities
  • 4.52: mc ilm rule export
  • 4.53: mc ilm tier
  • 4.54: mc ilm tier info
  • 4.55: mc legalhold set
  • 4.56: mc license update
  • 4.57: mc replicate ls
  • 4.58: mc retention clear
  • 4.59: mc share ls
  • 4.60: mc support inspect
  • 4.61: mc support top disk
  • 4.62: mc tag remove
  • 4.63: mc version suspend
  • 4.64: mc alias import
  • 4.65: mc anonymous links
  • 4.66: mc batch
  • 4.67: mc batch list
  • 4.68: mc idp ldap accesskey info
  • 4.69: mc idp ldap info
  • 4.70: mc ilm rule import
  • 4.71: mc ilm tier ls
  • 4.72: mc replicate update
  • 4.73: mc support perf
  • 4.74: mc support top net
  • 4.75: mc alias export
  • 4.76: mc anonymous get-json
  • 4.77: mc batch start
  • 4.78: mc cat
  • 4.79: mc idp ldap accesskey ls
  • 4.80: mc idp ldap ls
  • 4.81: mc ilm rule ls
  • 4.82: mc ilm tier rm
  • 4.83: mc replicate resync
  • 4.84: mc support profile
  • 4.85: mc support top rpc
  • 4.86: mc anonymous set-json
  • 4.87: mc batch status
  • 4.88: mc cp
  • 4.89: mc idp ldap accesskey rm
  • 4.90: mc idp ldap rm
  • 4.91: mc ilm rule rm
  • 4.92: mc ilm tier update
  • 4.93: mc replicate rm
  • 4.94: mc support proxy
  • 4.95: mc diff
  • 4.96: mc idp ldap update
  • 4.97: mc replicate status
  • 4.98: mc support top
  • 4.99: mc du
  • 4.100: mc replicate export
  • 4.101: mc support upload
  • 4.102: mc encrypt
  • 4.103: mc replicate import
  • 4.104: mc event
  • 4.105: mc find
  • 4.106: mc get
  • 4.107: mc head
  • 4.108: mc idp ldap
  • 4.109: mc idp ldap accesskey
  • 4.110: mc idp ldap accesskey create-with-login
  • 4.111: mc idp ldap policy
  • 4.112: mc idp openid
  • 4.113: mc ilm
  • 4.114: mc legalhold
  • 4.115: mc license
  • 4.116: mc ls
  • 4.117: mc mb
  • 4.118: mc mirror
  • 4.119: mc mv
  • 4.120: mc od
  • 4.121: mc ping
  • 4.122: mc pipe
  • 4.123: mc put
  • 4.124: mc rb
  • 4.125: mc ready
  • 4.126: mc replicate
  • 4.127: mc retention
  • 4.128: mc rm
  • 4.129: mc share
  • 4.130: mc sql
  • 4.131: mc stat
  • 4.132: mc support
  • 4.133: mc tag
  • 4.134: mc tree
  • 4.135: mc undo
  • 4.136: mc update
  • 4.137: mc version
  • 4.138: mc watch
  • 4.139: mc idp ldap accesskey create
• 5: mc ilm edit
• 6: mc quota info
• 7: MinIO Operator Environment Variables
• 8: Silo Client Administration
  • 8.1: mc admin accesskey
  • 8.2: mc admin accesskey create
  • 8.3: mc admin cluster bucket import
  • 8.4: mc admin cluster iam import
  • 8.5: mc admin policy attach
  • 8.6: mc admin prometheus generate
  • 8.7: mc admin scanner status
  • 8.8: mc admin user add
  • 8.9: mc admin user svcacct add
  • 8.10: mc admin accesskey disable
  • 8.11: mc admin cluster bucket
  • 8.12: mc admin cluster bucket export
  • 8.13: mc admin cluster iam export
  • 8.14: mc admin policy create
  • 8.15: mc admin prometheus metrics
  • 8.16: mc admin scanner trace
  • 8.17: mc admin user disable
  • 8.18: mc admin user svcacct disable
  • 8.19: mc admin cluster iam
  • 8.20: mc admin policy detach
  • 8.21: mc admin user accesskey edit
  • 8.22: mc admin user enable
  • 8.23: mc admin user svcacct edit
  • 8.24: mc admin accesskey enable
  • 8.25: mc admin config
  • 8.26: mc admin policy entities
  • 8.27: mc admin user info
  • 8.28: mc admin user svcacct enable
  • 8.29: mc admin accesskey info
  • 8.30: mc admin decommission
  • 8.31: mc admin policy info
  • 8.32: mc admin user ls
  • 8.33: mc admin user svcacct info
  • 8.34: mc admin accesskey ls
  • 8.35: mc admin group
  • 8.36: mc admin policy ls
  • 8.37: mc admin user rm
  • 8.38: mc admin user svcacct ls
  • 8.39: mc admin accesskey rm
  • 8.40: mc admin heal
  • 8.41: mc admin policy rm
  • 8.42: mc admin user sts info
  • 8.43: mc admin user svcacct rm
  • 8.44: mc admin info
  • 8.45: mc admin user svcacct
  • 8.46: mc admin kms key
  • 8.47: mc admin logs
  • 8.48: mc admin policy
  • 8.49: mc admin prometheus
  • 8.50: mc admin rebalance
  • 8.51: mc admin replicate
  • 8.52: mc admin scanner
  • 8.53: mc admin service
  • 8.54: mc admin trace
  • 8.55: mc admin update
  • 8.56: mc admin user
• 9: mc ilm export
• 10: mc quota set
• 11: Operator Helm Charts
• 12: Silo Server (minio)
  • 12.1: Settings Overview
    • 12.1.1: Core Settings
    • 12.1.2: Root Access Settings
    • 12.1.3: Erasure Code Settings
    • 12.1.4: Silo Console Settings
    • 12.1.5: Metrics and Logging Settings
    • 12.1.6: Bucket Notifications Settings
      • 12.1.6.1: AMQP Notification Settings
      • 12.1.6.2: Elasticsearch Notification Settings
      • 12.1.6.3: Kafka Notification Settings
      • 12.1.6.4: MQTT Notification Settings
      • 12.1.6.5: MySQL Notification Settings
      • 12.1.6.6: NATS Notification Settings
      • 12.1.6.7: NSQ Notification Settings
      • 12.1.6.8: PostgreSQL Notification Settings
      • 12.1.6.9: Redis Notification Settings
      • 12.1.6.10: Webhook Service Notification Settings
    • 12.1.7: Identity and Access Management Settings
      • 12.1.7.1: Active Directory / LDAP Settings
      • 12.1.7.2: OpenID Identity Management Settings
      • 12.1.7.3: Silo Identity Management Plugin Settings
      • 12.1.7.4: Silo Access Management Plugin Settings
    • 12.1.8: ILM Settings
    • 12.1.9: Key Encryption Service Settings
    • 12.1.10: Object Lambda function settings
    • 12.1.11: Deprecated Settings
• 13: Deprecated Commands
• 14: mc ilm import
• 15: Tenant Helm Charts
• 16: mc ilm ls
• 17: mc ilm rm
• 18: mc quota
• 19: mc admin bucket quota
• 20: mc admin bucket remote
• 21: mc admin console
• 22: mc admin idp ldap
• 23: mc admin idp ldap policy
• 24: mc admin idp openid
• 25: mc admin profile
• 26: mc admin speedtest
• 27: mc admin tier
• 28: mc admin top
• 29: Kubernetes Reference
• 30: Baremetal Reference
• 31: S3 API Compatibility

1 - mc ilm add

Syntax

The mc ilm add command adds an object lifecycle management rule to a bucket.

The command supports adding both Transition (Tiering) and Expiration lifecycle management rules.

mc ilm add --expire-days 90 --noncurrent-expire-days 30 myminio/mydata

mc ilm add --expire-delete-marker myminio/mydata

mc ilm add --transition-days 30 --transition-tier "COLDTIER" myminio/mydata

mc ilm add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"

mc [GLOBALFLAGS] ilm add                                    \
                 [--prefix string]                          \
                 [--tags string]                            \
                 --expire-days "integer"                    \
                 [--expire-delete-marker]                   \
                 [--transition-days "string"]               \
                 [--transition-tier "string"]               \
                 [--noncurrent-expire-days "integer"]       \
                 [--noncurrent-expire-newer "integer"]      \
                 [--noncurrent-transition-days "integer"]   \
                 [--noncurrent-transition-tier "string"]    \
                 ALIAS

Parameters

ALIAS

mc-cmd

Required

The alias and bucket on the MinIO deployment to which to add the object lifecycle management rule.

For example:

mc ilm add myminio/mydata

--prefix

mc-cmd

Optional

Restrict the management rule to a specific object prefix.

For example:

mc ilm add --prefix "meetingnotes/" myminio/mydata/ --expire-days "90"

The command creates a rule that expires objects in the mydata bucket of the myminio ALIAS after 90 days for any object with the meetingnotes/ prefix.

--tags

mc-cmd

Optional

One or more ampersand &-delimited key-value pairs describing the object tags to use for filtering objects to which the lifecycle configuration rule applies.

This option is mutually exclusive with the following option:

• --expire-delete-marker

--expire-days

mc-cmd

Required

The number of days to retain an object after being created. MinIO marks the object for deletion after the specified number of days pass. Specify the number of days as an integer, e.g. 30 for 30 days.

For versioned buckets, the expiry rule applies only to the current object version. Use the --noncurrent-expire-days option to apply expiration behavior to noncurrent object versions.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

Mutually exclusive with the following options:

• --expire-delete-marker

For more complete documentation on object expiration, see Object Expiration and Object Deletion.

--expire-delete-marker

mc-cmd

Optional

Specify this option to direct MinIO to remove delete markers for objects with no remaining object versions. Specifically, the delete marker is the only remaining “version” of the given object.

This option is mutually exclusive with the following option:

• --tags
• --expire-days

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

For more complete documentation on object expiration, see Object Expiration and Object Deletion.

--transition-days

mc-cmd

Optional

The number of calendar days from object creation after which MinIO marks an object as eligible for transition. MinIO transitions the object to the configured remote tier specified to the --transition-tier. Specify the number of days as an integer, e.g. 30 for 30 days.

For versioned buckets, the transition rule applies only to the current object version. Use the --noncurrent-transition-days option to apply transition behavior to noncurrent object versions.

Requires specifying --transition-tier.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

For more complete documentation on object transition, see Object Transition (“Tiering”).

--transition-tier

mc-cmd

Optional

The remote tier to which MinIO transition objects. Specify an existing remote tier created by mc admin tier.

Required if specifying --transition-days.

--noncurrent-expire-days

mc-cmd

Optional

The number of days to retain an object version after becoming non-current (i.e. a different version of that object is now the HEAD). MinIO marks noncurrent object versions for deletion after the specified number of days pass.

This option has the same behavior as the S3 NoncurrentVersionExpiration action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

--noncurrent-transition-days

mc-cmd

Optional

The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition. MinIO transitions the object to the configured remote tier specified to the --transition-tier once the system host datetime passes that calendar date.

This option has no effect on non-versioned buckets. Requires specifying --noncurrent-transition-tier.

This option has the same behavior as the S3 NoncurrentVersionTransition action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

--noncurrent-transition-tier

mc-cmd

Optional

The remote tier to which MinIO transitions noncurrent objects versions. Specify a remote tier created by mc admin tier.

--noncurrent-expire-newer

mc-cmd

Optional

The maximum number of non-current object versions to retain, ordered from newest to oldest.

Use this flag to retain a certain number of past versions of a file in a first in, first out fashion. After retaining the maximum number of non-current versions, MinIO marks any remaining older non-current object versions as eligible for expiration.

The following table lists a number of object versions and their expiration eligibility based on --noncurrent-expire-newer 3:

MinIO retains the current version, v5. MinIO also retains the next 3 non-current versions, starting with the newest. This means MinIO marks v4, v3, and v2 for the three non-current version to retain.

v1 would be a fourth non-current version, which falls outside the limit of non-current versions to retain, so MinIO marks v1 for expiration.

Updating the number for this flag only impacts the unmarked versions of objects. Any versions already marked for expiration do not change if you increase the number to retain.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

Global Flags

This command supports any of the global flags.

Examples

Expire All Bucket Contents After Number of Days

Use mc ilm add with --expire-days to mark bucket contents for expiration after a number of days pass from the object’s creation:

mc ilm add ALIAS/PATH --expire-days "DAYS"

• Replace ALIAS with the alias of the S3-compatible host.
• Replace PATH with the path to the bucket on the S3-compatible host.
• Replace DATE with the number of days after which to expire the object. For example, specify 30 to expire the object 30 days after creation.

Transition Non-Current Object Versions at a Prefix to a Different Tier

Use the mc ilm add with --prefix and --transition-tier to transition older non-current versions of an object to a different storage tier.

mc ilm add --prefix "doc/" --transition-days "90" --trasition-tier "MINIOTIER-1"                  \
       --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-2"  \
       myminio/mybucket/

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

• Current objects in the prefix older than 90 days move to the MINIOTIER-1 storage tier.
• Non-current objects in the prefix older than 45 days move to the MINIOTIER-2 storage tier.
• Both MINIOTIER-1 and MINIOTIER-2 have already been created with mc admin tier add.

Expire All Objects at a Prefix, Retain Current Object Versions Longer Than Non-Current Object Versions

Use the mc ilm add command with --prefix, --expire-days, and --noncurrent-expire-days to expire current and non-current versions of an object at different times.

mc ilm add --prefix "doc/" --expire-days "300" --noncurrent-expire-days "100" myminio/mybucket/

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

• Current objects expire after 300 days.
• Non-current objects expire after 100 days.

Behavior

Lifecycle Management Object Scanner

MinIO uses a scanner process to check objects against the configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

Expiry vs Transition

MinIO supports specifying both expiry and transition rules in the same bucket or bucket prefix. MinIO can execute an expiration rule on an object regardless of its transition status. Use mc ilm ls to review the currently configured object lifecycle management rules for any potential interactions between expiry and transition rules.

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.

2 - mc quota clear

Description

The mc quota clear command removes a configured storage quota for a bucket.

Examples

Clear Configured Bucket Quota

Use mc quota clear flag to remove the quota from a bucket.

mc quota clear TARGET/BUCKET

• Replace TARGET with the alias of a configured MinIO deployment. Replace BUCKET with the name of the bucket on which to clear the quota.

Syntax

mc quota clear has the following syntax:

mc quota clear TARGET [ARGUMENTS]

mc quota clear supports the following arguments:

TARGET

mc-cmd

Required

The full path to the bucket for which the command creates the quota. Specify the alias of the MinIO deployment as a prefix to the path. For example:

mc quota clear play/mybucket

Global Flags

This command supports any of the global flags.

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.

3 - MinIO Custom Resource Definition

The MinIO Operator installs a Custom Resource Definition (CRD) that describes a MinIO Tenant object. The Operator uses this CRD for provisioning and managing Tenant resources within a Kubernetes cluster.

This page documents the CRD reference for use in customizing Operator-deployed Tenants. This documentation assumes familiarity with all referenced Kubernetes concepts, utilities, and procedures.

Operator CRD v2 Reference

Package v2 - This page provides a quick automatically generated reference for the MinIO Operator Operator CRD v2 Reference CRD. For more complete documentation on the MinIO Operator CRD, see MinIO Kubernetes Documentation.

The Operator CRD v2 Reference API was released with the v4.0.0 MinIO Operator. The MinIO Operator automatically converts existing tenants using the /v1 API to /v2.

• Tenant

Bucket

Bucket describes the default created buckets

• TenantSpec

CertificateConfig

CertificateConfig (certConfig) defines controlling attributes associated to any TLS certificate automatically generated by the Operator as part of tenant creation. These fields have no effect if spec.autoCert: false.

• TenantSpec

CertificateStatus

CertificateStatus keeps track of all the certificates managed by the operator

• TenantStatus

CustomCertificateConfig

CustomCertificateConfig (customCertificateConfig) provides attributes associated of the TLS certificates manually added to the Operator as part of tenant creation. These fields contain no data if there are no custom TLS certificates.

• CustomCertificates

CustomCertificates

CustomCertificates (customCertificates) provides groupings of the TLS certificates manually added to the Operator as part of tenant creation. These fields contain no data if there are no custom TLS certificates.

• CertificateStatus

ExposeServices

ExposeServices (exposeServices) defines the exposure of the MinIO object storage and Console services.

• TenantSpec

Features

Features (features) - Object describing which MinIO features to enable/disable in the MinIO Tenant.

• TenantSpec

HealthStatus (string)

HealthStatus represents whether the tenant is healthy, with decreased service or offline

• TenantStatus

KESConfig

KESConfig (kes) defines the configuration of the MinIO Key Encryption Service (KES) StatefulSet deployed as part of the MinIO Tenant. KES supports Server-Side Encryption of objects using an external Key Management Service (KMS).

• TenantSpec

Specify the GCP default credentials to be used for KES to authenticate to GCP key store

Specify the name of the workload identity pool (This is required for generating service account token)

LocalCertificateReference

LocalCertificateReference (externalCertSecret, externalCaCertSecret,clientCertSecret) contains a Kubernetes secret containing TLS certificates or Certificate Authority files for use with enabling TLS in the MinIO Tenant.

• KESConfig
• TenantSpec

Logging

Logging describes Logging for MinIO tenants.

• TenantSpec

Pool

Pool (pools) defines a MinIO server pool on a Tenant. Each pool consists of a set of MinIO server pods which “pool” their storage resources for supporting object storage and retrieval requests. Each server pool is independent of all others and supports horizontal scaling of available storage resources in the MinIO Tenant.

See the MinIO Operator CRD reference for the pools object for examples and more complete documentation.

• TenantSpec

PoolState (string)

PoolState represents the state of a pool

• PoolStatus

PoolStatus

PoolStatus keeps track of all the pools and their current state

• TenantStatus

PoolsMetadata

PoolsMetadata (poolsMetadata) defines custom labels and annotations for the MinIO pool stateful sets / pods.

• TenantSpec

ServiceMetadata

ServiceMetadata (serviceMetadata) defines custom labels and annotations for the MinIO Object Storage service and/or MinIO Console service.

• TenantSpec

SideCars

SideCars (sidecars) defines a list of containers that the Operator attaches to each MinIO server pods in the pool.

• TenantSpec

Tenant

Tenant is a Kubernetes object describing a MinIO Tenant.

• TenantList

TenantDomains

TenantDomains (domains) - List of domains used to access the tenant from outside the kubernetes clusters. this will only configure MinIO for the domains listed, but external DNS configuration is still needed. The listed domains should include schema and port if any is used, i.e. https://minio.domain.com:8123

• Features

TenantScheduler

TenantScheduler (scheduler) - Object describing Kubernetes Scheduler to use for deploying the MinIO Tenant.

• Tenant

TenantSpec

TenantSpec (spec) defines the configuration of a MinIO Tenant object.

The following parameters are specific to the Operator CRD v2 Reference MinIO CRD API spec definition added as part of the MinIO Operator v4.0.0.

For more complete documentation on this object, see the MinIO Kubernetes Documentation.

• Tenant

certs/
├── client-0/
│   ├── client.crt
│   └── client.key
├── client-1/
│   ├── client.crt
│   └── client.key
└── client-2/
    ├── client.crt
    └── client.key

TenantUsage

TenantUsage are metrics regarding the usage and capacity of the tenant

• TenantStatus

TierUsage

TierUsage represents the usage from a tier setup by the tenant

• TenantUsage

4 - Silo Client (mcli / mc)

The Pigsty-maintained client is distributed as mcli in standalone archives and Linux packages. Its source build, container entrypoint, configuration directory, module path, and command syntax retain mc for compatibility. It provides familiar commands such as ls, cat, cp, mirror, and diff for filesystems and Amazon S3-compatible object storage.

The mc command-line tool is built for compatibility with the AWS S3 API. Its current source retains compatibility with Silo, upstream MinIO, and AWS S3.

The Silo project cannot guarantee behavior against every other S3-compatible service because implementations differ. Test the operations your workload relies on before treating another service as compatible.

mc has the following syntax:

mc [GLOBALFLAGS] COMMAND --help

See Command Quick Reference for a list of supported commands.

Version Alignment with Silo Server

The client releases separately from the Silo server.

For best functionality and compatibility, use a client version released close to your Silo or MinIO server version. A client released on the same day or later than the server is generally the safer choice.

You can install a client newer than the server. If the versions skew too far apart, however, administrative features or flags may differ even when core S3 operations such as mc cp remain compatible.

Quickstart

1) Install the client

Use Download & Install to select a Linux package, an archive for Linux, macOS, or Windows, or the client container. Versioned artifacts and checksums are also available from GitHub Releases.

Standalone archives and Linux packages install the command as mcli. The container and source build retain mc. The commands are aliases of the same client; when this reference shows mc, substitute mcli if that is the name installed on your host.

To build the maintained fork from source:

git clone https://github.com/pgsty/mc.git
cd mc
make build
./mc --version

2) Create an Alias for the S3-Compatible Service

Use the mc alias set command to add an Amazon S3-compatible service to the mc configuration.

bash +o history
mc alias set ALIAS HOSTNAME ACCESS_KEY SECRET_KEY
bash -o history

• Replace ALIAS with a name to associate to the S3 service. mc commands typically require ALIAS as an argument for identifying which S3 service to execute against.
• Replace HOSTNAME with the URL endpoint or IP address of the S3 service.
• Replace ACCESS_KEY and SECRET_KEY with the access and secret keys for a user on the S3 service.

Replace each argument with the required values. If you omit the ACCESS_KEY and SECRET_KEY, the command prompts you to enter those values in the CLI.

Each of the following tabs contains a provider-specific example:

mc alias set silo https://silo.example.net ACCESS_KEY SECRET_KEY

mc alias set myS3 https://s3.{your-region-code}.amazonaws.com/endpoint ACCESS_KEY SECRET_KEY

mc alias set myGCS https://storage.googleapis.com/endpoint ACCESS_KEY SECRET_KEY

3) Test the Connection

Use the mc admin info command to test the connection to the newly added Silo deployment:

mc admin info silo

The command returns information on the S3 service if successful. If unsuccessful, check each of the following:

• The host machine has connectivity to the S3 service URL (i.e. using ping or traceroute).

• The specified ACCESSKEY and SECRETKEY correspond to a user on the S3 service. The user must have permission to perform actions on the service.

  For MinIO deployments, see Access Management for more information on user access permissions. For other S3-compatible services, defer to the documentation for that service.

Command Quick Reference

The following table lists mc commands:

Configuration File

mc uses a JSON formatted configuration file used for storing certain kinds of information, such as the aliases for each configured S3-compatible service.

For Linux and macOS, the default configuration file location is ~/.mc/config.json.

For Windows, mc attempts to construct a default file path by trying specific environment variables. If a variable is unset, mc moves to the next variable. If all attempts fail, mc returns an error. The following list describes each possible file path location in the order mc checks them:

1. HOME\.mc\config.json
2. USERPROFILE\.mc\config.json
3. HOMEDRIVE+HOMEPATH\.mc\config.json

You can use the --config-dir

Certificates

The MinIO Client stores certificates and CAs for deployments to the following paths:

Linux, macOS, and other Unix-like systems:

~/.mc/certs/ # certificates
~/.mc/certs/CAs/ # Certificate Authorities

Windows systems:

C:\Users\[username]\mc\certs\ # certificates
C:\Users\[username]\mc\certs\CAs\ # Certificate Authorities

When creating a new alias, the MinIO Client fetches the peer certificate, computes the public key fingerprint, and asks the user whether to accept the deployment’s certificate. If you decide to trust the certificate, the MinIO Client adds the certificate to the certificate authority path listed above.

Pattern Matching

Some commands and flags allow for pattern matching. When enabled, a pattern can include either of these wildcards for character replacement:

• * to represent a string of characters to match, either in the middle or end.
• ? to represent a single character.

For example, refer to the following examples for wildcard uses and their results.

Global Options

All commands support the following global options. You can also define some of these options using Environment Variables.

--config-dir

option

The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

Alternatively, set the environment variable MC_CONFIG_DIR.

--debug

option

Enables verbose output to the console.

For example, the following operation adds verbose output to the mc ls command:

mc --debug ls play

Alternatively, set the environment variable MC_DEBUG.

--disable-pager --dp

option

Disable the pager functionality of the MinIO Client in the CLI. When used, output prints to raw STDOUT instead.

--insecure

option

Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

Alternatively, set the environment variable MC_INSECURE.

--json

option

Enables JSON lines formatted output to the console.

For example, the following operation adds JSON Lines output to the mc ls command:

mc --json ls play

Alternatively, set the environment variable MC_JSON.

--no-color

option

Disables the built-in color theme for console output. Useful for dumb terminals.

Alternatively, set the environment variable MC_NO_COLOR.

--quiet

option

Suppresses console output.

Alternatively, set the environment variable MC_QUIET.

--resolve

option

Creates a custom DNS mapping to resolve a HOST to a specified IP address.

Use the following syntax:

--resolve HOST[:PORT]=IP

For example:

mc alias set --resolve myminio.example.com:9000=192.168.188.118 'myminio' 'https://myminio.example.com:9000' 'miniouser' 'miniosecret'

Repeat the flag multiple times to add additional custom DNS mappings.

--version

option

Displays the current version of mc.

--help

mc-cmd

Optional

Displays a summary of command usage on the terminal.

4.1 - mc alias list

Syntax

The mc alias list command lists all aliases in the local mc configuration.

The command output includes the configured access key and secret key associated to each alias.

mc alias list

mc [GLOBALFLAGS] alias list [ALIAS]

Parameters

ALIAS

mc-cmd

Optional The name of a specific alias to display.

Global Flags

This command supports any of the global flags.

Examples

List All Configured Aliases

mc alias list

mc alias list

List a Specific Alias

mc alias list myminio

mc alias list ALIAS

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.

4.2 - mc anonymous set

Syntax

The mc anonymous set command sets anonymous (i.e. unauthenticated or public) access policies for a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

To set anonymous bucket policies using an IAM JSON policy, use the mc anonymous set-json command.

mc anonymous set upload myminio/uploads
mc anonymous set download myminio/downloads
mc anonymous set public myminio/public

mc [GLOBALFLAGS] policy set PERMISSION ALIAS

Parameters

PERMISSION

mc-cmd

Required Name of the policy to assign to the specified ALIAS. Specify one of the following values:

• none - Disable anonymous access to the ALIAS.
• download - Enable download-only access to the ALIAS.
• upload - Enable upload-only access to the ALIAS.
• public - Enable download and upload access to the ALIAS.

ALIAS

mc-cmd

Required The full path to the bucket or bucket prefix to which the command applies the specified PERMISSION.

Specify the alias of the MinIO or other S3-compatible service and the full path to the bucket or bucket prefix. For example:

mc anonymous set public play/mybucket

Specify a bucket prefix to set the policy on only that prefix. For example, this command sets distinct anonymous bucket policies on the mybucket/downloads and mybucket/uploads prefixes:

mc anonymous set download play/mybucket/downloads
mc anonymous set upload play/mybucket/uploads

Global Flags

This command supports any of the global flags.

Examples

Set Anonymous Policy for Bucket

Use mc anonymous set to set the anonymous policy for a bucket:

mc anonymous set POLICY ALIAS/PATH

• Replace POLICY with a supported permission.
• Replace ALIAS with the alias of a configured S3-compatible host.
• Replace PATH with the destination bucket.

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.

4.3 - mc batch cancel

Syntax

The mc batch cancel stops an ongoing batch job.

You must specify the job ID. To find the job ID, use mc batch list.

mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf

mc [GLOBALFLAGS] batch cancel ALIAS JOBID

Parameters

ALIAS

mc-cmd

Required

The alias for the MinIO deployment on which the job is currently running.

JOBID

mc-cmd

Required

The unique identifier of the batch job to cancel. To find the ID of a job, use mc batch list.

Global Flags

This command supports any of the global flags.

Example

Cancel an ongoing batch job

The following command cancels the job with ID KwSysDpxcBU9FNhGkn2dCf on the deployment at alias myminio:

mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf

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.

4.4 - mc encrypt clear

Syntax

The mc encrypt clear command removes the current default encryption settings for a bucket.

mc encrypt clear myminio/mydata

mc [GLOBALFLAGS] encrypt clear ALIAS

Parameters

ALIAS

mc-cmd

The full path to the bucket on which to remove the default SSE mode. Specify the alias of the MinIO deployment as the prefix to the ALIAS path. For example:

mc encrypt clear play/mybucket

Global Flags

This command supports any of the global flags.

Examples

Remove the Automatic Server-Side Encryption Settings for a Bucket

 mc encrypt clear myminio/data

mc encrypt clear ALIAS

Behavior

Modifying Bucket Encryption Settings Does Not Affect Encrypted Objects

Disabling automatic bucket encryption does not decrypt any objects in the bucket.

To permanently decrypt objects in the bucket, you can perform an in-place copy after disabling object decryption. For versioned buckets, the previous object versions remain encrypted.

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.

4.5 - mc event add

Syntax

The mc event add command adds event notification triggers to a bucket.

MinIO automatically sends triggered events to the configured notification target.

mc event add --event "put,delete" myminio/mydata arn:aws:sqs::primary:target

mc [GLOBALFLAGS] event add \
                 [--event "string"]  \
                 [--ignore-existing] \
                 [--prefix "string"] \
                 [--suffix "string"] \
                 ALIAS               \
                 ARN

Parameters

ALIAS

mc-cmd

Required

The MinIO alias and bucket to which the command adds the new event notification. For example:

mc event add play/mybucket

ARN

mc-cmd

Required

The Amazon Resource Name (ARN) of the notification target.

The MinIO server outputs an ARN for each configured notification target at server startup. See Bucket Notifications for more information.

--event

mc-cmd

Optional

The event(s) for which MinIO generates bucket notifications.

Supports the following values:

• put
• get
• delete

Specify multiple value using a comma , delimiter. Do not add any whitespace between values.

If not specified, defaults to put,delete,get.

See Supported Bucket Events for a detailed list of S3 events associated to each of the supported values.

ignore-existing, p

mc-cmd

Optional

Directs MinIO to ignore the specified event triggers if a matching trigger already exists.

--prefix

mc-cmd

Optional

The bucket prefix in which the specified --event can trigger a bucket notification.

For example, given a ALIAS of play/mybucket and a --prefix of photos, only events in play/mybucket/photos trigger bucket notifications.

Omit to trigger the event for all prefixes and objects in the bucket.

--suffix

mc-cmd

Optional

The bucket suffix in which the specified --event can trigger a bucket notification.

For example, given a ALIAS of play/mybucket and a --suffix of .jpg, only events in play/mybucket/*.jpg trigger bucket notifications.

Omit to trigger the event for all objects regardless of suffix.

Global Flags

This command supports any of the global flags.

Examples

Add an Event Notification to a Bucket

mc event add myminio/mydata arn:minio:sqs::primary:webhook

mc event add ALIAS ARN

Behavior

Supported Bucket Events

The following table lists the supported mc event add values and their corresponding S3 events:

For more complete documentation on the listed S3 events, see S3 Supported Event Types.

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.

4.6 - mc idp ldap accesskey disable

Description

mc idp ldap accesskey disable disables the specified access key on the MinIO deployment.

mc idp ldap accesskey disable minio mykey

mc [GLOBALFLAGS] idp ldap accesskey disable  \
                                 ALIAS       \
                                 KEY

Parameters

ALIAS

mc-cmd

Required

The alias of the MinIO deployment configured for AD/LDAP.

For example:

mc idp ldap accesskey disable minio

KEY

mc-cmd

Required

The configured access key to disable.

Example

Disable the access key mykey from the minio deployment.

mc idp ldap accesskey disable minio/ mykey

Global Flags

This command supports any of the global flags.

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.

4.7 - mc idp ldap add

Description

The mc idp ldap add command creates an AD/LDAP IDP server configuration.

MinIO supports no more than one (1) AD/LDAP provider per deployment.

mc idp ldap add                                                            \
            myminio                                                        \
            server_addr=myldapserver:636                                   \
            lookup_bind_dn=cn=admin,dc=min,dc=io                           \
            lookup_bind_password=somesecret                                \
            user_dn_search_base_dn=dc=min,dc=io                            \
            user_dn_search_filter="(uid=%s)"                               \
            group_search_base_dn=ou=swengg,dc=min,dc=io                    \
            group_search_filter="(&(objectclass=groupofnames)(member=%d))"

mc [GLOBALFLAGS] idp ldap add               \
                          ALIAS             \
                          [CFG_PARAM1]      \
                          [CFG_PARAM2]...

Parameters

ALIAS

mc-cmd

Required

The alias of the MinIO deployment on which to add an AD/LDAP integration.

For example:

mc idp ldap add myminio                               \
                server_addr=myldapserver:636          \
                lookup_bind_dn=cn=admin,dc=min,dc=io  \
                lookup_bind_password=somesecret       \
                user_dn_search_base_dn=dc=min,dc=io   \
                user_dn_search_filter="(uid=%s)"      \

server_addr

mc-cmd

Required

Specify the hostname for the Active Directory / LDAP server. For example:

ldapserver.com:636

This parameter corresponds with the MINIO_IDENTITY_LDAP_SERVER_ADDR environment variable.

lookup_bind_dn

mc-cmd

Required

Specify the Distinguished Name (DN) for an AD/LDAP account MinIO uses when querying the AD/LDAP server. Enables Lookup-Bind authentication to the AD/LDAP server.

The DN account should be a read-only access keys with sufficient privileges to support querying performing user and group lookups.

This parameter corresponds with the MINIO_IDENTITY_LDAP_LOOKUP_BIND_DN environment variable.

lookup_bind_password

mc-cmd

Required

Specify the password for the Lookup-Bind user account.

This parameter corresponds with the MINIO_IDENTITY_LDAP_LOOKUP_BIND_PASSWORD environment variable.

user_dn_attributes

mc-cmd

Optional

Comma-separated list of user DN attributes.

Some valid values include, uid,cn,mail,sshPublicKey.

To enable public authentication for LDAP users, pass sshPublicKey as a DN attribute. The user can then use the passed SSH Public Key to log in to SFTP servers.

mc idp ldap update ALIAS user_dn_attributes=sshPublicKey

user_dn_search_base_dn

mc-cmd

Required

Specify the base Distinguished Name (DN) MinIO uses when querying for user credentials matching those provided by an authenticating client.

Separate multiple DNs with a semicolon (;).

For example:

cn=miniousers,dc=myldapserver,dc=net;ou=swengg,dc=min,dc=io

Supports Lookup-Bind mode.

This parameter corresponds with the MINIO_IDENTITY_LDAP_USER_DN_SEARCH_BASE_DN environment variable.

user_dn_search_filter

mc-cmd

Required

Specify the AD/LDAP search filter MinIO uses when querying for user credentials matching those provided by an authenticating client.

Use the %s substitution character to insert the client-specified username into the search string. For example:

(userPrincipalName=%s)

This parameter corresponds with the MINIO_IDENTITY_LDAP_USER_DN_SEARCH_FILTER environment variable.

comment

mc-cmd

Optional

Specify a comment to associate to the AD/LDAP configuration.

This parameter corresponds with the MINIO_IDENTITY_LDAP_COMMENT environment variable.

enabled

mc-cmd

Optional

Set to false to disable the AD/LDAP configuration.

If false, applications cannot generate STS credentials or otherwise authenticate to MinIO using the configured provider.

Defaults to true or “enabled”.

group_search_base_dn

mc-cmd

Optional

Specify a semicolon-separated (;) list of group search base Distinguished Names MinIO uses when performing group lookups.

For example:

cn=miniogroups,dc=myldapserver,dc=net;ou=swengg,dc=min,dc=io

This parameter corresponds with the MINIO_IDENTITY_LDAP_GROUP_SEARCH_BASE_DN environment variable.

group_search_filter

mc-cmd

Optional

Specify an AD/LDAP search filter for performing group lookups for the authenticated user

Use the %s substitution character to insert the client-specified username into the search string. Use the %d substitution character to insert the Distinguished Name of the client-specified username into the search string.

For example:

(&(objectclass=groupOfNames)(memberUid=%s))

When providing an AD/LDAP group search filter, configure a filter that returns the minimum number of relevant groups for the purpose of supporting authentication. Filters that return large group assignments increase the size of associated calls and resources. Functions sensitive to large request or response bodies may exhibit unexpected behaviors as a result.

This parameter corresponds with the MINIO_IDENTITY_LDAP_GROUP_SEARCH_FILTER environment variable.

server_insecure

mc-cmd

Optional

Specify on to allow unsecured (non-TLS encrypted) connections to the AD/LDAP server.

MinIO sends AD/LDAP user credentials in plain text to the AD/LDAP server, such that enabling TLS is required to prevent reading credentials over the wire. Using this option presents a security risk where any user with access to network traffic can observe the unencrypted plaintext credentials.

Defaults to off.

This parameter corresponds with the MINIO_IDENTITY_LDAP_SERVER_INSECURE environment variable.

server_starttls

mc-cmd

Optional

Specify on to enable StartTLS connections to an AD/LDAP server.

Defaults to off

For more about StartTLS, refer to section 4.14 of the LDAP RFC 4511 specification.

This parameter corresponds with the MINIO_IDENTITY_LDAP_SERVER_STARTTLS environment variable.

srv_record_name

mc-cmd

Optional

Specify the appropriate value to enable MinIO to select an AD/LDAP server using a DNS SRV record request.

When enabled, MinIO selects an AD/LDAP server by:

• Constructing the target SRV record name following standard naming conventions.
• Requesting a list of available AD/LDAP servers.
• Choosing an appropriate target based on priority and weight.

The configuration examples below presume the AD/LDAP server address is set to example.com and the SRV record protocol is _tcp.

For SRV record names beginning with _ldap, specify ldap. The constructed DNS SRV record name resembles the following:

_ldap._tcp.example.com

For SRV record names with beginning with _ldaps, specify ldaps. The constructed DNS SRV record name resembles the following:

_ldaps._tcp.example.com

If your DNS SRV record name uses alternate service or protocol names, specify on and provide the full record name as your LDAP server address. Example: _ldapserver._specialtcp.example.com

For more about DNS SRV records, see DNS SRV Records for LDAP.

This parameter corresponds with the MINIO_IDENTITY_LDAP_SRV_RECORD_NAME environment variable.

tls_skip_verify

mc-cmd

Optional

Specify on to trust the AD/LDAP server TLS certificates without verification. This option may be required if the AD/LDAP server TLS certificates are signed by an untrusted Certificate Authority (e.g. self-signed).

Defaults to off

This parameter corresponds with the MINIO_IDENTITY_LDAP_TLS_SKIP_VERIFY environment variable.

Global Flags

This command supports any of the global flags.

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.

4.8 - mc idp ldap policy attach

Description

The mc idp ldap policy attach command attaches one or more polices to an entity.

mc idp ldap policy attach myminio                                                  \
                          userpolicy                                               \
                          --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

mc [GLOBALFLAGS] idp ldap policy attach             \
                                 POLICYNAME         \
                                 [POLICY2] ...      \
                                 ALIAS              \
                                 [--user=`USER`]    \
                                 [--group=`GROUP`]

Parameters

ALIAS

mc-cmd

Required

The alias of the MinIO deployment with the entity to which to attach a policy.

For example:

mc idp ldap policy attach myminio                                                  \
                          userpolicy                                               \
                          --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

Example

The following example attaches two policies, policy1 and policy2, to the projectb group on the myminio deployment:

mc idp ldap policy attach myminio                                                 \
                          policy1                                                 \
                          policy2                                                 \
                          --group='cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'

Global Flags

This command supports any of the global flags.

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.

4.9 - mc ilm restore

Syntax

The mc ilm restore command creates a temporary copy of an object archived on a remote tier. The copy automatically expires after 1 day by default.

Use this command to allow applications to access a tiered object through the MinIO deployment (e.g. “hot tier”). The archived object remains on the remote tier, while the temporary copy becomes HEAD for that object.

mc ilm restore myminio/mybucket/object.txt

mc [GLOBALFLAGS] ilm restore         \
                 [--days "int" ]     \
                 [--recursive]       \
                 [--vid "string"]    \
                 [--versions]        \
                 [--enc-c "string"]  \
                 ALIAS

Parameters

ALIAS

mc-cmd

Required

The MinIO alias, bucket, and path to the archived object to restore.

mc ilm restore myminio/mybucket/object.txt

--days

mc-cmd

Optional

The number of days after which MinIO expires the restored copy of the archived object.

--enc-c

mc-cmd

Optional

Encrypt or decrypt objects using server-side SSE-C encryption with client-managed keys.

The parameter accepts a key-value pair formatted as KEY=VALUE

• KEY - the full path to the object as alias/bucket/path/object.
• VALUE - the 32-byte RAW Base64-encoded data key to use for encrypting object(s).

For example:

# RawBase64-Encoded string "mybucket32byteencryptionkeyssec"
--enc-c "myminio/mybucket/prefix/object.obj=bXlidWNrZXQzMmJ5dGVlbmNyeXB0aW9ua2V5c3NlYwo"

You can specify multiple encryption keys by repeating the parameter.

Specify the path to a prefix to apply encryption to all matching objects at that path:

--enc-c "myminio/mybucket/prefix/=bXlidWNrZXQzMmJ5dGVlbmNyeXB0aW9ua2V5c3NlYwo"

--recursive, r

mc-cmd

Optional

Restores all objects under the specified prefix.

--versions

mc-cmd

Optional

Restores all versions of the object on the remote tier.

--version-id, vid

mc-cmd

Optional

Restores the specified version of the object on the remote tier.

Global Flags

This command supports any of the global flags.

Examples

Restore an Archived Object

The following command restores an object archived to a remote tier:

mc ilm restore myminio/mybucket/object.txt

Restore a Specific Archived Object Version

The following command restore a specific object version archived to a remote tier:

mc ilm restore --vid "VERSIONID" myminio/mybucket/object.txt

Restore All Archived Objects at a Bucket Prefix

The following command restores all objects archived under a specified prefix on the remote tier:

mc ilm restore --recursive myminio/mybucket/data/

Behavior

Restored Objects Expire Automatically

MinIO automatically expires the restored object copy after the specified number of days (Default: 1 day).

Restored Objects Become HEAD

The restored object copy becomes HEAD for that object namespace regardless of it’s versioning history. This can result in applications returning “stale” data while the local copy exists.

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.

4.10 - mc ilm rule add

Syntax

The mc ilm rule add command adds an object lifecycle management rule to a bucket.

The command supports adding both Transition (Tiering) and Expiration lifecycle management rules.

mc ilm rule add --expire-days 90 --noncurrent-expire-days 30  myminio/mydata

mc ilm rule add --expire-delete-marker myminio/mydata

mc ilm rule add --transition-days 30 --transition-tier "COLDTIER" myminio/mydata

mc ilm rule add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"

mc [GLOBALFLAGS] ilm rule add                               \
                 [--prefix string]                          \
                 [--tags string]                            \
                 [--expire-days "integer"]                  \
                 [--expire-all-object-versions]             \
                 [--expire-delete-marker]                   \
                 [--transition-days "string"]               \
                 [--transition-tier "string"]               \
                 [--noncurrent-expire-days "integer"]       \
                 [--noncurrent-expire-newer "integer"]      \
                 [--noncurrent-transition-days "integer"]   \
                 [--noncurrent-transition-tier "string"]    \
                 [--site-gt "string"]                       \
                 [--size-lt "string"]                       \
                 ALIAS

Parameters

ALIAS

mc-cmd

Required

The alias and bucket on the MinIO deployment to which to add the object lifecycle management rule.

For example:

mc ilm rule add myminio/mydata

--prefix

mc-cmd

Optional

Restrict the management rule to a specific object prefix.

For example:

mc ilm rule add --prefix "meetingnotes/" myminio/mydata --expire-days "90"

The command creates a rule that expires objects in the mydata bucket of the myminio ALIAS after 90 days for any object with the meetingnotes/ prefix.

--tags

mc-cmd

Optional

One or more ampersand &-delimited key-value pairs describing the object tags to use for filtering objects to which the lifecycle configuration rule applies.

This option is mutually exclusive with the following option:

• --expire-delete-marker

--expire-all-object-versions

mc-cmd

Optional

Expire all current and noncurrent versions of an object. Use with the --expire-days option to specify the number of days after which all versions of an object should be deleted by the scanner process.

After the scanner processes this command, no versions of the object remain on the deployment.

This flag only applies to objects that do not have a delete marker as the latest version.

--expire-days

mc-cmd

Optional

The number of days to retain an object after being created. MinIO marks the object for deletion after the specified number of days pass. Specify the number of days as an integer, for example 30 for 30 days.

For versioned buckets, the expiry rule applies only to the current object version. Use either the --noncurrent-expire-days flag or the --expire-all-object-versions flag to apply expiration behavior to noncurrent object versions.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

Mutually exclusive with the following options:

• --expire-delete-marker

For more complete documentation on object expiration, see Object Expiration and Object Deletion.

--expire-delete-marker

mc-cmd

Optional

Specify this option to direct MinIO to remove delete markers for objects with no remaining object versions. Specifically, the delete marker is the only remaining “version” of the given object.

This option is mutually exclusive with the following option:

• --tags
• --expire-days

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

For more complete documentation on object expiration, see Object Expiration and Object Deletion.

--transition-days

mc-cmd

Optional

The number of calendar days from object creation after which MinIO marks an object as eligible for transition. MinIO transitions the object to the configured remote tier specified to the --transition-tier. Specify the number of days as an integer, e.g. 30 for 30 days. If the remote tier is another MinIO deployment, you can set the value to 0 to mark new objects as immediately eligible for transition to the remote tier.

For versioned buckets, the transition rule applies only to the current object version. Use the --noncurrent-transition-days option to apply transition behavior to noncurrent object versions.

Requires specifying --transition-tier.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

For more complete documentation on object transition, see Object Transition (“Tiering”).

--transition-tier

mc-cmd

Optional

The remote tier to which MinIO transition objects. Specify an existing remote tier created by mc ilm tier add.

Required if specifying --transition-days.

--noncurrent-expire-days

mc-cmd

Optional

The number of days to retain an object version after becoming non-current (i.e. a different version of that object is now the HEAD). MinIO marks noncurrent object versions for deletion after the specified number of days pass.

This option has the same behavior as the S3 NoncurrentVersionExpiration action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

--noncurrent-transition-days

mc-cmd

Optional

The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition. MinIO transitions the object to the configured remote tier specified to the --transition-tier once the system host datetime passes that calendar date.

This option has no effect on non-versioned buckets. Requires specifying --noncurrent-transition-tier.

This option has the same behavior as the S3 NoncurrentVersionTransition action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

--noncurrent-transition-tier

mc-cmd

Optional

The remote tier to which MinIO transitions noncurrent objects versions. Specify a remote tier created by mc ilm tier add.

--noncurrent-expire-newer

mc-cmd

Optional

The maximum number of non-current object versions to retain, ordered from newest to oldest.

Use this flag to retain a certain number of past versions of a file in a first in, first out fashion. After retaining the maximum number of non-current versions, MinIO marks any remaining older non-current object versions as eligible for expiration.

The following table lists a number of object versions and their expiration eligibility based on --noncurrent-expire-newer 3:

MinIO retains the current version, v5. MinIO also retains the next 3 non-current versions, starting with the newest. This means MinIO marks v4, v3, and v2 for the three non-current version to retain.

v1 would be a fourth non-current version, which falls outside the limit of non-current versions to retain, so MinIO marks v1 for expiration.

Updating the number for this flag only impacts the unmarked versions of objects. Any versions already marked for expiration do not change if you increase the number to retain.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

--size-gt

mc-cmd

Optional

Select objects larger than the specified value. Enter the value as a number and a unit, such as 5GiB for 5 gibibytes.

Valid units include:

--size-lt

mc-cmd

Optional

Select objects smaller than the specified value. Enter the value as a number and a unit, such as 1M for 1 megabyte.

Valid units include:

Global Flags

This command supports any of the global flags.

Examples

Expire All Bucket Contents After Number of Days

Use mc ilm rule add with the --expire-all-object-versions and --expire-days flags to mark all current and non-current bucket contents for expiration after a number of days pass from the object’s creation:

mc ilm rule add ALIAS/PATH --expire-all-object-versions --expire-days "DAYS"

• Replace ALIAS with the alias of the S3-compatible host.
• Replace PATH with the path to the bucket on the S3-compatible host.
• Replace DAYS with the number of days after which to expire each object. For example, specify 30 to expire objects 30 days after creation.

Transition Non-Current Object Versions at a Prefix to a Different Tier

Use the mc ilm rule add with --prefix and --transition-tier to transition older non-current versions of an object to a different storage tier.

mc ilm rule add --prefix "doc/" --transition-days "90" --transition-tier "MINIOTIER-1"  \
       --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-2"    \
       myminio/mybucket

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

• Current objects in the prefix older than 90 days move to the MINIOTIER-1 storage tier.
• Non-current objects in the prefix older than 45 days move to the MINIOTIER-2 storage tier.
• Both MINIOTIER-1 and MINIOTIER-2 have already been created with mc admin tier add.

Expire All Objects at a Prefix, Retain Current Object Versions Longer Than Non-Current Object Versions

Use the mc ilm rule add command with --prefix, --expire-days, and --noncurrent-expire-days to expire current and non-current versions of an object at different times.

mc ilm rule add --prefix "doc/" --expire-days "300" --noncurrent-expire-days "100" myminio/mybucket

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

• Current objects expire after 300 days.
• Non-current objects expire after 100 days.

Transition noncurrent versions in the prefix /doc with a size greater the 1MiB

Use the mc ilm rule add command with --prefix, --size-gt, and --noncurrent-expire-days to expire current and non-current versions of an object at different times.

mc ilm rule add --prefix "doc/" --size-gt 1MiB --transition-days "90" --transition-tier "MINIOTIER-1" \
      --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-1" \
      myminio/mybucket/

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

The command selects the following objects:

• Current objects older than 90 days larger than 1MiB.
• Non-current objects older than 45 days larger than 1MiB.

Selected objects transition to MINIOTIER-1.

Remove Delete Markers

The following command removes delete markers for objects where the delete marker is the only version of the object that remains.

mc ilm rule add ALIAS/PATH --expire-delete-marker

• Replace ALIAS with the alias of the S3-compatible host.
• Replace PATH with the path to the bucket on the S3-compatible host.

Required Permissions

For permissions required to add a rule, refer to the required permissions on the parent command.

Behavior

Lifecycle Management Object Scanner

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.

Expiry vs Transition

MinIO supports specifying both expiry and transition rules in the same bucket or bucket prefix. MinIO can execute an expiration rule on an object regardless of its transition status. Use mc ilm rule ls to review the currently configured object lifecycle management rules for any potential interactions between expiry and transition rules.

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.

4.11 - mc ilm tier add

Description

The mc ilm tier add command creates a new remote storage tier to a supported storage services.

See Object Transition for a complete list.

Supported S3 Services

mc ilm tier add supports only the following S3-compatible services as a remote target for object tiering:

• MinIO
• Amazon S3
• Google Cloud Storage
• Azure Blob Storage

Permissions

MinIO requires the following administrative permissions on the cluster in which you create remote tiers for object transition lifecycle management rules:

• admin:SetTier
• admin:ListTier

For example, the following policy provides permission for configuring object transition lifecycle management rules on any bucket in the cluster:

{
   "Version": "2012-10-17",
   "Statement": [
      {
            "Action": [
               "admin:SetTier",
               "admin:ListTier"
            ],
            "Effect": "Allow",
            "Sid": "EnableRemoteTierManagement"
      },
      {
            "Action": [
               "s3:PutLifecycleConfiguration",
               "s3:GetLifecycleConfiguration"
            ],
            "Resource": [
                        "arn:aws:s3:::*"
            ],
            "Effect": "Allow",
            "Sid": "EnableLifecycleManagementRules"
      }
   ]
}

Syntax

 mc ilm tier add minio myminio WARM-MINIO-TIER                     \
                               --endpoint https://warm-minio.com   \
                               --access-key ACCESSKEY              \
                               --secret-key SECRETKEY              \
                               --bucket mybucket                   \
                               --prefix myprefix/

mc ilm tier add TIER_TYPE                    \
                TARGET                       \
                TIER_NAME                    \
                --bucket value               \
                [--endpoint string]          \
                [--region string]            \
                [--access-key value^]        \
                [--secret-key value^]        \
                [--use-aws-role^]            \
                [--aws-role-arn^]            \
                [--aws-web-identity-file^]   \
                [--azure-sp-tenant-id^]      \
                [--azure-sp-client-id^]      \
                [--azure-sp-client-secret^]  \
                [--account-name value^]      \
                [--account-key value^]       \
                [--credentials-file value^]  \
                [--prefix value]             \
                [--storage-class value]

Parameters

The command accepts the following arguments:

TIER_TYPE

mc-cmd

Required

The Cloud Service Provider storage backend (“Tier”) to which MinIO transitions objects. Specify one of the following supported values:

TARGET

mc-cmd

Required

The alias of a configured MinIO deployment on which the command creates the new remote tier. You can then create new rules with mc ilm rule add specifying the new remote tier.

TIER_NAME

mc-cmd

Required

The name to associate with the new remote tier. The name must be unique across all configured tiers on the MinIO cluster.

You must specify the tier in all-caps, e.g. WARM_TIER.

--endpoint

mc-cmd

Optional

The URL endpoint for the S3 or MinIO storage. The URL endpoint must resolve to the provider specified to TIER_TYPE.

Required for s3 or minio tier types, optional for azure. This option has no effect for any other value of TIER_TYPE.

--access-key

mc-cmd

Optional

The access key for a user on the remote S3 or minio tier types. The user must have permission to perform read/write/list/delete operations on the remote bucket or bucket prefix.

Required if TIER_TYPE is s3 or minio. This option has no effect for any other value of TIER_TYPE.

--secret-key

mc-cmd

Optional

The secret key for a user on the remote s3 or minio tier types.

Required if TIER_TYPE is s3 or minio. This option has no effect for any other value of TIER_TYPE.

--account-name

mc-cmd

Optional

The Storage Account to use as the remote storage resource.

Required if TIER_TYPE is azure. This option has no effect for any other value of TIER_TYPE.

MinIO does not support changing the storage account name associated to an Azure remote tier. Azure storage backends are tied to the storage account, such that changing this value would change the storage backend and prevent access to any objects transitioned to the original account/backend.

--account-key

mc-cmd

Optional

The corresponding shared account key for the --account-name associated to the remote Azure tier.

The account key must have an assigned Azure policy with the required permissions.

Required if TIER_TYPE is azure. This option has no effect for any other value of TIER_TYPE.

--credentials-file

mc-cmd

Optional

The credential file for a user on the remote Google Cloud Storage tier. The user must have permission to perform read/write/list/delete operations on the remote bucket or bucket prefix.

Required if TIER_TYPE is gcs. This option has no effect for any other value of TIER_TYPE.

--bucket

mc-cmd

Required

The bucket on the remote tier to which MinIO transitions objects.

For azure remote tiers, this value corresponds to the Container name

--prefix

mc-cmd

Optional

The prefix path for the specified --bucket to which MinIO transitions objects.

Omit this field to transition objects into the bucket root.

--storage-class

mc-cmd

Optional

The storage class (“access tier” for Microsoft Azure) MinIO applies to objects transitioned to the remote bucket.

The storage class to apply to objects transitioned by MinIO to the remote bucket. MinIO tiering behavior depends on the remote storage returning objects immediately (milliseconds to seconds) upon request. MinIO therefore cannot support remote storage which requires rehydration, wait periods, or manual intervention.

Select the tab corresponding to the TIER_TYPE for a list of supported values for each tier:

If omitted, objects use the default storage class defined for the remote bucket.

--region

mc-cmd

Optional

The S3 backend region for the specified TIER_TYPE, such as us-west-1.

This option only applies if TIER_TYPE is s3 or minio. This option has no effect for any other value of TIER_TYPE.

--use-aws-role

mc-cmd

Optional

Use the access permission for the locally configured AWS Role.

This option only applies if TIER_TYPE is s3 or minio. This option has no effect for any other value of TIER_TYPE.

--aws-role-arn

mc-cmd

Optional

The AWS S3 role name to use when transitioning objects.

This option only applies if TIER_TYPE is s3 and the source is a MinIO pod on Amazon EKS.

--aws-web-identity-file

mc-cmd

Optional

Specify the web identity token file to use when transitioning objects.

This option only applies if TIER_TYPE is s3 and the source is a MinIO pod on Amazon EKS.

--azure-sp-tenant-id

mc-cmd

Optional

Tenant ID for the service principal account to use to log in to Azure storage.

This option only applies if TIER_TYPE is azure and you log in using a service principal identity. This option has no effect for any other value of TIER_TYPE.

--azure-sp-client-id

mc-cmd

Optional

Client ID for the service principal account to use to log in to Azure storage.

This option only applies if TIER_TYPE is azure and you log in using a service principal identity. This option has no effect for any other value of TIER_TYPE.

--azure-sp-client-secret

mc-cmd

Optional

The client secret for the service principal account to use to log in to Azure storage.

This option only applies if TIER_TYPE is azure and you log in using a service principal identity. This option has no effect for any other value of TIER_TYPE.

Global Flags

This command supports any of the global flags.

Examples

Configure a Tier to Transition Objects to a MinIO Deployment

The following example creates a new tier on a local deployment that a configured rule can use to transition objects to a separate, remote MinIO deployment.

mc ilm tier add minio myminio WARM-MINIO-TIER --endpoint https://warm-minio.com \
     --access-key ACCESSKEY --secret-key SECRETKEY --bucket mybucket --prefix myprefix/

This command creates a new tier called WARM-MINIO-TIER for a minio type of remote storage on the myminio deployment.

• The remote MinIO storage is located at https://warm-minio.com.
• The command includes credentials for a user with read, write, list, and delete privileges to the bucket and prefix.
• The tier transitions objects to the mybucket bucket and the myprefix prefix on the remote MinIO storage.

Configure a Tier to Transition Objects to an Azure Blob Storage Location

The following example creates a new tier on a local deployment that a configured rule can use to transition objects to Azure Blob Storage.

mc ilm tier add azure myminio AZTIER --account-name ACCOUNT-NAME --account-key ACCOUNT-KEY \
     --bucket myazurebucket --prefix myazureprefix/

This command creates a new tier called AZTIER for an azure type of remote storage on the myminio deployment.

• The remote Azure storage is accessed by the provided account name and key.
• The tier transitions objects to the myazurebucket bucket and the myazureprefix prefix on the Azure storage.

Configure a Tier to Transition Objects to Google Cloud Storage

The following example creates a new tier on a local deployment that a configured rule can use to transition objects to Google Cloud Storage.

 mc ilm tier add gcs myminio GCSTIER --credentials-file /path/to/credentials.json \
     --bucket mygcsbucket  --prefix mygcsprefix/

This command creates a new tier called GCSTIER for a gcs type of remote storage on the myminio deployment.

• The remote GCS storage is accessed by the provided credentials file.
• The tier transitions objects to the mygcsbucket bucket and the mygcsprefix prefix on the GCS storage.

Configure a Tier to Transition Objects to Amazon Simple Storage Service (S3)

The following example creates a new tier on a local deployment that a configured rule can use to transition objects to a STANDARD storage on S3.

 mc ilm tier add s3 myminio S3TIER --endpoint https://s3.amazonaws.com \
     --access-key ACCESSKEY --secret-key SECRETKEY --bucket mys3bucket --prefix mys3prefix/ \
     --storage-class "STANDARD" --region us-west-2

This command creates a new tier called S3TIER for a s3 type of remote storage on the myminio deployment.

• The S3 storage is located at the provided endpoint.
• The remotes S3 storage is accessed by the provided access key and secret key.
• The tier transitions objects to the mys3bucket bucket and the mys3prefix prefix on the GCS storage.
• The tier utilizes S3 STANDARD storage class located in the us-west-2 S3 region.

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.

Required Permissions

For permissions required to add a tier, refer to the required permissions on the parent command.

4.12 - 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)

mc legalhold clear --recursive myminio/mydata

mc [GLOBALFLAGS] legalhold clear \
                 [--recursive]   \
                 [--rewind]      \
                 [--version-id]  \
                 ALIAS

Parameters

ALIAS

mc-cmd

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

mc-cmd

Optional

Removes the legal hold on all objects in the ALIAS bucket or bucket prefix.

--rewind

mc-cmd

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 specified ALIAS be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, use mc version to enable or disable bucket versioning.

--version-id, vid

mc-cmd

Optional

Directs mc legalhold clear to operate only on the specified object version.

--version-id requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, use mc 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 ALIAS with the alias of the S3-compatible host.
• 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.

4.13 - mc license info

Description

The mc license info command displays information about the MinIO deployment’s license status. Specifically, whether the deployment uses the AGPLv3 Open Source license of the MinIO Commercial License.

You must register your deployment with MinIO MinIO SUBNET to activate your commercial license.

For example, the command returns the following information for an unregistered deployment:

You are using GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (https://www.gnu.org/licenses/agpl-3.0.txt)

If you are building proprietary applications, you may want to choose the commercial license
included as part of the Standard and Enterprise subscription plans. (https://min.io/signup?ref=mc)

Applications must otherwise comply with all the GNU AGPLv3 License & Trademark obligations.

Use mc license register to associate your deployment with your SUBNET account. If you are not already signed up for SUBNET, see the Registration page.

Examples

Display the Current License for a Deployment with Alias minio1

mc license info minio1

If a deployment uses an expired MinIO Commercial License, the command outputs an error message.

Syntax

The command has the following syntax:

mc [GLOBALFLAGS] license info       \
                         ALIAS      \
                         [--airgap]

Parameters

ALIAS

mc-cmd

Required

The alias of the MinIO deployment.

--airgap

mc-cmd

Optional

Use in environments where the client machine running the minio client does not have network access to SUBNET (for example, airgapped, firewalled, or similar configuration) to display instructions for how to register the deployment with SUBNET.

If the deployment is airgapped, but the local device has network access, you do not need to use the --airgap flag.

Global Flags

This command supports any of the global flags.

4.14 - mc replicate add

Syntax

The mc replicate add command creates a new server-side replication rule for a bucket on a MinIO deployment.

The remote bucket must be on a MinIO deployment running the same version of MinIO as the local deployment.

The MinIO deployment automatically begins synchronizing new objects to the remote MinIO deployment after creating the rule. You can optionally configure synchronization of existing objects, delete operations, and fully-deleted objects.

mc replicate add                                                     \
   --remote-bucket https://user:[email protected]:9001/bucket  \
   --replicate "delete,delete-marker,existing-objects"               \
   myminio/mydata

mc [GLOBALFLAGS] replicate add                     \
                 --remote-bucket string          \
                 [--bandwidth "string"]            \
                 [--disable]                       \
                 [--disable-proxy]                 \
                 [--healthcheck-seconds integer]   \
                 [--id "string"]                   \
                 [--limit-upload "string"]         \
                 [--limit-download "string"]       \
                 [--path "string"]                 \
                 [--region "string"]               \
                 [--replicate "string"]            \
                 [--storage-class "string"]        \
                 [--sync]                          \
                 [--tags "string"]                 \
                 [--priority int]                  \
                 ALIAS