projects

Update a project domain

Changed on

Update a project domain's configuration, including the name, git branch and redirect of the domain.

patch/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.

Request body

gitBranchstring nullable

Git branch to link the project domain

redirectstring nullable

Target destination domain for redirect

redirectStatusCodenull | 301 | 302 | 307 | 308 nullable

Status code for domain redirect

Example request

{
  "redirect": "foobar.com",
  "redirectStatusCode": 307
}

Response

The domain was updated successfuly

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