Skip to content

mc tag set

Syntax

The mc tag set command sets one or more tags to a bucket or object.

MinIO supports adding up to 10 custom tags to an object.

The following command sets tags for the mydata bucket on the myminio MinIO deployment:

mc tag set myminio/mydata "tag1=value1&tag2=value2"

The command has the following syntax:

mc [GLOBALFLAGS] tag set                   \
                 [--rewind "string"]       \
                 [--versions]              \
                 [--version-id "string"]*  \
                 ALIAS                     \
                 "TAGS"
  • 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.

mc tag set --version-id is mutually exclusive with multiple parameters. See the reference documentation for more information.

Parameters

ALIAS

mc-cmd

Required

The alias for a MinIO deployment and the full path to the object on which to apply the tag (e.g. bucket and path to object). For example:

mc tag set myminio/mybucket/object.txt
TAGS

mc-cmd

Required

An ampersand-seperated (&) list of key-value pairs (KEY=VALUE), where each pair represents one tag to assign to the object. For example:

mc tag set myminio/mybucket/object.txt "key1=value1&key2=value2"
--exclude-folders

mc-cmd

Optional

Note

Added: RELEASE.2024-01-11T05-49-32Z

When used with --recursive, causes mc tag set to not traverse child prefixes. Tags are only applied to objects at the specified path. Requires --recursive.

The following example applies the tag destination=international to objects at vacation-photos/cancun/ but not vacation-photos/cancun/ocean/ or other prefixes.

For example, the above would add the tags to the object at vacation-photos/cancun/pretty-beach.jpg but not to the object at vacation-photos/cancun/ocean/tropical-fish.jpg.

mc tag set myminio/vacation-photos/cancun "destination=international" --exclude-folders --recursive
--recursive, r

mc-cmd

Optional

Note

Added: RELEASE.2023-05-04T18-10-16Z

Recursively applies the tag to all objects at the path specified to ALIAS.

--rewind

mc-cmd

Optional

Directs mc tag set 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.

--versions

mc-cmd

Optional

Directs mc tag set to operate on all object versions that exist in the bucket.

--versions 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.

Use --versions and --rewind together to apply the tag all object versions which existed at a specific point in time.

--version-id, --vid

mc-cmd

Optional

Directs mc tag set 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.

Mutually exclusive with the following parameters:

Global Flags

This command supports any of the global flags.

Examples

Apply Tags to a Bucket or Object

Use mc tag set to apply tags to a bucket or object:

mc tag set ALIAS/PATH "TAGS"
  • Replace ALIAS with the alias of the MinIO deployment.
  • Replace PATH with the path to the bucket or object on the MinIO deployment.
  • Replace TAGS with one or more ampersand-separated (&) key-value pairs for each tag and its corresponding value.

Behavior

S3 Compatibility

SILO is the supported server for PGSTY mcli; compatibility with upstream MinIO and other S3 services is best effort.