hostnames

Read one hostname

Returns one hostname. New registrations may briefly return "pending"; poll GET until "live".

get/v1/hostnames/{id}

Request

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

Response

The 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.