projects

Verify project domain

Changed on

Attempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge.

post/v9/projects/{idOrName}/domains/{domain}/verify

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v9/projects/{idOrName}/domains/{domain}/verify
  • Auth: HTTP bearer

Path parameters

idOrNamestring required

The unique project identifier or the project name

Example:prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
domainstring required

The domain name you want to verify

Example:example.com

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.

Response

The project domain was verified successfully Domain is already verified

apexNamestring required
createdAtnumber
customEnvironmentIdstring nullable
gitBranchstring nullable
namestring required
projectIdstring required
redirectstring nullable
redirectStatusCode301 | 302 | 307 | 308 | null nullable
updatedAtnumber
verifiedfalse | true 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.

Changes