hostnames

Set the hostname IP

Puts an IP on the hostname. If the address is unchanged, DNS is not rewritten. If it changed, the record is replaced and the name comes back live. Request bodies are capped at 4KB. A hostname keeps the address class it was minted with. Repointing within a class is free, including between A and AAAA; crossing from public to private or private to public returns 409. This blocks DNS rebinding, where one origin is public first, to deliver a payload under a trusted certificate, and private second, to read a response from inside the visitor's network. Release the hostname and mint a new one for the other class.

Send target instead of ip to follow a platform endpoint that publishes no address of its own. We resolve it and serve A or AAAA, so the hostname keeps its certificates, its CAA and every child record.

put/v1/hostnames/{id}

Request

  • Base URL: https://dnsmint.com/api
  • URL: https://dnsmint.com/api/v1/hostnames/{id}
  • Auth: HTTP bearer

Request body

ipstring

An IPv4 or IPv6 address, public or private. Private and reserved ranges are accepted on every plan. A hostname keeps the address class it was minted with. Repointing within a class is free, including between A and AAAA; crossing from public to private or private to public returns 409. This blocks DNS rebinding, where one origin is public first, to deliver a payload under a trusted certificate, and private second, to read a response from inside the visitor's network. Release the hostname and mint a new one for the other class.

targetstring

A platform endpoint to follow instead of an address. Send this or ip, never both. We resolve it and publish ordinary A and AAAA records, refreshed within the target's own TTL, so the name never carries a CNAME and every record you set on the hostname keeps working. The hostname keeps the address class it was minted with, and that is re-checked every time we refresh rather than only when you set it: a target that starts answering with a private address is refused and the hostname stays on its last public one. Setting ip takes the hostname back off its target.

Response

The updated hostname.

idstring required

Opaque identifier used in the /v1/hostnames/{id} paths.

hostnamestring required

The fully qualified hostname: an opaque subdomain on a domain assigned to your account.

status'pending' | 'live' | 'released' | 'suspended' | 'terminated' required

pending: registered, not yet confirmed on the nameservers. live: the record is served, and it stays so until you release it. released: you released it; writes return 409 and the subdomain can be minted again as a new hostname. suspended: held while an abuse report is reviewed; it stops resolving and writes return 403, but nothing is lost if the report is not upheld. terminated: an abuse report was upheld, not reversible. New registrations may briefly return pending; poll GET until live.

certificate'self' | 'csr' | 'managed' required

Who holds the private key. self: you, and you run the ACME client. csr: you hold the key and we run the protocol around your signed request. managed: we generate the key, obtain and renew the certificate, and keep a copy for you to fetch.

created_atstring date-time required

When the hostname was registered.

Changes

No recorded changes to this operation across all 1 revision of this API.