projects

Get a project domain

Changed on

Get project domain by project id/name and domain name.

get/v9/projects/{idOrName}/domains/{domain}

Request

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

Path parameters

idOrNamestring required

The unique project identifier or the project name

domainstring required

The project domain name

Example:www.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

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