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 logout

This removes the stored API key from wherever it was saved (keychain or config file).

​
auth status

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.
In CI environments, set your API key via an environment variable instead of running auth login. The CLI reads PAUBOX_API_KEY if present, and it takes precedence over stored credentials.
paubox forms get and paubox forms submit call public Paubox Forms endpoints and do not require paubox auth login.