Documentation / auth
namecheap auth
Authentication commands
Every command below also accepts the global options.
namecheap auth
Authentication commands
namecheap auth [OPTIONS] <COMMAND>namecheap auth login
Configure API credentials
namecheap auth login [OPTIONS]Options
--api-user <API_USER> | API user |
--api-key <API_KEY> | API key |
--username <USERNAME> | Username (if different from API user) |
--client-ip <CLIENT_IP> | Client IP (auto-detected if not specified) |
--sandbox | Use sandbox API |
--store <STORE> | Where to keep the API key Possible values: - keychain: The OS keychain, where it is encrypted at rest - file: The config file, in plaintext. Only for machines with no keychain [default: keychain] |
namecheap auth logout
Remove stored credentials
namecheap auth logout [OPTIONS]namecheap auth migrate
Move API keys out of the config file and into the keychain
namecheap auth migrate [OPTIONS]namecheap auth status
Show authentication status
namecheap auth status [OPTIONS]namecheap auth whoami
Show current user info and account balance
namecheap auth whoami [OPTIONS]