settings

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

Overview

Name	settings
Type	Resource
Id	vercel.feature_flags.settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
owner_id	string	(wire: ownerId)
project_id	string	(wire: projectId)
type_name	string	(settings) (wire: typeName)
created_at	number	(wire: createdAt)
enabled	boolean	(false, true)
entities	array
environments	array
metadata	object
updated_at	number	(wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project_id_or_name	team_id, slug	Retrieve feature flag settings for a project.
update	update	project_id_or_name	team_id, slug	Update feature flag settings for a project.

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_or_name	string	The project id or name
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)

SELECT examples

get

Retrieve feature flag settings for a project.

SELECT
owner_id,
project_id,
type_name,
created_at,
enabled,
entities,
environments,
metadata,
updated_at
FROM vercel.feature_flags.settings
WHERE project_id_or_name = '{{ project_id_or_name }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

UPDATE examples

update

Update feature flag settings for a project.

UPDATE vercel.feature_flags.settings
SET 
enabled = {{ enabled }},
entities = '{{ entities }}',
environments = '{{ environments }}'
WHERE 
project_id_or_name = '{{ project_id_or_name }}' --required
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}'
RETURNING
owner_id,
project_id,
type_name,
created_at,
enabled,
entities,
environments,
metadata,
updated_at;