POST
/
v10
/
projects
/
{idOrName}
/
domains
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.addProjectDomain({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "www.example.com",
      gitBranch: null,
      redirect: "foobar.com",
      redirectStatusCode: 307,
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
  "name": "<string>",
  "apexName": "<string>",
  "projectId": "<string>",
  "redirect": "<string>",
  "redirectStatusCode": 307,
  "gitBranch": "<string>",
  "customEnvironmentId": "<string>",
  "updatedAt": 123,
  "createdAt": 123,
  "verified": true,
  "verification": [
    {
      "type": "<string>",
      "domain": "<string>",
      "value": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The unique project identifier or the project name

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

Response

200
application/json
The domain was successfully added to the project

The response is of type object.