# cPanel DNS API

**Canonical:** https://apis.io/apis/cpanel/cpanel-dns-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel DNS API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include DNS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The DNS module for UAPI.

## Operations (54)

| Method | Path | Summary |
|---|---|---|
| GET | `/DNS/ensure_domains_reside_only_locally` | Return whether domains only resolve locally |
| GET | `/DNS/fetch_cpanel_generated_domains` | Retrieve cPanel-generated subdomains for a domain |
| GET | `/DNS/has_local_authority` | Return whether local DNS server is authoritative |
| GET | `/DNS/is_alias_available` | Return `ALIAS` DNS record availability & resolver |
| GET | `/DNS/is_https_available` | Return DNS HTTPS record support information |
| GET | `/DNS/is_svcb_available` | Return DNS SVCB record support information |
| GET | `/DNS/lookup` | Return domain's DNS information |
| GET | `/DNS/mass_edit_zone` | Update a DNS zone |
| GET | `/DNS/parse_zone` | Return a parsed DNS zone |
| GET | `/DNS/swap_ip_in_zones` | Update IP addresses in zone files |
| GET | `/activate_zone_key` | Enable domain's DNSSEC key |
| GET | `/add_zone_key` | Create domain's DNSSEC zone key |
| GET | `/adddns` | Create DNS zone |
| POST | `/addzonerecord` | Create DNS zone record |
| GET | `/cluster_member_has_trust_with` | Return whether DNS cluster server can share records |
| GET | `/create_parked_domain_for_user` | Create domain alias |
| GET | `/create_subdomain` | Create subdomain |
| GET | `/deactivate_zone_key` | Disable domain's DNSSEC key |
| GET | `/delete_domain` | Delete domain |
| GET | `/disable_dnssec_for_domains` | Disable DNSSEC on domain |
| GET | `/dumpzone` | Return domain's DNS zone configuration |
| POST | `/editzonerecord` | Update DNS zone record |
| GET | `/enable_dnssec_for_domains` | Enable DNSSEC on domain |
| GET | `/export_zone_dnskey` | Export domain's DNSKEY record value |
| GET | `/export_zone_files` | Export DNS zones in zone file format |
| GET | `/export_zone_key` | Export domain's DNSSEC key |
| GET | `/fetch_ds_records_for_domains` | Return domain's DS record |
| GET | `/get_nameserver_config` | Return current user's nameservers |
| GET | `/getzonerecord` | Return specific line from domain's DNS configuration |
| GET | `/has_local_authority` | Validate local server is authoritative |
| GET | `/import_zone_key` | Import DNSSEC key |
| GET | `/is_alias_available` | Return `ALIAS` DNS record availability & resolver |
| GET | `/is_https_available` | Return HTTPS DNS record support information |
| GET | `/is_svcb_available` | Return SVCB DNS record support information |
| GET | `/killdns` | Delete DNS zone |
| GET | `/listmxs` | Return domain's mail exchanger records |
| GET | `/listzones` | Return server's DNS zones |
| GET | `/lookupnsip` | Return nameserver's IP address |
| GET | `/lookupnsips` | Return nameserver's IPv4 and IPv6 addresses |
| GET | `/mass_edit_dns_zone` | Update a DNS zone |
| GET | `/parse_dns_zone` | Return a parsed DNS zone |
| GET | `/remove_zone_key` | Remove DNSSEC key |
| GET | `/removezonerecord` | Delete DNS zone record |
| GET | `/resetzone` | Restore DNS zone to default values |
| GET | `/resolvedomainname` | Return domain's IP address |
| GET | `/savemxs` | Create mail exchanger record |
| GET | `/set_nameserver` | Update remote DNS server's nameserver software |
| GET | `/set_nsec3_for_domains` | Enable NSEC3 semantics for domain |
| GET | `/set_up_dns_resolver_workarounds` | Create unbound DNS resolver |
| GET | `/setresolvers` | Update server's resolver nameservers |
| GET | `/unset_nsec3_for_domains` | Enable NSEC semantics for domain |
| GET | `/update_nameservers_config` | Update default nameservers |
| GET | `/update_reverse_dns_cache` | Update reverse DNS cache |
| GET | `/updateuserdomains` | Update /etc/userdomains file |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-dns-api-openapi.yml
- **Documentation** — https://api.docs.cpanel.net/cpanel/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/cpanel.openapi
- **Authentication** — https://api.docs.cpanel.net/cpanel/tokens/
- **Documentation** — https://api.docs.cpanel.net/whm/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/whm.openapi
- **Authentication** — https://api.docs.cpanel.net/whm/tokens/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Authentication API](https://apis.io/apis/cpanel/cpanel-authentication-api/)

## Tags

DNS

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-dns-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.