Domain (do.domain)

Domain resources are domain names that you have purchased from a domain name registrar that you are managing through the DigitalOcean DNS interface.

This resource establishes top-level control over each domain. Actions that affect individual domain records should be taken on the [Domain Records] resource.

List all Domains

do.domain.list()

Returns:

• A list of Domain dict’s
  • name - string - The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
  • ttl - number - This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
  • zone_file - string - This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Related:

• https://developers.digitalocean.com/documentation/v2/#list-all-domains

Create a new Domain

do.domain.create(name, ip_address)

• name - string - The domain name to add to the DigitalOcean DNS management interface. The name must be unique in DigitalOcean’s DNS system. The request will fail if the name has already been taken.
• ip_address - string - This attribute contains the IP address you want the domain to point to.

Returns:

• A Domain dict
  • name - string - The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
  • ttl - number - This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
  • zone_file - string - This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Related:

• https://developers.digitalocean.com/documentation/v2/#create-a-new-domain

Create a new Domain if name doesn’t already exist

do.domain.present(name, ip_address)

• name - string - The domain name to add to the DigitalOcean DNS management interface. The name must be unique in DigitalOcean’s DNS system. The request will fail if the name has already been taken.
• ip_address - string - This attribute contains the IP address you want the domain to point to.

Returns:

• A tuple of Domain dict’s, the intended, and created (None if already exists)
  • name - string - The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
  • ttl - number - This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
  • zone_file - string - This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Related:

• https://developers.digitalocean.com/documentation/v2/#create-a-new-domain

Retrieve an existing Domain

do.domain.info(name)

• name - string - The name of the domain to retrieve

Returns:

• A Domain dict
  • name - string - The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
  • ttl - number - This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
  • zone_file - string - This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Related:

• https://developers.digitalocean.com/documentation/v2/#retrieve-an-existing-domain

Delete a Domain

do.domain.destroy(name)

• name - string - The name of the domain to destroy

Returns:

• None. A DOBOTOException is thrown if an issue is encountered.

Related:

• https://developers.digitalocean.com/documentation/v2/#delete-a-domain

List all Domain Records

do.domain.record_list(name)

• name - string - The name of the domain, the Domain Records of which to retrieve

Returns:

• A list of Domain Record dict’s
  • id - number - A unique identifier for each domain record.
  • type - string - The type of the DNS record (A, CNAME, TXT, ...).
  • name - string - The name to use for the DNS record.
  • data - string - The value to use for the DNS record.
  • priority - nullable number - The priority for SRV and MX records.
  • port - nullable number - The port for SRV records.
  • weight - nullable number - The weight for SRV records.

Related:

• https://developers.digitalocean.com/documentation/v2/#list-all-domain-records

Create a new Domain Record

do.domain.record_create(name, attribs)

• name - string - The name of the domain
• attribs - dict - The data of the Domain Record in the following format
  • type - string - The record type (A, MX, CNAME, etc). - All Records
  • name - string - The host name, alias, or service being defined by the record. - A, AAAA, CNAME, TXT, SRV
  • data - string - Variable data depending on record type. See the [Domain Records]() section for more detail on each record type. - A, AAAA, CNAME, MX, TXT, SRV, NS
  • priority - nullable number - The priority of the host (for SRV and MX records. null otherwise). - MX, SRV
  • port - nullable number - The port that the service is accessible on (for SRV records only. null otherwise). - SRV
  • weight - nullable number - The weight of records with the same priority (for SRV records only. null otherwise). - SRV

Returns:

• A Domain Record dict
  • id - number - A unique identifier for each domain record.
  • type - string - The type of the DNS record (A, CNAME, TXT, ...).
  • name - string - The name to use for the DNS record.
  • data - string - The value to use for the DNS record.
  • priority - nullable number - The priority for SRV and MX records.
  • port - nullable number - The port for SRV records.
  • weight - nullable number - The weight for SRV records.

Related:

• https://developers.digitalocean.com/documentation/v2/#create-a-new-domain-record

Retrieve an existing Domain Record

do.domain.record_info(name, record_id)

• name - string - The name of the domain
• record_id - number - The id of the domain record to retrieve

Returns:

• A Domain Record dict
  • id - number - A unique identifier for each domain record.
  • type - string - The type of the DNS record (A, CNAME, TXT, ...).
  • name - string - The name to use for the DNS record.
  • data - string - The value to use for the DNS record.
  • priority - nullable number - The priority for SRV and MX records.
  • port - nullable number - The port for SRV records.
  • weight - nullable number - The weight for SRV records.

Related:

• https://developers.digitalocean.com/documentation/v2/#retrieve-an-existing-domain-record

Update a Domain Record

do.domain.record_update(name, record_id, attribs)

• name - string - The name of the domain
• record_id - number - The id of the domain record to update
• attribs - dict - The data of the Domain Record in the following format
  • type - string - The record type (A, MX, CNAME, etc). - All Records
  • name - string - The host name, alias, or service being defined by the record. - A, AAAA, CNAME, TXT, SRV
  • data - string - Variable data depending on record type. See the [Domain Records]() section for more detail on each record type. - A, AAAA, CNAME, MX, TXT, SRV, NS
  • priority - nullable number - The priority of the host (for SRV and MX records. null otherwise). - MX, SRV
  • port - nullable number - The port that the service is accessible on (for SRV records only. null otherwise). - SRV
  • weight - nullable number - The weight of records with the same priority (for SRV records only. null otherwise). - SRV

Returns:

• A Domain Record dict
  • id - number - A unique identifier for each domain record.
  • type - string - The type of the DNS record (A, CNAME, TXT, ...).
  • name - string - The name to use for the DNS record.
  • data - string - The value to use for the DNS record.
  • priority - nullable number - The priority for SRV and MX records.
  • port - nullable number - The port for SRV records.
  • weight - nullable number - The weight for SRV records.

Related:

• https://developers.digitalocean.com/documentation/v2/#update-a-domain-record

Delete a Domain Record

do.domain.record_destroy(name, record_id)

• name - string - The name of the domain
• record_id - number - The id of the domain record to destroy

Returns:

• None. A DOBOTOException is thrown if an issue is encountered.

Related:

• https://developers.digitalocean.com/documentation/v2/#delete-a-domain-record