Data Model Reference

class namecom.Record(id, domainName, fqdn, type, answer, host=None, ttl=300, priority=None)

This is a class for an individual DNS resource record.

id

Unique record id. Value is ignored on Create, and must match the URI on Update.

Type:int

domainName

DomainName is the zone that the record belongs to.

Type:string

host

Host is the hostname relative to the zone: e.g. for a record for blog.example.org, domain would be “example.org” and host would be “blog”. An apex record would be specified by either an empty host “” or “@”. A SRV record would be specified by “_{service}._{protocal}.{host}”: e.g. “_sip._tcp.phone” for _sip._tcp.phone.example.org.

Type:string

fqdn

FQDN is the Fully Qualified Domain Name. It is the combination of the host and the domain name. It always ends in a “.”. FQDN is ignored in CreateRecord, specify via the Host field instead.

Type:string

type

Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.

Type:string

answer

Answer is either the IP address for A or AAAA records; the target for ANAME, CNAME, MX, or NS records; the text for TXT records. For SRV records, answer has the following format: “{weight} {port} {target}” e.g. “1 5061 sip.example.org”.

Type:string

ttl

TTL is the time this record can be cached for in seconds. Name.com allows a minimum TTL of 300, or 5 minutes.

Type:int

priority

Priority is only required for MX and SRV records, it is ignored for all others.

Type:int

class namecom.DNSSEC(domainName, keyTag, algorithm, digestType, digest)

This is a class for Domain Name System Security Extensions (DNSSEC). It contains all the data required to create a DS record at the registry.

domainName

DomainName is the domain name.

Type:string

keyTag

KeyTag contains the key tag value of the DNSKEY RR that validates this signature. The algorithm to generate it is here: https://tools.ietf.org/html/rfc4034#appendix-B

Type:int

algorithm

Algorithm is an integer identifying the algorithm used for signing. Valid values can be found here: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml

Type:int

digestType

DigestType is an integer identifying the algorithm used to create the digest. Valid values can be found here: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml

Type:int

digest

Digest is a digest of the DNSKEY RR that is registered with the registry.

Type:string

class namecom.Domain(domainName, locked=None, expireDate=None, createDate=None, contacts=None, nameservers=None, privacyEnabled=None, autorenewEnabled=None, renewalPrice=None)

This class lists all the data for a domain.

domainName

DomainName is the punycode encoded value of the domain name.

Type:string

nameservers

Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.

Type:[]string

contacts

Contacts for the domain.

Type:Contacts

privacyEnabled

PrivacyEnabled reflects if Whois Privacy is enabled for this domain.

Type:bool

locked

Locked indicates that the domain cannot be transfered to another registrar.

Type:bool

autorenewEnabled

AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.

Type:bool

expireDate

ExpireDate is the date the domain will expire.

Type:string

createDate

CreateDate is the date the domain was created at the registry.

Type:string

renewalPrice

RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.

Type:float

class namecom.Contacts(registrant, admin, tech, billing)

This class stores the contact information for the roles related to domains.

registrant

Registrant is the rightful owner of the account and has the right to use and/or sell the domain name. They are able to make changes to all account, domain, and product settings. This information should be reviewed and updated regularly to ensure accuracy.

Type:Contact

admin

Registrants often designate an administrative contact to manage their domain name(s). They primarily deal with business information such as the name on record, postal address, and contact information for the official registrant.

Type:Contact

tech

The technical contact manages and maintains a domain’s nameservers. If you’re working with a web designer or someone in a similar role, you many want to assign them as a technical contact.

Type:Contact

billing

The billing contact is the party responsible for paying bills for the account and taking care of renewals.

Type:Contact

class namecom.Contact(firstName, lastName, companyName=None, address1=None, address2=None, city=None, state=None, zip=None, country=None, phone=None, fax=None, email=None)

This class contains all the contact data.

firstName

First name of the contact.

Type:string

lastName

Last name of the contact.

Type:string

companyName

Company name of the contact. Leave blank if the contact is an individual as some registries will assume it is a corporate entity otherwise.

Type:string

address1

Address1 is the first line of the contact’s address.

Type:string

address2

Address2 is the second line of the contact’s address.

Type:string

city

City of the contact’s address.

Type:string

state

State or Province for the contact’s address.

Type:string

zip

Zip or Postal Code for the contact’s address.

Type:string

country

Country code for the contact’s address. Required to be a ISO 3166-1 alpha-2 code.

Type:string

phone

Phone number of the contact. Should be specified in the following format: “+cc.llllllll” where cc is the country code and llllllll is the local number.

Type:string

fax

Fax number of the contact. Should be specified in the following format: “+cc.llllllll” where cc is the country code and llllllll is the local number.

Type:string

email

Email of the contact. Should be a complete and valid email address.

Type:string

class namecom.EmailForwarding(domainName, emailBox, emailTo)

EmailForwarding contains all the information for an email forwarding entry.

domainName

DomainName is the domain part of the email address to forward

Type:string

emailBox

DomainName is the domain part of the email address to forward

Type:string

emailTo

EmailTo is the entire email address to forward email to

Type:string

class namecom.Transfer(domainName, email, status)

Transfer contains the information related to a transfer of a domain name to Name.com.

domainName

DomainName is the domain to be transfered to Name.com.

Type:string

email

Email is the email address that the approval email was sent to. Not every TLD requries an approval email. This is usaully pulled from Whois.

Type:string

status

Status is the current status of the transfer. Details about statuses can be found in the following Knowledge Base article: https://www.name.com/support/articles/115012519688-Transfer-status-FAQ.

Type:string

class namecom.URLForwarding(domainName, host, forwardsTo, type, title=None, meta=None)

URLForwarding is the model for URL forwarding entries.

domainName

DomainName is the domain part of the hostname to forward.

Type:string

host

Host is the entirety of the hostname. i.e. www.example.org

Type:string

forwardsTo

ForwardsTo is the URL this host will be forwarded to.

Type:string

type

Type is the type of forwarding. Valid types are: Masked - This retains the original domain in the address bar and will not reveal or display the actual destination URL. If you are forwarding knowledgebase.ninja to Name.com, the address bar will say knowledgebase.ninja. This is sometimes called iframe forwarding. And: Redirect - This does not retain the original domain in the address bar, so the user will see it change and realize they were forwarded from the URL they originally entered. If you are forwarding knowledgebase.ninja to Name.com, the address bar will say Name.com. This is also called 301 forwarding.

Type:string

title

Title is the title for the html page to use if the type is masked. Values are ignored for types other then “masked”.

Type:string

meta

Meta is the meta tags to add to the html page if the type is masked. ex: “meta name=’keywords’ content=’fish, denver, platte’”. Values are ignored for types other then “masked”.

Type:string

class namecom.VanityNameserver(domainName, hostname, ips=None)

VanityNameserver contains the hostname as well as the list of IP addresses for nameservers.

domainName

DomainName is the domain the nameserver is a subdomain of.

Type:string

hostname

Hostname is the hostname of the nameserver.

Type:string

ips

IPs is a list of IP addresses that are used for glue records for this nameserver.

Type:[]string