Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mage.ai/llms.txt

Use this file to discover all available pages before exploring further.

In various surfaces in Mage, you may be asked to input config for certain integrations such as cloud databases or services. In these cases, you may need to input a password or an api key, but you don’t want it to be shown in plain text. To get around this issue, we created a way to store your secrets in the Mage database.
Your secrets are encrypted before being stored into the Mage database. The encryption key will be stored in the Mage data folder which by default will be created at ~/.mage_data. If you need more secure encryption, we recommend using a secrets manager.

​
Secret management

​
Creating secrets

To manage your secrets, you can go to the Secrets page by clicking on the Secrets icon in the side navigation. This will open the global secrets management page where you can see all your secrets, create new ones, and delete existing ones. You can also manage secrets directly from the pipeline edit page. In the sidekick, you should see a Secrets tab. To create a secret, press the New button on this tab. Input a name for the secret and the value of the secret, and press Enter or Return to save. Create Secrets The secrets can be shared across the project that they are created in. Pipeline level secrets coming soon…

​
Secrets in different environments

Secrets are stored to the Mage database. If you are using the same database across multiple Mage environments, i.e. development and production, the secrets will not be shared across the environments unless you shared the same Mage data directory for every environment. Each secret will be saved to the database with a name and a uuid. The name will be used to identify the secret, and the uuid is used to identify the environment. Example: 
Development environment
project
└───mage_data
│   └───secrets
│   │   │   key: abc123
│   │   │   uuid: dev-uuid

Production environment
project
└───mage_data
│   └───secrets
│   │   │   key: def456
│   │   │   uuid: prod-uuid
Secrets table in database
NameUuidValue
secret1dev-uuidsooper dooper secret string
secret2dev-uuidxXxSecreTxXx
secret3dev-uuiddev only secret
secret1prod-uuidreal production secret
secret2prod-uuidm4g3r0x!
secret1randomrandom secret
CommandDevelopment ValueProduction Value
get_secret_value('secret1')sooper dooper secret stringreal production secret
get_secret_value('secret2')xXxSecreTxXxm4g3r0x!
get_secret_value('secret3')dev only secretNone
Coming soon:
  • secrets scoped to a pipeline

​
Using Secrets

You can use the following syntax to have Mage interpolate the secret when reading from the config: 
field_name: "{{ mage_secret_var('your_secret_name') }}"
Using Secrets You can also fetch the secret value in a Mage code block by importing a helper method: 
from mage_ai.data_preparation.shared.secrets import get_secret_value

get_secret_value('your_secret_name')