delete-key

Delete a database key.

Syntax

fauna delete-key KEYNAME [--url <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>] [--environment <value>]

Description

The delete-key command deletes a key.

If command line options are omitted, Fauna uses the default configuration file options.

Arguments

Argument Description

KEYNAME

Name of the key to delete.

Options

Option Description

--endpoint

Connection endpoint, from the ~/.fauna-shell file.

--environment

Environment to use, from a Fauna project.

--help

Help for create-database command.

--secret

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

--timeout

Connection timeout (milliseconds).

--url

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

Example

There are already four keys for this example:

fauna list-keys
listing keys
Key ID               Database             Role
259718958404338186   app1                 server
259719743570706945   app1                 client
265528117038154259   my-test-db           admin
265437820880945683   my-test-db           admin

Now, delete the first key in the list:

fauna delete-key 259718958404338186
deleting key 259718958404338186
key 259718958404338186 deleted

When you list the keys again, you see that the key you deleted is now gone:

fauna list-keys
listing keys
Key ID               Database             Role
259719743570706945   app1                 client
265528117038154259   my-test-db           admin
265437820880945683   my-test-db           admin

See also

list-keys
create-key
Configuration

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!