Add a domain to the project by passing its domain name and by specifying the project by either passing the project id or name in the URL. If the domain is not yet verified to be used on this project, the request will return verified = false, and the domain will need to be verified according to the verification challenge via POST /projects/:idOrName/domains/:domain/verify. If the domain already exists on the project, the request will fail with a 400 status code.
Default authentication mechanism
The unique project identifier or the project name
The Team identifier to perform the request on behalf of.
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
"my-team-url-slug"
The project domain name
"www.example.com"
Git branch to link the project domain
250null
The unique custom environment identifier within the project
Target destination domain for redirect
"foobar.com"
Status code for domain redirect
, 301, 302, 307, 308 307
The domain was successfully added to the project
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.
307, 301, 302, 308 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.