domains

Add an existing domain to the Vercel platform

Changed on

This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Note: This endpoint is no longer used for initiating domain transfers from external registrars to Vercel. For this, please use the endpoint Transfer-in a domain.

post/v7/domains

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v7/domains
  • Auth: HTTP bearer

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

OR

Example request

{
  "method": "add",
  "name": "example.com",
  "cdnEnabled": true
}

Response

Example response

{
  "domain": {
    "boughtAt": 1613602938882,
    "createdAt": 1613602938882,
    "creator": {
      "id": "ZspSRT4ljIEEmMHgoDwKWDei",
      "username": "vercel_user",
      "email": "demo@example.com"
    },
    "customNameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "echMode": "auto",
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "intendedNameservers": [
      "ns1.vercel-dns.com",
      "ns2.vercel-dns.com"
    ],
    "name": "example.com",
    "nameservers": [
      "ns1.nameserver.net",
      "ns2.nameserver.net"
    ],
    "renew": true,
    "serviceType": "zeit.world",
    "transferredAt": 1613602938882,
    "transferStartedAt": 1613602938882,
    "verified": true
  }
}

Changes