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
​
name
string
required

The project domain name

Example:

"www.example.com"

​
gitBranch
string | null

Git branch to link the project domain

Maximum length: 250
Example:

null

​
customEnvironmentId
string

The unique custom environment identifier within the project

​
redirect
string | null

Target destination domain for redirect

Example:

"foobar.com"

​
redirectStatusCode
enum<integer> | null

Status code for domain redirect

Available options:
301,
302,
307,
308
Example:

307

Response

200
application/json
The domain was successfully added to the project
​
name
string
required
​
apexName
string
required
​
projectId
string
required
​
verified
boolean
required

true if the domain is verified for use with the project. If false it will not be used as an alias on this project until the challenge in verification is completed.

​
redirect
string | null
​
redirectStatusCode
enum<number> | null
Available options:
307,
301,
302,
308
​
gitBranch
string | null
​
customEnvironmentId
string | null
​
updatedAt
number
​
createdAt
number
​
verification
object[]

A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete POST /projects/:idOrName/domains/:domain/verify to verify the domain. Possible challenges: - If verification.type = TXT the verification.domain will be checked for a TXT record matching verification.value.

A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete POST /projects/:idOrName/domains/:domain/verify to verify the domain. Possible challenges: - If verification.type = TXT the verification.domain will be checked for a TXT record matching verification.value.