telegraf secrets get
The telegraf secrets get command retrieves the value of a secret from the
specified secret store.
This command requires your configuration file that contains the secret store
definitions you want to access. If the --config or --config-directory flags
are not included in the command, Telegraf checks the
default configuration file location.
Use telegraf secrets list to get the
IDs of available secret stores and the available secret keys.
If you haven’t configured a secret store, use
telegraf plugins secretstores
to list available secret store plugins.
View secret store plugin configuration documentation in the
Telegraf GitHub repository.
Usage
telegraf [global-flags] secrets get [flags] <SECRET_STORE_ID> <SECRET_KEY>
Arguments
| Argument | Description |
|---|---|
| SECRET_STORE_ID | ID of the secret store to retrieve the secret from |
| SECRET_KEY | Key of the secret to retrieve |
Flags
| Flag | Description | |
|---|---|---|
-h |
--help |
Show command help |
Also see Telegraf global flags.
Examples
- Retrieve a secret using the default configuration location
- Retrieve a secret using a non-default configuration location
In the examples below, replace the following:
SECRET_STORE_ID: The ID of the secret store to retrieve the secret from.SECRET_KEY: The key of the secret to retrieve from the secret store.CUSTOM_CONFIG_PATH: The non-default filepath to your Telegraf configuration file containing your secret store definitions.
Retrieve a secret using the default configuration location
The following example assumes the Telegraf configuration file that contains the secret store definition is at the default location.
telegraf secrets get SECRET_STORE_ID SECRET_KEY
Retrieve a secret using a non-default configuration location
telegraf --config CUSTOM_CONFIG_PATH secrets get SECRET_STORE_ID SECRET_KEY
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.