Namecheap User Management
New in version 2017.7.0.
This module uses the requests
Python module to communicate to the namecheap
API.
The Namecheap username, API key and URL should be set in the minion configuration file, or in the Pillar data.
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
Checks if the provided minimum value is present in the user's account.
Returns a boolean. Returns False
if the user's account balance is less
than the provided minimum or True
if greater than the minimum.
The value to check
CLI Example:
salt 'my-minion' namecheap_users.check_balances
salt 'my-minion' namecheap_users.check_balances minimum=150
Gets information about fund in the user's account. This method returns the following information: Available Balance, Account Balance, Earned Amount, Withdrawable Amount and Funds Required for AutoRenew.
Note
If a domain setup with automatic renewal is expiring within the next 90 days, the FundsRequiredForAutoRenew attribute shows the amount needed in your Namecheap account to complete auto renewal.
CLI Example:
salt 'my-minion' namecheap_users.get_balances
Generated on December 02, 2024 at 20:43:35 UTC.
You are viewing docs for the previous stable release, 3006.9. Switch to docs for the latest stable release, 3007.1, or to a recent doc build from the master branch.
© 2024 VMware, Inc. | Privacy Policy