Authorizations
Default authentication mechanism
Path Parameters
The unique project identifier or the project name
Query Parameters
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"
Body
The project domain name
"www.example.com"
Git branch to link the project domain
250
null
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
Response
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
.