domain_project_domains

Creates, updates, deletes, gets or lists a domain_project_domains resource.

Overview

Name	domain_project_domains
Type	Resource
Id	vercel.domains.domain_project_domains

Fields

The following fields are returned by SELECT queries:

list

Successful response retrieving project domains for an apex domain.

Name	Datatype	Description
name	string
custom_environment_id	string	(wire: customEnvironmentId)
project_id	string	(wire: projectId)
apex_name	string	(wire: apexName)
created_at	number	(wire: createdAt)
git_branch	string	(wire: gitBranch)
redirect	string
redirect_status_code	number	(301, 302, 307, 308, ) (wire: redirectStatusCode)
updated_at	number	(wire: updatedAt)
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. (false, true)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	domain	limit, since, until, team_id, slug	List all project domains associated with an apex domain owned by the authenticated account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	The apex domain name.
limit	number	Maximum number of project domains to list from a request.
since	number	Get project domains created after this JavaScript timestamp.
slug	string	The Team slug to perform the request on behalf of.
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)
until	number	Get project domains created before this JavaScript timestamp.

SELECT examples

list

List all project domains associated with an apex domain owned by the authenticated account.

SELECT
name,
custom_environment_id,
project_id,
apex_name,
created_at,
git_branch,
redirect,
redirect_status_code,
updated_at,
verification,
verified
FROM vercel.domains.domain_project_domains
WHERE domain = '{{ domain }}' -- required
AND limit = '{{ limit }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;