configuration

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

Overview

Name	configuration
Type	Resource
Id	vercel.integrations.configuration

Fields

The following fields are returned by SELECT queries:

get_configuration

Name	Datatype	Description

get_configurations

The list of configurations for the authenticated user

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration	select	id, teamId		Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.
get_configurations	select	view, teamId		Allows to retrieve all configurations for an authenticated integration. When the project view is used, configurations generated for the authorization flow will be filtered out of the results.
delete_configuration	delete	id, teamId		Allows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.

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	string	ID of the configuration to delete
teamId	string	The Team identifier or slug to perform the request on behalf of.
view	string

SELECT examples

get_configuration

Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.

SELECT
*
FROM vercel.integrations.configuration
WHERE id = '{{ id }}' -- required
AND teamId = '{{ teamId }}' -- required
;

get_configurations

Allows to retrieve all configurations for an authenticated integration. When the project view is used, configurations generated for the authorization flow will be filtered out of the results.

SELECT
*
FROM vercel.integrations.configuration
WHERE view = '{{ view }}' -- required
AND teamId = '{{ teamId }}' -- required
;

DELETE examples

delete_configuration

Allows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.

DELETE FROM vercel.integrations.configuration
WHERE id = '{{ id }}' --required
AND teamId = '{{ teamId }}' --required
;