Skip to content
Docs

Get a Domain's configuration

GEThttps://api.vercel.com/v6/domains/{domain}/config
Get a Domain's configuration.
https://api.vercel.com/v6/domains/{domain}/config
const response = await fetch('https://api.vercel.com/v6/domains/domain/config?projectIdOrName=string&strict=value&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "configuredBy": "A",
  "acceptedChallenges": [],
  "recommendedIPv4": [
    {
      "rank": "123",
      "value": []
    }
  ],
  "recommendedCNAME": [
    {
      "rank": "123",
      "value": "string"
    }
  ],
  "misconfigured": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

domainstringRequired
The name of the domain.

Query parameters

projectIdOrNamestringOptional
The project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project.
strictanyOptional
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.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
configuredBystringRequired
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.
acceptedChallengesarrayRequired
Which challenge types the domain can use for issuing certs.
recommendedIPv4arrayRequired
Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable.
recommendedCNAMEarrayRequired
Recommended CNAMEs for the domain. rank=1 is the preferred value to use.
misconfiguredbooleanRequired
Whether or not the domain is configured AND we can automatically generate a TLS certificate.

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
410Error