Skip to main content
Server path: /vercel-edge-config | Type: Application | PCID required: Yes

Tools

ToolDescription
vercel_edge_config_create_edge_configCreate an Edge Config
vercel_edge_config_create_edge_config_tokenCreate an Edge Config token
vercel_edge_config_dangerously_delete_by_src_imagesDangerously delete by source image
vercel_edge_config_dangerously_delete_by_tagsDangerously delete by tag
vercel_edge_config_delete_edge_configDelete an Edge Config
vercel_edge_config_delete_redirectsDelete project-level redirects.
vercel_edge_config_delete_schemaDelete an Edge Config’s schema
vercel_edge_config_delete_tokensDelete one or more Edge Config tokens
vercel_edge_config_edit_redirectEdit a project-level redirect.
vercel_edge_config_get_backupGet Edge Config backup
vercel_edge_config_get_backupsGet Edge Config backups
vercel_edge_config_get_configsGet Edge Configs
vercel_edge_config_get_edge_configGet an Edge Config
vercel_edge_config_get_itemGet an Edge Config item
vercel_edge_config_get_itemsGet Edge Config items
vercel_edge_config_get_redirectsGets project-level redirects.
vercel_edge_config_get_schemaGet Edge Config schema
vercel_edge_config_get_tokenGet Edge Config token meta data
vercel_edge_config_get_tokensGet all tokens of an Edge Config
vercel_edge_config_get_versionsGet the version history for a project’s redirects.
vercel_edge_config_invalidate_by_src_imagesInvalidate by source image
vercel_edge_config_invalidate_by_tagsInvalidate by tag
vercel_edge_config_patch_itemsUpdate Edge Config items in batch
vercel_edge_config_patch_schemaUpdate Edge Config schema
vercel_edge_config_restore_redirectsRestore staged project-level redirects to their production version.
vercel_edge_config_stage_redirectsStages new redirects for a project.
vercel_edge_config_update_edge_configUpdate an Edge Config
vercel_edge_config_update_versionPromote a staging version to production or restore a previous production version.

vercel_edge_config_create_edge_config

Create an Edge Config Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringYesThe Team slug to perform the request on behalf of.
itemsobjectNoThe items value

vercel_edge_config_create_edge_config_token

Create an Edge Config token Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
labelstringYesThe label value

vercel_edge_config_dangerously_delete_by_src_images

Dangerously delete by source image Parameters:
ParameterTypeRequiredDefaultDescription
projectIdOrNamestringYesProject Id Or Name
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
revalidationDeadlineSecondsnumberNoRevalidation Deadline Seconds
srcImagesany[]YesSrc Images

vercel_edge_config_dangerously_delete_by_tags

Dangerously delete by tag Parameters:
ParameterTypeRequiredDefaultDescription
projectIdOrNamestringYesProject Id Or Name
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
revalidationDeadlineSecondsnumberNoRevalidation Deadline Seconds
tagsany[]YesThe tags value
targetstringNoThe target value

vercel_edge_config_delete_edge_config

Delete an Edge Config Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_delete_redirects

Delete project-level redirects. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
namestringNoThe name value
redirectsany[]YesThe redirects to delete. The source of the redirect is used to match the redirect to delete.

vercel_edge_config_delete_schema

Delete an Edge Config’s schema Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_delete_tokens

Delete one or more Edge Config tokens Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
tokensany[]YesThe tokens value

vercel_edge_config_edit_redirect

Edit a project-level redirect. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
namestringNoThe name value
redirectobjectYesThe redirect object to edit. The source field is used to match the redirect to modify.
restorebooleanNoIf true, restores the redirect from the latest production version to staging.

vercel_edge_config_get_backup

Get Edge Config backup Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
edgeConfigBackupVersionIdstringYesEdge Config Backup Version Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_backups

Get Edge Config backups Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
nextstringNoThe next value
limitnumberNoMaximum number of results to return
metadatastringNoThe metadata value
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_configs

Get Edge Configs Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_edge_config

Get an Edge Config Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_item

Get an Edge Config item Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
edgeConfigItemKeystringYesEdge Config Item Key
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_items

Get Edge Config items Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_redirects

Gets project-level redirects. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
versionIdstringNoVersion Id
qstringNoThe q value
diffobjectNoThe diff value
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page
sort_bystringNoSort By
sort_orderstringNoSort Order
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_schema

Get Edge Config schema Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_token

Get Edge Config token meta data Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
tokenstringYesThe token value
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_tokens

Get all tokens of an Edge Config Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_get_versions

Get the version history for a project’s redirects. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_edge_config_invalidate_by_src_images

Invalidate by source image Parameters:
ParameterTypeRequiredDefaultDescription
projectIdOrNamestringYesProject Id Or Name
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
srcImagesany[]YesSrc Images

vercel_edge_config_invalidate_by_tags

Invalidate by tag Parameters:
ParameterTypeRequiredDefaultDescription
projectIdOrNamestringYesProject Id Or Name
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
tagsany[]YesThe tags value
targetstringNoThe target value

vercel_edge_config_patch_items

Update Edge Config items in batch Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
itemsany[]YesThe items value

vercel_edge_config_patch_schema

Update Edge Config schema Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
dryRunstringNoDry Run
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
definitionobjectYesThe definition value

vercel_edge_config_restore_redirects

Restore staged project-level redirects to their production version. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
namestringNoThe name value
redirectsany[]YesThe redirects to restore. The source of the redirect is used to match the redirect to restore.

vercel_edge_config_stage_redirects

Stages new redirects for a project. Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
namestringNoThe name value
overwritebooleanNoThe overwrite value
projectIdstringYesProject Id
redirectsany[]NoThe redirects value

vercel_edge_config_update_edge_config

Update an Edge Config Parameters:
ParameterTypeRequiredDefaultDescription
edgeConfigIdstringYesEdge Config Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringYesThe Team slug to perform the request on behalf of.

vercel_edge_config_update_version

Promote a staging version to production or restore a previous production version. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
actionstringYesThe action value
idstringYesThe id value
namestringNoThe name value