Create a key to access a child database.


fauna create-key DBNAME [ROLE] [OPTIONS]


The create-key command creates a key that allows access to the DBNAME child database.

When you create the key, you can optionally associate a role to the key:

  • admin (default)

  • server

  • server-readonly

  • User-defined role name.

If command line options are omitted, the default options from the configuration file are used.

You can’t use this command to create a key in a parent or peer database. To access a database outside of the current database, log into the Fauna Dashboard.


Argument Description


Name of the database to create a key for.


(Optional) Key role. One of:

  • admin (default)

  • server

  • server-readonly

  • User-defined role name


Option Description


(Optional) Fauna server domain, which is the Fauna hostname.
Default =


(Optional) Endpoint name to use for the command.


(Optional) Connection port.
Default = 8443


(Optional) Connection scheme. Must be one of:
       https (default)


(Optional) Secret to use to connect to a database.


(Optional) connection timeout, in milliseconds. When the interval elapses, fauna-shell times out and displays an error.
Default = 5 seconds


This example uses a database called my-test-db.

fauna list-databases
listing databases

Now, run fauna create-key to create a key for my-test-db. Because a role isn’t provided, the key role defaults to admin.

fauna create-key my-test-db
creating key for database 'my-test-db' with role 'admin'

  created key for database 'my-test-db' with role 'admin'.
  secret: fnAFMpLEJWAAQasGbXhkW5wyvhpOIIkj-j1cmKng

  To access 'my-test-db' with this key, create a client using
  the driver library for your language of choice using
  the above secret.

Verify the key is created:

fauna list-keys
Key ID               Database             Role
373686120364376132   [current]            admin
373711801788923969   [current]            server
373714670256652356   internal             server
374523090163466305   my-test-db           admin

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email

Thank you for your feedback!