# DNS

The DNS module for UAPI.

## Return whether domains only resolve locally

 - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server.

## Return whether local DNS server is authoritative

 - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records.

## Return  DNS record availability & resolver

 - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns::is_alias_available.md): This function returns whether  and  records are available and the value of the running PowerDNS (PDNS)  setting, if any exists.
For more information, read our  documentation.

## Return DNS HTTPS record support information

 - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/is_https_available.md): This function fetches information regarding HTTPS records support.
HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints.
For more information, read our HTTPS record documentation.

## Return domain's DNS information

 - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-lookup.md): This function returns DNS zone information about a domain.

## Update a DNS zone

 - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit.



You cannot use this function to edit temporary domains.

## Return a parsed DNS zone

 - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-parse_zone.md): This function parses a given DNS zone.



Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function's base64 output  be able to handle cases
where the decoded octets do not match any specific character
encoding.

## Update IP addresses in zone files

 - [GET /DNS/swap_ip_in_zones](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-swap_ip_in_zones.md): This function replaces a domain's IPv4 address in the DNS zone
file with the specified destination IPv4 address.

## Return whether domains only resolve locally

 - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server.

## Return whether local DNS server is authoritative

 - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records.

## Return  DNS record availability & resolver

 - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns::is_alias_available.md): This function returns whether  and  records are available and the value of the running PowerDNS (PDNS)  setting, if any exists.
For more information, read our  documentation.

## Return DNS HTTPS record support information

 - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/is_https_available.md): This function fetches information regarding HTTPS records support.
HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints.
For more information, read our HTTPS record documentation.

## Return domain's DNS information

 - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-lookup.md): This function returns DNS zone information about a domain.

## Update a DNS zone

 - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit.



You cannot use this function to edit temporary domains.

## Return a parsed DNS zone

 - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-parse_zone.md): This function parses a given DNS zone.



Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function's base64 output  be able to handle cases
where the decoded octets do not match any specific character
encoding.