sdk_keys

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

Overview

Name	sdk_keys
Type	Resource
Id	vercel.feature_flags.sdk_keys

Fields

The following fields are returned by SELECT queries:

list

Shared metadata for a Flags SDK key, safe to return on both LIST and CREATE. Never contains cleartext secrets.

Name	Datatype	Description
project_id	string	(wire: projectId)
created_at	number	(wire: createdAt)
created_by	string	(wire: createdBy)
deleted_at	number	(wire: deletedAt)
environment	string
hash_key	string	(wire: hashKey)
label	string
partial_key_value	string	Partially-masked representation of the SDK key value, safe to display in UIs. The value is the vf_<type>_ prefix followed by the first 3 characters of the secret portion and a fixed 8-character * mask (e.g. vf_server_abc********). (wire: partialKeyValue)
type	string	(client, mobile, server)
updated_at	number	(wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id_or_name	team_id, slug	Gets all SDK keys for a project.
create	insert	project_id_or_name, sdk_key_type, environment	team_id, slug	Creates an SDK key.
delete	delete	project_id_or_name, hash_key	team_id, slug	Deletes an SDK key.

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
hash_key	string	The SDK key hash key to delete
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

list

Gets all SDK keys for a project.

SELECT
project_id,
created_at,
created_by,
deleted_at,
environment,
hash_key,
label,
partial_key_value,
type,
updated_at
FROM vercel.feature_flags.sdk_keys
WHERE project_id_or_name = '{{ project_id_or_name }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples

create

Creates an SDK key.

INSERT INTO vercel.feature_flags.sdk_keys (
sdk_key_type,
environment,
label,
project_id_or_name,
team_id,
slug
)
SELECT 
'{{ sdk_key_type }}' /* required */,
'{{ environment }}' /* required */,
'{{ label }}',
'{{ project_id_or_name }}',
'{{ team_id }}',
'{{ slug }}'
RETURNING
project_id,
created_at,
created_by,
deleted_at,
environment,
hash_key,
key_value,
label,
partial_key_value,
token_value,
type,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: sdk_keys
props:
  - name: project_id_or_name
    value: "{{ project_id_or_name }}"
    description: Required parameter for the sdk_keys resource.
  - name: sdk_key_type
    value: "{{ sdk_key_type }}"
    valid_values: ['server', 'mobile', 'client']
  - name: environment
    value: "{{ environment }}"
  - name: label
    value: "{{ label }}"
  - name: team_id
    value: "{{ team_id }}"
    description: The Team identifier to perform the request on behalf of.
    description: The Team identifier to perform the request on behalf of.
  - name: slug
    value: "{{ slug }}"
    description: The Team slug to perform the request on behalf of.
    description: The Team slug to perform the request on behalf of.

DELETE examples

delete

Deletes an SDK key.

DELETE FROM vercel.feature_flags.sdk_keys
WHERE project_id_or_name = '{{ project_id_or_name }}' --required
AND hash_key = '{{ hash_key }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;