deployment_events

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

Overview

Name	deployment_events
Type	Resource
Id	vercel.deployments.deployment_events

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id_or_url	direction, follow, limit, name, since, until, status_code, delimiter, builds, team_id, slug	Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.

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
id_or_url	string	The unique identifier or hostname of the deployment.
builds	number
delimiter	number
direction	string	Order of the returned events based on the timestamp.
follow	number	When enabled, this endpoint will return live events as they happen.
limit	number	Maximum number of events to return. Provide -1 to return all available logs.
name	string	Deployment build ID.
since	number	Timestamp for when build logs should be pulled from.
slug	string	The Team slug to perform the request on behalf of.
status_code		HTTP status code range to filter events by. (wire: statusCode)
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)
until	number	Timestamp for when the build logs should be pulled up until.

SELECT examples

list

Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.

SELECT
*
FROM vercel.deployments.deployment_events
WHERE id_or_url = '{{ id_or_url }}' -- required
AND direction = '{{ direction }}'
AND follow = '{{ follow }}'
AND limit = '{{ limit }}'
AND name = '{{ name }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND status_code = '{{ status_code }}'
AND delimiter = '{{ delimiter }}'
AND builds = '{{ builds }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;