Skip to main content
POST
/
v7
/
domains
createOrTransferDomain
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.domains.createOrTransferDomain({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "example.com",
      method: "add",
      token: "fdhfr820ad#@FAdlj$$",
    },
  });

  console.log(result);
}

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

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

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"

Body

application/json
  • Option 1
  • Option 2
  • Option 3

add

​
name
string
required

The domain name you want to add.

Example:

"example.com"

​
cdnEnabled
boolean

Whether the domain has the Vercel Edge Network enabled or not.

Example:

true

​
zone
boolean
​
method
string

The domain operation to perform. The domain operation to perform. It can be either add or move-in.

Example:

"add"

Response

​
domain
object
required