backups

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

Overview

Name	backups
Type	Resource
Id	vercel.edge_config.backups

Fields

The following fields are returned by SELECT queries:

get

The object the API responds with when requesting a Global Config backup

Name	Datatype	Description
id	string
backup	object
last_modified	number	(wire: lastModified)
metadata	object
user	object

list

Name	Datatype	Description
id	string
last_modified	number	(wire: lastModified)
metadata	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	edge_config_id, edge_config_backup_version_id	team_id, slug	Retrieves a specific version of a Global Config from backup storage.
list	select	edge_config_id	next, limit, metadata, team_id, slug	Returns backups of a Global Config.
restore	exec	edge_config_id, edge_config_backup_version_id	teamId, slug	Restores a Global Config backup.

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_backup_version_id	string
edge_config_id	string
limit	number
metadata	string
next	string
slug	string	The Team slug to perform the request on behalf of.
teamId	string	The Team identifier 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

Retrieves a specific version of a Global Config from backup storage.

SELECT
id,
backup,
last_modified,
metadata,
user
FROM vercel.edge_config.backups
WHERE edge_config_id = '{{ edge_config_id }}' -- required
AND edge_config_backup_version_id = '{{ edge_config_backup_version_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

list

Returns backups of a Global Config.

SELECT
id,
last_modified,
metadata
FROM vercel.edge_config.backups
WHERE edge_config_id = '{{ edge_config_id }}' -- required
AND next = '{{ next }}'
AND limit = '{{ limit }}'
AND metadata = '{{ metadata }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

restore

Restores a Global Config backup.

EXEC vercel.edge_config.backups.restore 
@edge_config_id='{{ edge_config_id }}' --required, 
@edge_config_backup_version_id='{{ edge_config_backup_version_id }}' --required, 
@teamId='{{ teamId }}', 
@slug='{{ slug }}'
;