promote_aliases

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

Overview

Name	promote_aliases
Type	Resource
Id	vercel.projects.promote_aliases

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string
alias	string
status	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	limit, since, until, failed_only, team_id, slug	Get a list of aliases related to the last promote request with their mapping status

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
project_id	string
failed_only	boolean	Filter results down to aliases that failed to map to the requested deployment (wire: failedOnly)
limit	number	Maximum number of aliases to list from a request (max 100).
since	number	Get aliases created after this epoch 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 aliases created before this epoch timestamp.

SELECT examples

list

Get a list of aliases related to the last promote request with their mapping status

SELECT
id,
alias,
status
FROM vercel.projects.promote_aliases
WHERE project_id = '{{ project_id }}' -- required
AND limit = '{{ limit }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND failed_only = '{{ failed_only }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;