Package com.dnsimple.endpoints

Class Domains

java.lang.Object

com.dnsimple.endpoints.Domains

public class Domains
extends Object

Provides access to the DNSimple Domains API.

See Also:

• https://developer.dnsimple.com/v2/domains

Constructor Summary

Constructors

Constructor	Description
Domains(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
EmptyResponse	acceptPush(Number account, Number push, Number contactId)	Accept a push.
SimpleResponse<DelegationSignerRecord>	createDelegationSignerRecord(Number account, String domain, DSRecordOptions options)	Create a delegation signer record for a domain.
SimpleResponse<Domain>	createDomain(Number account, String name)	Create a domain in an account.
SimpleResponse<EmailForward>	createEmailForward(Number account, String domain, String aliasName, String destinationEmail)	Create an email forward for a domain.
EmptyResponse	deleteDelegationSignerRecord(Number account, String domain, Number dsRecordId)	Delete a delegation signer record from a domain.
EmptyResponse	deleteDomain(Number account, String domain)	Delete a domain from an account.
EmptyResponse	deleteEmailForward(Number account, String domain, Number emailForward)	Delete an email forward from a domain.
EmptyResponse	disableDnssec(Number account, String domain)	Disables DNSSEC on the domain.
SimpleResponse<Dnssec>	enableDnssec(Number account, String domain)	Enables DNSSEC on the domain.
SimpleResponse<DelegationSignerRecord>	getDelegationSignerRecord(Number account, String domain, Number dsRecordId)	Get a delegation signer record for a domain using the delegation signer records's ID.
SimpleResponse<Dnssec>	getDnssec(Number account, String domain)	Get DNSSEC status of the domain.
SimpleResponse<Domain>	getDomain(Number account, String domain)	Get a specific domain associated to an account using the domain's name or ID.
SimpleResponse<EmailForward>	getEmailForward(Number account, String domain, Number emailForward)	Get a specific email forward associated to a domain using the email forward's ID.
SimpleResponse<DomainPush>	initiatePush(Number account, String domain, String newAccountEmail)	Initiate a push.
PaginatedResponse<DelegationSignerRecord>	listDelegationSignerRecords(Number account, String domain)	Lists the delegation signer records in the domain.
PaginatedResponse<DelegationSignerRecord>	listDelegationSignerRecords(Number account, String domain, ListOptions options)	Lists the delegation signer records in the domain.
PaginatedResponse<Domain>	listDomains(Number account)	Lists the domains in the account.
PaginatedResponse<Domain>	listDomains(Number account, ListOptions options)	Lists the domains in the account.
PaginatedResponse<EmailForward>	listEmailForwards(Number account, String domain)	List email forwards under a given domain.
PaginatedResponse<EmailForward>	listEmailForwards(Number account, String domain, ListOptions options)	List email forwards under a given domain.
PaginatedResponse<DomainPush>	listPushes(Number account)	List pushes under a given domain.
PaginatedResponse<DomainPush>	listPushes(Number account, ListOptions options)	List pushes under a given domain.
EmptyResponse	rejectPush(Number account, Number push)	Reject a push.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Domains

public Domains(HttpEndpointClient client)

Method Details

listDomains

public PaginatedResponse<Domain> listDomains(Number account)

Lists the domains in the account.

Parameters:

account - The account ID

Returns:

The list domains response

See Also:

• https://developer.dnsimple.com/v2/domains/#listDomains

listDomains

public PaginatedResponse<Domain> listDomains(Number account,
 ListOptions options)

Lists the domains in the account.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list domains response

See Also:

• https://developer.dnsimple.com/v2/domains/#listDomains

createDomain

public SimpleResponse<Domain> createDomain(Number account,
 String name)

Create a domain in an account.

Parameters:

account - The account ID

name - The name of the domain

Returns:

The create domain response

See Also:

• https://developer.dnsimple.com/v2/domains/#createDomain

getDomain

public SimpleResponse<Domain> getDomain(Number account,
 String domain)

Get a specific domain associated to an account using the domain's name or ID.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The get domain response

See Also:

• https://developer.dnsimple.com/v2/domains/#getDomain

deleteDomain

public EmptyResponse deleteDomain(Number account,
 String domain)

Delete a domain from an account.

WARNING: this cannot be undone.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The delete domain response

See Also:

• https://developer.dnsimple.com/v2/domains/#deleteDomain

enableDnssec

public SimpleResponse<Dnssec> enableDnssec(Number account,
 String domain)

Enables DNSSEC on the domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The DNSSEC enable response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#enableDomainDnssec

disableDnssec

public EmptyResponse disableDnssec(Number account,
 String domain)

Disables DNSSEC on the domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The DNSSEC disable response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#disableDomainDnsec

getDnssec

public SimpleResponse<Dnssec> getDnssec(Number account,
 String domain)

Get DNSSEC status of the domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The get DNSSEC response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#getDomainDnssec

listDelegationSignerRecords

public PaginatedResponse<DelegationSignerRecord> listDelegationSignerRecords(Number account,
 String domain)

Lists the delegation signer records in the domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The list delegation signer records response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#listDomainDelegationSignerRecords

listDelegationSignerRecords

public PaginatedResponse<DelegationSignerRecord> listDelegationSignerRecords(Number account,
 String domain,
 ListOptions options)

Lists the delegation signer records in the domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

options - The options for the list request

Returns:

The list delegation signer records response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#listDomainDelegationSignerRecords

createDelegationSignerRecord

public SimpleResponse<DelegationSignerRecord> createDelegationSignerRecord(Number account,
 String domain,
 DSRecordOptions options)

Create a delegation signer record for a domain.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options to create the DS record

Returns:

The create delegation signer record response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#createDomainDelegationSignerRecord

getDelegationSignerRecord

public SimpleResponse<DelegationSignerRecord> getDelegationSignerRecord(Number account,
 String domain,
 Number dsRecordId)

Get a delegation signer record for a domain using the delegation signer records's ID.

Parameters:

account - The account ID

domain - The domain name or ID

dsRecordId - The delegation signer record ID

Returns:

The get delegation signer record response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#getDomainDelegationSignerRecord

deleteDelegationSignerRecord

public EmptyResponse deleteDelegationSignerRecord(Number account,
 String domain,
 Number dsRecordId)

Delete a delegation signer record from a domain.

WARNING: this cannot be undone.

Parameters:

account - The account ID

domain - The domain ID or name or name

dsRecordId - The delegation signer record ID

Returns:

The delete delegation signer record response

See Also:

• https://developer.dnsimple.com/v2/domains/dnssec/#deleteDomainDelegationSignerRecord

listEmailForwards

public PaginatedResponse<EmailForward> listEmailForwards(Number account,
 String domain)

List email forwards under a given domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

Returns:

The list email forwards response

See Also:

• https://developer.dnsimple.com/v2/domains/email-forwards/#listEmailForwards

listEmailForwards

public PaginatedResponse<EmailForward> listEmailForwards(Number account,
 String domain,
 ListOptions options)

List email forwards under a given domain.

Parameters:

account - The account ID

domain - The domain ID or name or name

options - The options for the list request

Returns:

The list email forwards response

See Also:

• https://developer.dnsimple.com/v2/domains/email-forwards/#listEmailForwards

createEmailForward

public SimpleResponse<EmailForward> createEmailForward(Number account,
 String domain,
 String aliasName,
 String destinationEmail)

Create an email forward for a domain.

Parameters:

account - The account ID

domain - The domain name or ID

aliasName - The email address the emails are send to

destinationEmail - The email address the email address the emails are forwarded to.

Returns:

The create email forward response

See Also:

• https://developer.dnsimple.com/v2/domains/email-forwards/#createEmailForward

getEmailForward

public SimpleResponse<EmailForward> getEmailForward(Number account,
 String domain,
 Number emailForward)

Get a specific email forward associated to a domain using the email forward's ID.

Parameters:

account - The account ID

domain - The domain name or ID

emailForward - The email forward ID

Returns:

The get email forward response

See Also:

• https://developer.dnsimple.com/v2/domains/email-forwards/#getEmailForward

deleteEmailForward

public EmptyResponse deleteEmailForward(Number account,
 String domain,
 Number emailForward)

Delete an email forward from a domain.

WARNING: this cannot be undone.

Parameters:

account - The account ID

domain - The domain ID or name or name

emailForward - The email forward ID

Returns:

The delete email forward response

See Also:

• https://developer.dnsimple.com/v2/domains/email-forwards/#deleteEmailForward

initiatePush

public SimpleResponse<DomainPush> initiatePush(Number account,
 String domain,
 String newAccountEmail)

Initiate a push.

Parameters:

account - The account ID

domain - The domain name or ID

newAccountEmail - The email address of the target DNSimple account

Returns:

The initiate push response

See Also:

• https://developer.dnsimple.com/v2/domains/pushes/#initiateDomainPush

listPushes

public PaginatedResponse<DomainPush> listPushes(Number account)

List pushes under a given domain.

Parameters:

account - The account ID

Returns:

The list pushes response

See Also:

• https://developer.dnsimple.com/v2/domains/pushes/#listPushes

listPushes

public PaginatedResponse<DomainPush> listPushes(Number account,
 ListOptions options)

List pushes under a given domain.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list pushes response

See Also:

• https://developer.dnsimple.com/v2/domains/pushes/#listPushes

acceptPush

public EmptyResponse acceptPush(Number account,
 Number push,
 Number contactId)

Accept a push.

Parameters:

account - The account ID

push - The push ID

contactId - A contact that belongs to the target DNSimple account

Returns:

The accept push response

See Also:

• https://developer.dnsimple.com/v2/domains/pushes/#acceptPush

rejectPush

public EmptyResponse rejectPush(Number account,
 Number push)

Reject a push.

Parameters:

account - The account ID

push - The push ID

Returns:

The accept push response

See Also:

• https://developer.dnsimple.com/v2/domains/pushes/#rejectPush