Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

mc admin kms key

Table of Contents

Description

The mc admin kms key command performs cryptographic key management operations through the MinIO Key Encryption Service (KES).

Use mc admin on MinIO Deployments Only

MinIO does not support using mc admin commands with other S3-compatible services, regardless of their claimed compatibility with MinIO deployments.

Syntax

mc admin kms key create

Creates a new master key on a Key Management System (KMS).

The command has the following syntax:

mc admin kms key create TARGET [KEY_NAME]

The command accepts the following arguments:

TARGET

Specify the alias of a configured MinIO deployment.

The TARGET deployment must include a configured MinIO Key Encryption Service (KES) server.

KEY_NAME

Specify the name of the new master key.

mc admin kms key status

Requests information on a Key Management System (KMS) master key.

The command has the following syntax:

mc admin kms key status TARGET [KEY_NAME]

The command accepts the following arguments:

TARGET

Specify the alias of a configured MinIO deployment.

The TARGET deployment must include a configured MinIO Key Encryption Service (KES) server.

KEY_NAME

Specify the name of a master key on the KMS.

Omit this argument to return the default master key on the TARGET deployment.