endpoint add

Learn: Endpoints

Adds an endpoint to the .fauna-shell configuration file.

Syntax

fauna endpoint add [NAME] [--non-interactive --url <value> --secret <value>] [--set-default]

Description

The add-endpoint command adds an endpoint to the .fauna-shell configuration file. If you don’t provide a URL or secret, you’re prompted for them, and they are written to the configuration file.

cloud-login is the preferred way to add an endpoint. Use endpoint add to add a non-standard endpoint, such as when using the Fauna Dev Docker image.

Arguments

Argument Description

NAME

Endpoint name.

The Fauna CLI identifies the URL scheme, domain, and port and includes those values in the new endpoint entry that it creates in the configuration file.

Options

Option Description

--non-interactive

Disable interaction.

--secret=<value>

Database secret.

--set-default

Sets this environment as the default environment.

--url=<value>

Database URL.

--help

Help for endpoint add command.

Aliases

fauna add-endpoint

Examples

fauna endpoint add
fauna endpoint add localhost --url http://localhost:8443/ --key secret
fauna endpoint add localhost --set-default

See also

cloud-login

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!