domains

Overview

Name	domains
Type	Resource
Id	vercel.projects.domains

Fields

Name	Datatype	Description
name	string
apexName	string
createdAt	number
gitBranch	string
projectId	string
redirect	string
redirectStatusCode	number
updatedAt	number
verification	array	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.
verified	boolean	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.

Methods

Name	Accessible by	Required Params	Description
get_project_domain	SELECT	domain, idOrName, teamId	Get project domain by project id/name and domain name.
get_project_domains	SELECT	idOrName, teamId	Retrieve the domains associated with a given project by passing either the project id or name in the URL.
remove_project_domain	DELETE	domain, idOrName, teamId	Remove a domain from a project by passing the domain name and by specifying the project by either passing the project id or name in the URL.
_get_project_domains	EXEC	idOrName, teamId	Retrieve the domains associated with a given project by passing either the project id or name in the URL.
add_project_domain	EXEC	idOrName, teamId, data__name	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.
update_project_domain	EXEC	domain, idOrName, teamId	Update a project domain's configuration, including the name, git branch and redirect of the domain.
verify_project_domain	EXEC	domain, idOrName, teamId	Attempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge.