domains

Get a Domain's configuration

Changed on

Get a Domain's configuration.

get/v6/domains/{domain}/config

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v6/domains/{domain}/config
  • Auth: HTTP bearer

Path parameters

domainstring required

The name of the domain.

Example:example.com

Query parameters

projectIdOrNamestring

The project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project.

strict'true' | 'false'

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.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

acceptedChallengesstring[] required

Which challenge types the domain can use for issuing certs.

configuredBy'A' | 'CNAME' | 'dns-01' | 'http' | 'null' nullable required

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.

misconfiguredfalse | true required

Whether or not the domain is configured AND we can automatically generate a TLS certificate.

Changes