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

200
application/json

The response is of type object.