AddProjectDomainResponseBody

June 11, 2025 ยท View on GitHub

The domain was successfully added to the project

Example Usage

import { AddProjectDomainResponseBody } from "@vercel/sdk/models/addprojectdomainop.js";

let value: AddProjectDomainResponseBody = {
  name: "<value>",
  apexName: "<value>",
  projectId: "<id>",
  verified: true,
};

Fields

FieldTypeRequiredDescription
namestring:heavy_check_mark:N/A
apexNamestring:heavy_check_mark:N/A
projectIdstring:heavy_check_mark:N/A
redirectstring:heavy_minus_sign:N/A
redirectStatusCodenumber:heavy_minus_sign:N/A
gitBranchstring:heavy_minus_sign:N/A
customEnvironmentIdstring:heavy_minus_sign:N/A
updatedAtnumber:heavy_minus_sign:N/A
createdAtnumber:heavy_minus_sign:N/A
verifiedboolean:heavy_check_mark: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.
verificationmodels.AddProjectDomainVerification[]:heavy_minus_sign: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.