Skip to content

Domains API

Learn to leverage Vercel's Domains API to add and remove domains programmatically from your Platforms on Vercel project.

Framework Next.js
Use Case Documentation
CSS Tailwind
Publisher ▲ Vercel

Domains API

This code snippet shows you how you can leverage Vercel's Domains API to add and remove domains programmatically from your Platforms on Vercel project.

Dependencies

  • Tailwind CSS (npm install tailwindcss)
  • SWR (npm install swr)
  • React Hot Toast (npm install react-hot-toast) (optional)
  • JS Cookie (npm install js-cookie) (optional)

Demo

https://domains-api.vercel.app/

Features

0. Configure Env Vars

You'll need to configure 3 different environment variables for this project to work:

  • PROJECT_ID_VERCEL: The ID of the Vercel project you want to add/remove domains from. You can find it under the "Settings" tab in your project's dashboard.
  • TEAM_ID_VERCEL: The ID of the Vercel team you want to add/remove domains from. You can find it under the "Settings" tab in your team's dashboard.
  • AUTH_BEARER_TOKEN: Your personal auth bearer token that gives you programmatic access to your Vercel account. You can create one under the "Tokens" tab in your personal account's settings tab.

1. Adding Domains

To add a domain, you can use the /v8/projects/{idOrName}/domains endpoint as shown here (full documentation).

When a domain is added, there are 3 possible outcomes:

  1. Domain is added successfully (response code 200).
  2. Domains is already in use by another project and can't be added (response code 409).
  3. Domains belongs to a different team but you can potentially request delegation for the domain (response code 403).
Verifying Project Domain

Verifying a project domain can be done with the /v9/projeccts/{projectId}/domains/{domain}/verify endpoint as shown here (full documentation).

2. Auto-checking Domain Configuration

When a domain is first added to a project, we use SWR to periodically check if the domain's DNS records are configured correctly. This is done using the /v6/domains/{domain}/config endpoint as shown here.

There are two ways that your users can configure their domains after they are added:

  • CNAME record:
    • recommended for subdomains (blog.domain.com, app.domain.com)
    • you can set up a branded CNAME value by adding an A record for the cname subdomain on your domain and point it to to Vercel's IP address 76.76.21.21
  • A record:
    • recommended for apex domains (domain.com)

Example:

3. Removing Domains

To remove a domain, you can use the /v8/projects/{idOrName}/domains endpoint as shown here (full documentation).

How to Use

You can choose from one of the following two methods to use this repository:

One-Click Deploy

Deploy the example using Vercel:

Clone and Deploy

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example https://github.com/vercel/examples/tree/main/solutions/domains-api domains-api
# or
yarn create next-app --example https://github.com/vercel/examples/tree/main/solutions/domains-api domains-api

Next, run Next.js in development mode:

npm install
npm run dev

# or

yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

Domains API

Learn to leverage Vercel's Domains API to add and remove domains programmatically from your Platforms on Vercel project.

Framework Next.js
Use Case Documentation
CSS Tailwind
Publisher ▲ Vercel

Domains API

This code snippet shows you how you can leverage Vercel's Domains API to add and remove domains programmatically from your Platforms on Vercel project.

Dependencies

  • Tailwind CSS (npm install tailwindcss)
  • SWR (npm install swr)
  • React Hot Toast (npm install react-hot-toast) (optional)
  • JS Cookie (npm install js-cookie) (optional)

Demo

https://domains-api.vercel.app/

Features

0. Configure Env Vars

You'll need to configure 3 different environment variables for this project to work:

  • PROJECT_ID_VERCEL: The ID of the Vercel project you want to add/remove domains from. You can find it under the "Settings" tab in your project's dashboard.
  • TEAM_ID_VERCEL: The ID of the Vercel team you want to add/remove domains from. You can find it under the "Settings" tab in your team's dashboard.
  • AUTH_BEARER_TOKEN: Your personal auth bearer token that gives you programmatic access to your Vercel account. You can create one under the "Tokens" tab in your personal account's settings tab.

1. Adding Domains

To add a domain, you can use the /v8/projects/{idOrName}/domains endpoint as shown here (full documentation).

When a domain is added, there are 3 possible outcomes:

  1. Domain is added successfully (response code 200).
  2. Domains is already in use by another project and can't be added (response code 409).
  3. Domains belongs to a different team but you can potentially request delegation for the domain (response code 403).
Verifying Project Domain

Verifying a project domain can be done with the /v9/projeccts/{projectId}/domains/{domain}/verify endpoint as shown here (full documentation).

2. Auto-checking Domain Configuration

When a domain is first added to a project, we use SWR to periodically check if the domain's DNS records are configured correctly. This is done using the /v6/domains/{domain}/config endpoint as shown here.

There are two ways that your users can configure their domains after they are added:

  • CNAME record:
    • recommended for subdomains (blog.domain.com, app.domain.com)
    • you can set up a branded CNAME value by adding an A record for the cname subdomain on your domain and point it to to Vercel's IP address 76.76.21.21
  • A record:
    • recommended for apex domains (domain.com)

Example:

3. Removing Domains

To remove a domain, you can use the /v8/projects/{idOrName}/domains endpoint as shown here (full documentation).

How to Use

You can choose from one of the following two methods to use this repository:

One-Click Deploy

Deploy the example using Vercel:

Clone and Deploy

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example https://github.com/vercel/examples/tree/main/solutions/domains-api domains-api
# or
yarn create next-app --example https://github.com/vercel/examples/tree/main/solutions/domains-api domains-api

Next, run Next.js in development mode:

npm install
npm run dev

# or

yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

Unleash New Possibilities

Deploy your app on Vercel and unlock its full potential