`fauna create-key`

Create a key to access a database.

Syntax

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

Description

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

The key is assigned one of the following built-in roles:

admin (default)
server
server-readonly

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 in to the Fauna Dashboard.

Arguments

Argument Description

Argument	Description
`<DBNAME>`	Name of the database to create a key for.
`<ROLE>`	Role. Must be one of: `admin` (default) `server` `server-readonly`

<DBNAME>

Name of the database to create a key for.

<ROLE>

Role. Must be one of:

admin (default)
server
server-readonly

Options

Option Description

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`.

--[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

Create a key for a top-level database

To create a key for a top-level database, pass an empty string to the --environment option.

The following command creates a key with the server role for the top-level ECommerce database:

fauna create-key --environment='' ECommerce server

To create a key for a top-level database, you must use a secret scoped to the account’s top-level context. You can create this secret and use it by default using the fauna cloud-login command.

Create a key for a child database

To create a key for a child database, you must use a secret scoped to the parent database. You can pass a secret using the --secret option.

The following command creates a key with the server-only role for the childDB child database:

fauna create-key --secret='fn...' childDB server-readonly

fauna create-key