project_connectors

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

Overview

Name	project_connectors
Type	Resource
Id	vercel.connect.project_connectors

Fields

The following fields are returned by SELECT queries:

list

A page of connector connections for the project.

Name	Datatype	Description
connector_id	string	Stable scl_ connector ID, even when the request used a UID. (wire: connectorId)
created_at	number	Time when the project connection was created, in epoch milliseconds. (wire: createdAt)
enabled_environments	array	Environments where the connector is enabled for the project. (wire: enabledEnvironments)
project	object	Vercel project connected to the connector.
updated_at	number	Time when the project connection was last updated, in epoch milliseconds. (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	limit, cursor, team_id, slug	List the connectors connected to a project and the environments where each connection is available.

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	Vercel project ID.
cursor	string	Cursor from pagination.next on the previous response.
limit	integer	Maximum number of connector connections to return. Defaults to 50.
slug	string	The team slug that scopes the request. Do not send it with teamId. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected.
team_id	string	The team ID that scopes the request. Do not send it with slug. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected. (wire: teamId)

SELECT examples

list

List the connectors connected to a project and the environments where each connection is available.

SELECT
connector_id,
created_at,
enabled_environments,
project,
updated_at
FROM vercel.connect.project_connectors
WHERE project_id = '{{ project_id }}' -- required
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;