The API has been UPDATED!
class Client(**builtin**.object)
| The GoDaddyPy Client.
|
| This client is used to connect to the GoDaddy API and to perform requests with said API.
|
| Methods defined here:
|
| **init**(self, account, log_level=30)
| Create a new `godaddypy.Client` object
|
| :type account: godaddypy.Account
| :param account: The `godaddypy.Account` object to create auth headers with.
|
| add_record(self, domain, record)
| Adds the specified DNS record to a domain.
|
| :param domain: the domain to add the record to
| :param record: the record to add
|
| add_records(self, domain, records)
| Adds the specified DNS records to a domain.
|
| :param domain: the domain to add the records to
| :param records: the records to add
|
| delete_records(self, domain, name, record_type=None)
| Deletes records by name. You can also add a record type, which will only delete records with the
| specified type/name combo. If no record type is specified, ALL records that have a matching name will be
| deleted.
|
| :param domain: the domain to delete records from
| :param name: the name of records to remove
| :param record_type: the type of records to remove
|
| :return: True if no exceptions occurred
|
| get_domain_info(self, domain)
| Get the GoDaddy supplied information about a specific domain.
|
| :param domain: The domain to obtain info about.
| :type domain: str
|
| :return A JSON string representing the domain information
|
| get_domains(self)
| Returns a list of ACTIVE domains for the authenticated user.
|
| get_records(self, domain, record_type=None, name=None)
| Returns records from a single domain. You can specify type/name as filters for the records returned. If
| you specify a name you MUST also specify a type.
|
| :param domain: the domain to get DNS information from
| :param record_type: the type of record(s) to retrieve
| :param name: the name of the record(s) to retrieve
|
| replace_records(self, domain, records, record_type=None, name=None)
| This will replace all records with at the domain. Record type and record name can be provided to filter
| which records to replace.
|
| :param domain: the domain to replace records at
| :param records: the records you will be saving
| :param record_type: the type of records you want to replace (eg. only replace 'A' records)
| :param name: the name of records you want to replace (eg. only replace records with name 'test')
|
| :return: True if no exceptions occurred
|
| update_ip(self, ip, record_type='A', domains=None, subdomains=None)
| Update the IP address in all records, specified by type, to the value of ip. Returns True if no
| exceptions occurred during the update. If no domains are provided, all domains returned from
| self.get_domains() will be updated. By default, only A records are updated.
|
| :param record_type: The type of records to update (eg. 'A')
| :param ip: The new IP address (eg. '123.1.2.255')
| :param domains: A list of the domains you want to update (eg. ['123.com','abc.net'])
| :param subdomains: A list of the subdomains you want to update (eg. ['www','dev'])
|
| :type record_type: str
| :type ip: str
| :type domains: str, list of str
| :type subdomains: str, list of str
|
| :return: True if no exceptions occurred
|
| update_record(self, domain, record, record_type=None, name=None)
| Call to GoDaddy API to update a single DNS record
|
| :param name: only required if the record is None (deletion)
| :param record_type: only required if the record is None (deletion)
| :param domain: the domain where the DNS belongs to (eg. 'example.com')
| :param record: dict with record info (ex. {'name': 'dynamic', 'ttl': 3600, 'data': '1.1.1.1', 'type': 'A'})
|
| :return: True if no exceptions occurred
|
| update_record_ip(self, ip, domain, name, record_type)
| Update the IP address(es) for (a) domain(s) specified by type and name.
|
| :param ip: the new IP for the DNS record (ex. '123.1.2.255')
| :param domain: the domain where the DNS belongs to (ex. 'example.com')
| :param name: the DNS record name to be updated (ex. 'dynamic')
| :param record_type: Record type (ex. 'CNAME', 'A'...)
|
| :return: True if no exceptions occurred