edge_configs

Creates, updates, deletes, gets or lists an edge_configs resource.

Overview

Name	edge_configs
Type	Resource
Id	vercel.edge_config.edge_configs

Fields

The following fields are returned by SELECT queries:

get

The Global Config.

Name	Datatype	Description
id	string
owner_id	string	(wire: ownerId)
created_at	number	(wire: createdAt)
created_by	string	The ID of the user who created the Global Config, optional because it is not always set. (wire: createdBy)
deleted_at	number	(wire: deletedAt)
digest	string
item_count	number	(wire: itemCount)
purpose	object
schema	string	(opaque JSON object)
size_in_bytes	number	(wire: sizeInBytes)
slug	string	Name for the Global Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).
synced_to_dynamo_at	number	Timestamp of when the Global Config was synced to DynamoDB initially. It is only set when syncing the entire Global Config, not when updating. (wire: syncedToDynamoAt)
transfer	object	Keeps track of the current state of the Global Config while it gets transferred.
updated_at	number	(wire: updatedAt)

list

List of all global configs.

Name	Datatype	Description
id	string
owner_id	string	(wire: ownerId)
created_at	number	(wire: createdAt)
created_by	string	The ID of the user who created the Global Config, optional because it is not always set. (wire: createdBy)
deleted_at	number	(wire: deletedAt)
digest	string
item_count	number	(wire: itemCount)
purpose
schema	string	(opaque JSON object)
size_in_bytes	number	(wire: sizeInBytes)
slug	string	Name for the Global Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).
synced_to_dynamo_at	number	Timestamp of when the Global Config was synced to DynamoDB initially. It is only set when syncing the entire Global Config, not when updating. (wire: syncedToDynamoAt)
transfer	object	Keeps track of the current state of the Global Config while it gets transferred.
updated_at	number	(wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	edge_config_id	team_id, slug	Returns a Global Config.
list	select		team_id, slug	Returns all Global Configs.
create	insert	slug	team_id	Creates a Global Config.
update	update	edge_config_id, slug	team_id	Updates a Global Config.
delete	delete	edge_config_id	team_id, slug	Delete a Global Config by id.

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
edge_config_id	string
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

Returns a Global Config.

SELECT
id,
owner_id,
created_at,
created_by,
deleted_at,
digest,
item_count,
purpose,
schema,
size_in_bytes,
slug,
synced_to_dynamo_at,
transfer,
updated_at
FROM vercel.edge_config.edge_configs
WHERE edge_config_id = '{{ edge_config_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

list

Returns all Global Configs.

SELECT
id,
owner_id,
created_at,
created_by,
deleted_at,
digest,
item_count,
purpose,
schema,
size_in_bytes,
slug,
synced_to_dynamo_at,
transfer,
updated_at
FROM vercel.edge_config.edge_configs
WHERE team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples

create

Creates a Global Config.

INSERT INTO vercel.edge_config.edge_configs (
slug,
items,
team_id
)
SELECT 
'{{ slug }}' /* required */,
'{{ items }}',
'{{ team_id }}'
RETURNING
id,
owner_id,
created_at,
created_by,
deleted_at,
digest,
item_count,
purpose,
schema,
size_in_bytes,
slug,
synced_to_dynamo_at,
transfer,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: edge_configs
props:
  - name: slug
    value: "{{ slug }}"
  - name: items
    value: "{{ items }}"
  - 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.

UPDATE examples

update

Updates a Global Config.

UPDATE vercel.edge_config.edge_configs
SET 
slug = '{{ slug }}'
WHERE 
edge_config_id = '{{ edge_config_id }}' --required
AND slug = '{{ slug }}' --required
AND team_id = '{{ team_id}}'
RETURNING
id,
owner_id,
created_at,
created_by,
deleted_at,
digest,
item_count,
purpose,
schema,
size_in_bytes,
slug,
synced_to_dynamo_at,
transfer,
updated_at;

DELETE examples

delete

Delete a Global Config by id.

DELETE FROM vercel.edge_config.edge_configs
WHERE edge_config_id = '{{ edge_config_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;