Secrets

Last updated 24 days ago

Koyeb Secrets allow secure storage and usage of sensitive information like password or API tokens. The secrets feature can be used in stacks and need to be used to connect 3rd party stores.

You can use secrets to store:

databases or APIs access credentials,
third-party provider credentials,
reusable configuration variables.

All secret values are automatically encrypted server side to ensure secure storage. To prevent unauthorized access, Secrets access need to be explicitly granted in Stack functions.

Create a Secret

A secret is composed of a name and a value. The name of a secret needs to comply with RFC1123, the DNS naming convention, and should only be composed of lowcase characters, numbers and dashes.

There are two steps to create a Secret.

Click on Secrets in the left side menu to go the secrets page and click on New at the top right.
In the Create Secret modal, enter your Secret name and value. Use an explicit name as you will need it to use the secret and validate to save your secret.

Your Secret is created and is now ready to be used!

Using secrets

Secrets can be used with stores and stacks:

For stores, refer to Connect 3rd party stores.
For stacks, refer to Using environment variables and secrets.

Delete a Secret

Warning: Make sure no production function or store is using your secret before deleting it as this might generate production failures or outages.

Deleting a Secret is permanent and irreversible. When you delete a Secret, all resources using it will lose access to its value.

Click on Secrets in the left side menu to go the secrets listing page.
In the Secrets list, click on the three dots of the Secret you want to delete and click on delete.
A warning modal appears and asks for confirmation before deleting.

Your Secret is now deleted.