Get Information for a Single Domain

GET

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",
  });

  // Handle the result
  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.

domain

object

required

domain.suffix

boolean

required

domain.verified

boolean

required

If the domain has the ownership verified.

Example:

true

domain.nameservers

string[]

required

A list of the current nameservers of the domain.

Example:

["ns1.nameserver.net", "ns2.nameserver.net"]

domain.intendedNameservers

string[]

required

A list of the intended nameservers for the domain to point to Vercel DNS.

Example:

["ns1.vercel-dns.com", "ns2.vercel-dns.com"]

domain.creator

object

required

An object containing information of the domain creator, including the user's id, username, and email.

Example:

{
  "id": "ZspSRT4ljIEEmMHgoDwKWDei",
  "username": "vercel_user",
  "email": "demo@example.com"
}

domain.teamId

string | null

required

domain.boughtAt

number | null

required

If it was purchased through Vercel, the timestamp in milliseconds when it was purchased.

Example:

1613602938882

domain.name

string

required

The domain name.

Example:

"example.com"

domain.createdAt

number

required

Timestamp in milliseconds when the domain was created in the registry.

Example:

1613602938882

domain.expiresAt

number | null

required

Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel.

Example:

1613602938882

domain.id

string

required

The unique identifier of the domain.

Example:

"EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1"

domain.serviceType

enum<string>

required

The type of service the domain is handled by. external if the DNS is externally handled, zeit.world if handled with Vercel, or na if the service is not available.

Available options:

zeit.world,

external,

na

Example:

"zeit.world"

domain.userId

string

required

domain.customNameservers

string[]

A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel.

Example:

["ns1.nameserver.net", "ns2.nameserver.net"]

domain.orderedAt

number

Timestamp in milliseconds at which the domain was ordered.

Example:

1613602938882

domain.renew

boolean

Indicates whether the domain is set to automatically renew.

Example:

true

domain.transferredAt

number | null

Timestamp in milliseconds at which the domain was successfully transferred into Vercel. null if the transfer is still processing or was never transferred in.

Example:

1613602938882

domain.transferStartedAt

number

If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated.

Example:

1613602938882

Get a Domain's configuration List all the domains

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",
  });

  // Handle the result
  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>"
  }
}

Endpoints

Authorizations

Path Parameters

Query Parameters

Response