# dns-api ## Pages - [DNS API](https://docs.ezghcloud.com/dns-api/index.md) — Public authoritative DNS. Zones live in a project. Every path is under an organization; lists are paged with limit, cursor and nextCursor. - [Change a zone's record sets](https://docs.ezghcloud.com/dns-api/ChangeRecordSets/index.md) — Atomic: every change applies, or none does. Works on a pending zone, so records can be loaded before it goes live. A set with managedBy is refused with 409 managed_record_set, as is another type at a managed CNAME's name. - [Create a zone](https://docs.ezghcloud.com/dns-api/CreateZone/index.md) — The zone is pending until it proves control of the domain: a TXT record at verification.txtName, or a delegation to its nameservers. A domain can be pending in several organizations. - [Delete a zone](https://docs.ezghcloud.com/dns-api/DeleteZone/index.md) — The zone shows deleting until it's off every server, then 404. Refused with 409 managed_by_domains while `domainId` is set. Refused with 409 zone_has_managed_records while another service manages records in it. - [Stop signing a zone](https://docs.ezghcloud.com/dns-api/DisableZoneDnssec/index.md) — Validation fails for the domain if its DS is still at the registrar: remove the DS first. Refused with 409 managed_by_domains while `domainId` is set. - [Sign a zone with DNSSEC](https://docs.ezghcloud.com/dns-api/EnableZoneDnssec/index.md) — dnssec.dsRecords shows the DS values once signing starts. - [Export a zone's record sets as a zone file](https://docs.ezghcloud.com/dns-api/ExportRecordSets/index.md) — A complete BIND zone file: $ORIGIN, the zone's SOA and own NS, then each record by its absolute name. Parsing it leaves out the SOA and NS, which are managed; within parse's limits it gives back the same record sets. Refused with 409 zone_deleting once the zone is being deleted. - [Get a zone](https://docs.ezghcloud.com/dns-api/GetZone/index.md) - [Check a zone's DS at its parent](https://docs.ezghcloud.com/dns-api/GetZoneDnssec/index.md) — Whether the zone's DS record is published at its parent, which is what makes DNSSEC take effect. It reads the public DNS, so it can lag a change at your registrar. parentDs is published, missing, mismatch (a DS is there, but not this zone's), stale (DNSSEC is off here and a DS is still published), not_delegated (the domain doesn't use this zone's nameservers yet, so a DS there isn't this zone's), parent_unsigned (the zones above aren't signed, so nothing can validate this one), or unknown (the check didn't finish, or there's nothing to compare). - [Get a zone's SOA](https://docs.ezghcloud.com/dns-api/GetZoneSoa/index.md) — The zone's start of authority, which is managed for you. serial is what's being served, or null when that isn't known: the zone isn't active, or the serving system didn't answer. - [List a zone's record sets, by name and type](https://docs.ezghcloud.com/dns-api/ListRecordSets/index.md) - [List a project's zones, newest first](https://docs.ezghcloud.com/dns-api/ListZones/index.md) - [Read a zone file into a proposal](https://docs.ezghcloud.com/dns-api/ParseZoneFile/index.md) — Writes nothing: answers the record sets a BIND zone file holds, to review and apply through records/changes, with what it left out in skipped and what it changed in adjusted. $ORIGIN defaults to the zone; $INCLUDE is refused. A file that doesn't parse is 400, naming the line. More than 1000 record sets is 400, as is what's too large for one change to apply, and over 256 KiB is 413. Refused with 409 zone_deleting once the zone is being deleted. Takes no Idempotency-Key: it keeps nothing, so a retry runs again. - [Look up a domain's existing records into a proposal](https://docs.ezghcloud.com/dns-api/ScanRecordSets/index.md) — Writes nothing: asks the nameservers the domain's parent delegates it to for a fixed list of common names and types, and answers what it found, to review and apply through records/changes. DNS can't list a zone, so names outside that list aren't found. Takes about 8 seconds at most, and answers what it found by then, with one note in skipped whose type is empty when it couldn't ask everything. A domain that isn't delegated, or that's delegated to EZGH DNS, gives an empty proposal. Takes no body. Refused with 409 zone_deleting once the zone is being deleted. Takes no Idempotency-Key: it keeps nothing, so a retry runs again. - [Check a zone's proof of control now](https://docs.ezghcloud.com/dns-api/VerifyZone/index.md) — A zone that passes goes active; one that doesn't stays as it is. Checks also run on their own, about every minute for a zone's first hour, then hourly for 14 days. - [DnssecStatus](https://docs.ezghcloud.com/dns-api/schemas/DnssecStatus/index.md) - [Error](https://docs.ezghcloud.com/dns-api/schemas/Error/index.md) — Every non-2xx answer. Clients branch on code, never on message. - [QuotaExceeded](https://docs.ezghcloud.com/dns-api/schemas/QuotaExceeded/index.md) — quota_exceeded: the quota that refused the request. Never with Retry-After. - [RecordChange](https://docs.ezghcloud.com/dns-api/schemas/RecordChange/index.md) - [RecordChanges](https://docs.ezghcloud.com/dns-api/schemas/RecordChanges/index.md) - [RecordNote](https://docs.ezghcloud.com/dns-api/schemas/RecordNote/index.md) - [RecordProposal](https://docs.ezghcloud.com/dns-api/schemas/RecordProposal/index.md) - [RecordSet](https://docs.ezghcloud.com/dns-api/schemas/RecordSet/index.md) - [RecordSetList](https://docs.ezghcloud.com/dns-api/schemas/RecordSetList/index.md) - [Tags](https://docs.ezghcloud.com/dns-api/schemas/Tags/index.md) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved. - [Zone](https://docs.ezghcloud.com/dns-api/schemas/Zone/index.md) - [ZoneCreate](https://docs.ezghcloud.com/dns-api/schemas/ZoneCreate/index.md) - [ZoneFile](https://docs.ezghcloud.com/dns-api/schemas/ZoneFile/index.md) - [ZoneList](https://docs.ezghcloud.com/dns-api/schemas/ZoneList/index.md) - [ZoneSoa](https://docs.ezghcloud.com/dns-api/schemas/ZoneSoa/index.md)