Skip to main content

scloud secret

scloud secret stores sensitive values that your server reads from Platform.environment (rather than through Serverpod's getPassword() API). Secrets are encrypted at rest and injected as environment variables under names you choose.

For values you read through Serverpod's API, use scloud password. For non-sensitive config, use scloud variable. See Passwords, secrets, and environment variables for when to use which.

Usage​

Manage Serverpod Cloud secrets.

Usage: scloud secret <subcommand> [arguments]
-h, --help    Print this usage information.

Available subcommands:
  list    List all secrets.
  set     Set a secret (create or update).
  unset   Remove a secret.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.dev/cloud/reference/cli/commands/secret

Sub commands​

set​

Set a secret (create or update).

Usage: scloud secret set [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project.
                             Can be omitted for existing projects that are linked. See `scloud
                             project link --help`.
    --name (mandatory)       The name of the secret. Can be passed as the first argument.

Value
    --value                  The value of the secret. Can be passed as the second argument.
    --from-file              The name of the file with the secret value.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.dev/cloud/reference/cli/commands/secret

list​

List all secrets.

Usage: scloud secret list [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project.
                             Can be omitted for existing projects that are linked. See `scloud
                             project link --help`.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.dev/cloud/reference/cli/commands/secret

unset​

Remove a secret.

Usage: scloud secret unset [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project.
                             Can be omitted for existing projects that are linked. See `scloud
                             project link --help`.
    --name (mandatory)       The name of the secret. Can be passed as the first argument.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.dev/cloud/reference/cli/commands/secret