# domains-api ## Pages - [Domains API](https://docs.ezghcloud.com/domains-api/index.md) — EZGH Domains: search for domain names, register them with an EZGH DNS zone, delegation and DNSSEC in one step, and renew and manage them. Every path is under an organization; lists are paged with limit, cursor and nextCursor. - [Cancel an operation](https://docs.ezghcloud.com/domains-api/CancelOperation/index.md) — 409 operation_finished or operation_not_cancellable when it can't be cancelled. - [Check whether names can be registered, and their prices](https://docs.ezghcloud.com/domains-api/CheckDomainAvailability/index.md) — Up to 50 names. A name that isn't offered (an unsupported TLD, an invalid name) gets a reason rather than failing the request. Prices are ours, in USD, for the years asked. Not recorded in Trails. - [Turn DNSSEC off](https://docs.ezghcloud.com/domains-api/DisableDomainDnssec/index.md) — Asynchronous: the DS record is removed at the registry and left to expire from caches before the zone stops signing. - [Turn DNSSEC on](https://docs.ezghcloud.com/domains-api/EnableDomainDnssec/index.md) — Asynchronous; 200 with the domain when it's already on. Needs EZGH DNS. - [Get a domain](https://docs.ezghcloud.com/domains-api/GetDomain/index.md) — domain is the domain's id or its dom_ slug. - [Get an operation (poll it until it finishes)](https://docs.ezghcloud.com/domains-api/GetOperation/index.md) — While it's queued or running, Retry-After suggests when to poll again. Not recorded in Trails. - [Get the organization's default registrant contact](https://docs.ezghcloud.com/domains-api/GetRegistrantContact/index.md) — 404 not_found when none is set. Answers an ETag. - [List a project's domains, by name](https://docs.ezghcloud.com/domains-api/ListDomains/index.md) - [List the organization's operations, newest first](https://docs.ezghcloud.com/domains-api/ListOperations/index.md) - [Register a domain](https://docs.ezghcloud.com/domains-api/RegisterDomain/index.md) — Asynchronous: answers 202 with the operation, which charges the organization's card, registers the domain and, with EZGH DNS, delegates it to the project's zone (made now) and publishes the DS record. Refused before any charge: 409 domain_unavailable, price_changed, premium_not_supported, payment_method_required; 400 tld_not_supported, terms_not_accepted. - [Renew a domain](https://docs.ezghcloud.com/domains-api/RenewDomain/index.md) — Asynchronous. expectedPrice is years × renewal.price; 409 price_changed before any charge when it moved. - [Email the registrant's ICANN verification again](https://docs.ezghcloud.com/domains-api/ResendDomainRegistrantVerification/index.md) — 409 not_pending unless verification is pending; 429 when it was sent recently. - [Turn auto-renew or WHOIS privacy on or off](https://docs.ezghcloud.com/domains-api/UpdateDomain/index.md) - [Delegate the domain to EZGH DNS or to external nameservers](https://docs.ezghcloud.com/domains-api/UpdateDomainNameservers/index.md) — Asynchronous; 200 with the domain when nothing changes. Moving away from EZGH DNS removes the DS record first and waits for it to expire from caches. - [Set the domain's registrant contact](https://docs.ezghcloud.com/domains-api/UpdateDomainRegistrant/index.md) — A contact, or null for the organization's default. Sent to the registrar at once. - [Set the organization's default registrant contact](https://docs.ezghcloud.com/domains-api/UpdateRegistrantContact/index.md) — Also updates, at the registrar, every registered domain that uses the default. If-Match is honoured (412 when stale). A filled companyName makes that organization the domains' legal registrant. - [Availability](https://docs.ezghcloud.com/domains-api/schemas/Availability/index.md) - [AvailabilityRequest](https://docs.ezghcloud.com/domains-api/schemas/AvailabilityRequest/index.md) - [Contact](https://docs.ezghcloud.com/domains-api/schemas/Contact/index.md) — A registrant contact: printable ASCII only. name.com requires state and zip for every country. - [Domain](https://docs.ezghcloud.com/domains-api/schemas/Domain/index.md) - [DomainList](https://docs.ezghcloud.com/domains-api/schemas/DomainList/index.md) - [Error](https://docs.ezghcloud.com/domains-api/schemas/Error/index.md) — Every non-2xx answer. Clients branch on code, never on message. - [NameserversRequest](https://docs.ezghcloud.com/domains-api/schemas/NameserversRequest/index.md) - [Operation](https://docs.ezghcloud.com/domains-api/schemas/Operation/index.md) - [OperationList](https://docs.ezghcloud.com/domains-api/schemas/OperationList/index.md) - [OperationStatus](https://docs.ezghcloud.com/domains-api/schemas/OperationStatus/index.md) - [QuotaExceeded](https://docs.ezghcloud.com/domains-api/schemas/QuotaExceeded/index.md) — quota_exceeded: the quota that refused the request. Never with Retry-After. - [RegisterDomainRequest](https://docs.ezghcloud.com/domains-api/schemas/RegisterDomainRequest/index.md) - [RenewDomainRequest](https://docs.ezghcloud.com/domains-api/schemas/RenewDomainRequest/index.md) - [Tags](https://docs.ezghcloud.com/domains-api/schemas/Tags/index.md) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved. - [UpdateDomainRequest](https://docs.ezghcloud.com/domains-api/schemas/UpdateDomainRequest/index.md)