Table of Contents
mc alias set command adds or updates an alias to the local
The following command adds an alias for a MinIO
myminio running at the URL
https://myminio.example.net. mc uses the specified
username and password for authenticating to the MinIO deployment:
mc alias set myminio https://myminio.example.net minioadminuser minioadminpassword
myminio alias already exists, the command overwrites that
alias with the new URL, access key, and secret key.
mc alias set command has the following syntax:
mc [GLOBALFLAGS] alias set \ [--api "string"] \ [--path "string"] \ ALIAS \ URL \ ACCESSKEY \ SECRETKEY
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.
Specifies the signature calculation method to use when connecting to the S3-compatible service. Supports the following values:
S3v4unless explicitly required by the S3-compatible service. MinIO server does not rely on nor require
S3v2, nor are all API operations available on
This command supports any of the global flags.
mc alias set to add an S3-compatible service for use with
The following command creates a new alias
myminio pointing at a
MinIO deployment at
alias uses the
miniopassword credentials for
performing operations against the deployment.
mc alias set myminio https://minio.example.net miniouser miniopassword
myminio alias already exists, the
mc alias set command overwrites that alias with the specified
mc alias set ALIAS HOSTNAME ACCESSKEY SECRETKEY
ALIASwith the the name to associate to the MinIO service.
HOSTNAMEwith the URL for any node in the MinIO deployment. You can alternatively specify the URL for a load balancer or reverse proxy managing connections to the MinIO deployment.
SECRETKEYwith credentials for a user on the MinIO deployment.
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.
mc alias set requires specifying an access key and corresponding
secret key for the S3-compatible host. mc functionality is limited
based on the policies associated to the specified credentials. For example, if
the specified credentials do not have read/write access to a specific bucket,
mc cannot perform read or write operations on that bucket.
For more information on MinIO Access Control, see Access Management.
For more complete documentation on S3 Access Control, see Amazon S3 Security.
For all other S3-compatible services, defer to the documentation for that service.