Skip to main content
The CLI authenticates against authenticated Paubox endpoints (such as the Paubox Email API) using your API key. Run paubox auth login once and your API key is stored securely; you won’t need to pass it on every command. Follow the Paubox Email API Quickstart Guide to get your API key.

Commands

auth login

The CLI validates your API key against the Paubox API before saving it. If validation fails, nothing is stored and an error is shown.

auth set-forms-key

The Forms admin commands (paubox forms list, create, update, submissions, webhooks, and the rest) use this key. It is stored alongside your Email API key, and paubox auth login keeps it in place.

auth logout

This removes the stored credentials from wherever they were saved (keychain or config file), including the Forms API key. Run paubox auth set-forms-key again after logging back in.

auth status

auth status reads stored credentials only; it does not call the Paubox API. If no credentials are stored:

Where credentials are stored

If your system falls back to file-based storage, never commit ~/.config/paubox/config.json to source control. Add it to your .gitignore if your home directory is under version control.
The CLI reads credentials only from the keychain or config file written by paubox auth login and paubox auth set-forms-key. It does not read an API key from an environment variable or a command-line flag, and both commands prompt interactively.
paubox forms get and paubox forms submit call public Paubox Forms endpoints and do not require paubox auth login.