create-key

Create a key to access a database.

Syntax

fauna create-key DBNAME [ROLE] [--url <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>] [--environment <value>]

Description

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

When you create the key, you can optionally associate a ROLE with the key:

  • (default) admin

  • server

  • server-readonly

  • User-defined role name.

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.

Arguments

Argument Description

DBNAME

Name of the database to create a key for.

ROLE

Key role. One of:

  • admin (default)

  • server

  • server-readonly

  • User-defined role name

Options

Option Description

--endpoint

Connection endpoint from ~/.fauna-shell.

--environment

Environment to use, from a Fauna project.

--help

Help for create-database command.

--secret

Secret key. Overrides the secret in ~/.fauna-shell.

--timeout

Connection timeout (milliseconds).

--url

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

Example

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

fauna list-databases
listing databases
my-test-db

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 docs@fauna.com

Thank you for your feedback!