GET
/
v6
/
domains
/
{domain}
/
config
getDomainConfig
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domains.getDomainConfig({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "configuredBy": "CNAME",
  "acceptedChallenges": [
    "dns-01"
  ],
  "recommendedIPv4": [
    {
      "rank": 123,
      "value": [
        "<string>"
      ]
    }
  ],
  "recommendedCNAME": [
    {
      "rank": 123,
      "value": "<string>"
    }
  ],
  "misconfigured": true
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
domain
string
required

The name of the domain.

Example:

"example.com"

Query Parameters

​
projectIdOrName
string

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
enum<string>

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.

Available options:
true,
false
​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

​
configuredBy
enum<string> | null
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.

Available options:
CNAME,
A,
http,
dns-01
​
acceptedChallenges
enum<string>[]
required

Which challenge types the domain can use for issuing certs.

​
recommendedIPv4
object[]
required

Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable.

​
recommendedCNAME
object[]
required

Recommended CNAMEs for the domain. rank=1 is the preferred value to use.

​
misconfigured
boolean
required

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