The Fauna service will be ending on May 30, 2025.

For more information on the service wind down, see our announcement and the Fauna Service End-of-Life FAQ.

fauna list-keys

List keys in the current database.

Syntax

fauna list-keys [--[no-]color ] [--endpoint <value>]
  [--environment <value>] [--secret <value>]
  [--timeout <value>] [--url <value>]

Description

The list-keys command lists the keys created in the current database.

Options

Option Description

--[no-]color

Enables or disables color formatting for the output. Color formatting is enabled by default if the terminal supports it (determined using chalk/supports-color). Use --no-color to disable.

--endpoint

Connection endpoint from .fauna-shell.

--environment

Environment to use, from a Fauna project.

--help

Help for create-database command.

--secret

Authentication secret. Overrides the secret in .fauna-shell.

Use a scoped key to interact with a child database using a parent database’s admin key.

For example, with a parent database’s admin key secret of fn123, you can access a child database by appending the child database name and role: fn123:childDB:admin.

--timeout

Connection timeout (milliseconds).

--url

Database URL. Overrides the URL in .fauna-shell.

Example

For this example, assume that you have previously created some keys. Display the list with fauna list-keys:

fauna list-keys

Response:

Key ID               Database             Role
373686120364376132   [current]            admin
373711801788923969   [current]            server
373714670256652356   prod                 server
374523090163466305   childDB              admin

See also

fauna create-key
fauna delete-key

\