Authorizations
Default authentication mechanism
Path Parameters
The name of the domain.
"example.com"
Query Parameters
The project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project.
When true, the response will only include the nameservers assigned directly to the specified domain. When false and there are no nameservers assigned directly to the specified domain, the response will include the nameservers of the domain's parent zone.
true
, false
The Team identifier to perform the request on behalf of.
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
"my-team-url-slug"
Response
How we see the domain's configuration. - CNAME
: Domain has a CNAME pointing to Vercel. - A
: Domain's A record is resolving to Vercel. - http
: Domain is resolving to Vercel but may be behind a Proxy. - dns-01
: Domain is not resolving to Vercel but dns-01 challenge is enabled. - null
: Domain is not resolving to Vercel.
CNAME
, A
, http
, dns-01
Which challenge types the domain can use for issuing certs.
Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable.
Recommended CNAMEs for the domain. rank=1 is the preferred value to use.
Whether or not the domain is configured AND we can automatically generate a TLS certificate.