NameBright Domain API Help

Purchase

MethodAPIDescription
GET /rest/purchase/availability/{domain}

Gets information about the availability of the specified domain.

POST /rest/purchase/renew

Requests the purchase of a domain renewal for a domain within the current account.

POST /rest/purchase/register

Requests the purchase of a domain registration.

Account

MethodAPIDescription
GET /rest/account

Returns financial information (currently: the account balance) about the account.

AccountDomains

MethodAPIDescription
GET /rest/account/domains/{domain}

Gets the specified domain.

GET /rest/account/domains?page={page}&domainsPerPage={domainsPerPage}

Gets a list of domains from the account.

PUT /rest/account/domains/{domain}?optOutOfLock={optOutOfLock}

Updates locking, auto-renew, or whois privacy status on the domain.

Contacts

MethodAPIDescription
GET /rest/account/domains/{domain}/contacts/all

Gets all contacts for the specified domain. The "all" portion of the path is optional.

PUT /rest/account/domains/{domain}/contacts/all

Updates all fields on all contacts to match this contact

GET /rest/account/domains/{domain}/contacts/technical

Gets the technical contact for the specified domain.

PUT /rest/account/domains/{domain}/contacts/technical

Updates any fields contained within the contact parameter on the contact.

GET /rest/account/domains/{domain}/contacts/administrative

Gets the administrative contact for the specified domain.

PUT /rest/account/domains/{domain}/contacts/administrative

Updates any fields contained within the contact parameter on the contact.

GET /rest/account/domains/{domain}/contacts/registrant

Gets the registrant contact for the specified domain.

PUT /rest/account/domains/{domain}/contacts/registrant?optOutOfLock={optOutOfLock}

Updates any fields contained within the contact parameter on the contact.

NameServers

MethodAPIDescription
GET /rest/account/domains/{domain}/nameservers

Gets a list of nameservers set on the domain.

GET /rest/account/domains/{domain}/nameservers/{nameServer}

Verifies that an existing nameserver is set on the domain.

PUT /rest/account/domains/{domain}/nameservers/{nameServer}

Puts the specified domain.

DELETE /rest/account/domains/{domain}/nameservers/{nameServer}

Deletes the specified name server.

DELETE /rest/account/domains/{domain}/nameservers

Deletes all nameservers on the specified domain.

HostRecords

MethodAPIDescription
GET /rest/account/domains/{domain}/hostrecords/all

Returns all host records for a given domain. The url path "all" is optional.

GET /rest/account/domains/{domain}/hostrecords/a

Returns a list of DNS "A" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/a/{id}

Deletes a specific "A" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/a

Creates an "A" record on the domain.

GET /rest/account/domains/{domain}/hostrecords/aaaa

Returns a list of DNS "AAAA" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/aaaa/{id}

Deletes a specific "AAAA" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/aaaa

Creates an "AAAA" record on the domain.

GET /rest/account/domains/{domain}/hostrecords/cname

Returns a list of DNS "CNAME" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/cname/{id}

Deletes a specific "CNAME" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/cname

Creates a "CNAME" record on the domain.

GET /rest/account/domains/{domain}/hostrecords/mx

Returns a list of DNS "MX" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/mx/{id}

Deletes a specific "MX" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/mx

Creates an "MX" record on the domain.

GET /rest/account/domains/{domain}/hostrecords/srv

Returns a list of DNS "SRV" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/srv/{id}

Deletes a specific "SRV" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/srv

Creates an "SRV" record on the domain.

GET /rest/account/domains/{domain}/hostrecords/txt

Returns a list of DNS "TXT" records set on the domain.

DELETE /rest/account/domains/{domain}/hostrecords/txt/{id}

Deletes a specific "TXT" record set on the domain by id.

POST /rest/account/domains/{domain}/hostrecords/txt

Creates a "TXT" record on the domain.

InboundPush

MethodAPIDescription
PUT /rest/account/inboundpush/Accept?domain={domain}

Accepts a pending inbound domain push (account change). Once accepted, the domain name will have transferred ownership to your account.

DELETE /rest/account/inboundpush/Decline?domain={domain}

Rejects a pending inbound domain push (account change). If rejected, the domain name will remain in the former account.

GET /rest/account/inboundpush/Pending?page={page}&domainsPerPage={domainsPerPage}

Get a list of domains in the account accessible to the API application that are pending an inbound push (account change).

GET /rest/account/inboundpush/Completed?page={page}&domainsPerPage={domainsPerPage}

Get a list of domains in the account accessible to the API application that have completed an inbound push (account change).

PUT /rest/account/inboundpush/{domain}/Accept

Accepts a pending inbound domain push (account change). Once accepted, the domain name will have transferred ownership to your account.

DELETE /rest/account/inboundpush/{domain}/Decline

Rejects a pending inbound domain push (account change). If rejected, the domain name will remain in the former account.

OutboundPush

MethodAPIDescription
POST /rest/account/outboundpush/ForcePush?domain={domain}

Pushes a domain to a different NameBright account. If an account does not exist for the given email address in the contact property, one will be created and a temporary password will be sent to that email address.

POST /rest/account/outboundpush/Initiate?domain={domain}&emailAddress={emailAddress}&optOutOfLock={optOutOfLock}

Initiates an account change (push) for a domain name. An account with the specified email address must already exist in the NameBright system. The owner of that account will be notified and will have the ability to accept or reject the domain. Once accepted, the ownership of the domain will have transferred to the account specified by the email address provided.

DELETE /rest/account/outboundpush/Cancel?domain={domain}

Cancels a pending account change (push) for a domain name. There must be a pending push for that domain name and the domain must still be in your account. If cancelled, the remote account will no longer be able to accept the domain.

GET /rest/account/outboundpush/Pending?page={page}&domainsPerPage={domainsPerPage}

Get a list of domains in the account accessible to the API application that are pending an inbound push (account change).

GET /rest/account/outboundpush/Completed?page={page}&domainsPerPage={domainsPerPage}

Get a list of domains in the account accessible to the API application that have completed an outbound push (account change).

POST /rest/account/outboundpush/{domain}/ForcePush

Pushes a domain to a different NameBright account. If an account does not exist for the given email address in the contact property, one will be created and a temporary password will be sent to that email address.

POST /rest/account/outboundpush/{domain}/Initiate?emailAddress={emailAddress}&optOutOfLock={optOutOfLock}

Initiates an account change (push) for a domain name. An account with the specified email address must already exist in the NameBright system. The owner of that account will be notified and will have the ability to accept or reject the domain. Once accepted, the ownership of the domain will have transferred to the account specified by the email address provided.

DELETE /rest/account/outboundpush/{domain}/Cancel

Cancels a pending account change (push) for a domain name. There must be a pending push for that domain name and the domain must still be in your account. If cancelled, the remote account will no longer be able to accept the domain.

DomainWhoIsAccuracy

MethodAPIDescription
GET /rest/account/domains/{domain}/whoisaccuracy

Gets the whois accuracy information for a specific domain.

ContactVerification

MethodAPIDescription
GET /rest/account/domains/{domain}/contactverifications

Get the contact verifications for a domain

POST /rest/account/contactverification/SendEmail

Send an email verification request

POST /rest/account/contactverification/SendPhoneNumber

Send a phone verification request via SMS or voice call

POST /rest/account/contactverification/VerifyEmail

Verify an email using its auth code

POST /rest/account/contactverification/VerifyPhoneNumber

Verify a phone number using its auth code

POST /rest/account/contactverification/VerifyContact

Submit the link verification code for an unknown contact. This can happen if a user clicks from an email or text.