GET
/
v5
/
domains
/
{domain}
import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();
{
  "domain": {
    "suffix": true,
    "verified": true,
    "nameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "intendedNameservers": [
      "ns1.vercel-dns.com",
      "ns2.vercel-dns.com"
    ],
    "customNameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "creator": {
      "id": "ZspSRT4ljIEEmMHgoDwKWDei",
      "username": "vercel_user",
      "email": "demo@example.com"
    },
    "teamId": "<string>",
    "boughtAt": 1613602938882,
    "name": "example.com",
    "createdAt": 1613602938882,
    "expiresAt": 1613602938882,
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "orderedAt": 1613602938882,
    "renew": true,
    "serviceType": "zeit.world",
    "transferredAt": 1613602938882,
    "transferStartedAt": 1613602938882,
    "userId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
domain
string
required

The name of the domain.

Example:

"example.com"

Query Parameters

​
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

Successful response retrieving an information for a specific domains.

The response is of type object.

GET
/
v5
/
domains
/
{domain}
import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();
{
  "domain": {
    "suffix": true,
    "verified": true,
    "nameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "intendedNameservers": [
      "ns1.vercel-dns.com",
      "ns2.vercel-dns.com"
    ],
    "customNameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "creator": {
      "id": "ZspSRT4ljIEEmMHgoDwKWDei",
      "username": "vercel_user",
      "email": "demo@example.com"
    },
    "teamId": "<string>",
    "boughtAt": 1613602938882,
    "name": "example.com",
    "createdAt": 1613602938882,
    "expiresAt": 1613602938882,
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "orderedAt": 1613602938882,
    "renew": true,
    "serviceType": "zeit.world",
    "transferredAt": 1613602938882,
    "transferStartedAt": 1613602938882,
    "userId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
domain
string
required

The name of the domain.

Example:

"example.com"

Query Parameters

​
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

Successful response retrieving an information for a specific domains.

The response is of type object.