elasticsearch-syskeygen
The elasticsearch-syskeygen command creates a system key file in the elasticsearch config directory.
Synopsis
bin/elasticsearch-syskeygen [-E <KeyValuePair>] [-h, --help] ([-s, --silent] | [-v, --verbose])
Description
The command generates a system_key file, which you can use to symmetrically encrypt sensitive data. For example, you can use this key to prevent Watcher from returning and storing information that contains clear text credentials. See Encrypting sensitive data in Watcher.
The system key is a symmetric key, so the same key must be used on every node in the cluster.
Parameters
-
-E <KeyValuePair> - Configures a setting. For example, if you have a custom installation of Elasticsearch, you can use this parameter to specify the
ES_PATH_CONFenvironment variable. -
-h, --help - Returns all of the command parameters.
-
-s, --silent - Shows minimal output.
-
-v, --verbose - Shows verbose output.
Examples
The following command generates a system_key file in the default $ES_HOME/config directory:
bin/elasticsearch-syskeygen
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/syskeygen.html
