edge-config

Reference

Edge Config

Create an Edge Config

post/v1/edge-config

Creates an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "slug": "SOME_STRING_VALUE",
4    "items": "SOME_OBJECT_VALUE"
5  },
6  "headers": {
7    "Authorization": "Bearer <TOKEN>"
8  },
9  "method": "post"
10})

Parameters

Query Params

Body Params

Query Parameter	Description
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

An Edge Config

createdAtnumber

digeststring

idstring

itemCountnumberRequired

ownerIdstring

purposeobject

Properties
schemaobject

sizeInBytesnumberRequired

slugstring
Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).

transferobject
Keeps track of the current state of the Edge Config while it gets transferred.

Properties
updatedAtnumber

Response Codes

Code	Description
`201`
`400`	One of the provided values in the request body is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "slug": "SOME_STRING_VALUE",
4    "items": "SOME_OBJECT_VALUE"
5  },
6  "headers": {
7    "Authorization": "Bearer <TOKEN>"
8  },
9  "method": "post"
10})

Create an Edge Config token

post/v1/edge-config/{edgeConfigId}/token

Adds a token to an existing Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/token?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "label": "SOME_STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "post"
9})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
edgeConfigId	string required

Response

idstringRequired

tokenstringRequired

Response Codes

Code	Description
`201`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/token?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "label": "SOME_STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "post"
9})

Delete an Edge Config

delete/v1/edge-config/{edgeConfigId}

Delete an Edge Config by id.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

N/A

Response Codes

Code	Description
`204`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Delete an Edge Config's schema

delete/v1/edge-config/{edgeConfigId}/schema

Deletes the schema of existing Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

N/A

Response Codes

Code	Description
`204`
`400`	One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Delete one or more Edge Config tokens

delete/v1/edge-config/{edgeConfigId}/tokens

Deletes one or more tokens of an existing Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/tokens?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "tokens": "SOME_ARRAY OF STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "delete"
9})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
edgeConfigId	string required

Response

N/A

Response Codes

Code	Description
`204`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/tokens?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "tokens": "SOME_ARRAY OF STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "delete"
9})

Get an Edge Config

get/v1/edge-config/{edgeConfigId}

Returns an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

The EdgeConfig.

createdAtnumber

digeststring

idstring

itemCountnumberRequired

ownerIdstring

purposeobject

Properties
schemaobject

sizeInBytesnumberRequired

slugstring
Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).

transferobject
Keeps track of the current state of the Edge Config while it gets transferred.

Properties
updatedAtnumber

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Config backup

get/v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}

Retrieves a specific version of an Edge Config from backup storage.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/backups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigBackupVersionId	string required
edgeConfigId	string required

Response

One of the following objects
One of

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/backups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Config backups

get/v1/edge-config/{edgeConfigId}/backups

Returns backups of an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/backups?limit=SOME_NUMBER_VALUE&metadata=SOME_STRING_VALUE&next=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

backupsarrayRequired
Properties
paginationobjectRequired

Properties

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/backups?limit=SOME_NUMBER_VALUE&metadata=SOME_STRING_VALUE&next=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get an Edge Config item

get/v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}

Returns a specific Edge Config Item.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/item/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required
edgeConfigItemKey	string required

Response

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/item/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Config items

get/v1/edge-config/{edgeConfigId}/items

Returns all items of an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/items?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/items?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Config schema

get/v1/edge-config/{edgeConfigId}/schema

Returns the schema of an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

The EdgeConfig.

object or null
The EdgeConfig.

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Config token meta data

get/v1/edge-config/{edgeConfigId}/token/{token}

Return meta data about an Edge Config token.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/token/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required
token	string required

Response

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/token/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get all tokens of an Edge Config

get/v1/edge-config/{edgeConfigId}/tokens

Returns all tokens of an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/tokens?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
edgeConfigId	string required

Response

Response Codes

Code	Description
`200`	The EdgeConfig.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/tokens?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get Edge Configs

get/v1/edge-config

Returns all Edge Configs.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

List of all edge configs.

createdAtnumber

digeststring

idstring

itemCountnumberRequired

ownerIdstring

purposeobject

Properties
schemaobject

sizeInBytesnumberRequired

slugstring
Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).

transferobject
Keeps track of the current state of the Edge Config while it gets transferred.

Properties
updatedAtnumber

Response Codes

Code	Description
`200`	List of all edge configs.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Update Edge Config items in batch

patch/v1/edge-config/{edgeConfigId}/items

Update multiple Edge Config Items in batch.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/items?edgeConfigId=SOME_STRING_VALUE&dryRun=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "definition": "ANY_TYPE_VALUE",
4    "items": [
5      {
6        "operation": "create",
7        "key": "SOME_STRING_VALUE",
8        "value": "SOME_STRING|NUMBER|BOOLEAN|NULL|OBJECT_VALUE",
9        "description": ""
10      }
11    ]
12  },
13  "headers": {
14    "Authorization": "Bearer <TOKEN>"
15  },
16  "method": "patch"
17})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
edgeConfigId	string required

Response

statusstringRequired

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`
`409`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/items?edgeConfigId=SOME_STRING_VALUE&dryRun=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "definition": "ANY_TYPE_VALUE",
4    "items": [
5      {
6        "operation": "create",
7        "key": "SOME_STRING_VALUE",
8        "value": "SOME_STRING|NUMBER|BOOLEAN|NULL|OBJECT_VALUE",
9        "description": ""
10      }
11    ]
12  },
13  "headers": {
14    "Authorization": "Bearer <TOKEN>"
15  },
16  "method": "patch"
17})

Update Edge Config schema

post/v1/edge-config/{edgeConfigId}/schema

Update an Edge Config's schema.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?dryRun=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "definition": "ANY_TYPE_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "post"
9})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
edgeConfigId	string required

Response

The JSON schema uploaded by the user

object or null
The JSON schema uploaded by the user

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE/schema?dryRun=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "definition": "ANY_TYPE_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "post"
9})

Update an Edge Config

put/v1/edge-config/{edgeConfigId}

Updates an Edge Config.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "slug": "SOME_STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "put"
9})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
edgeConfigId	string required

Response

An Edge Config

createdAtnumber

digeststring

idstring

itemCountnumberRequired

ownerIdstring

purposeobject

Properties
schemaobject

sizeInBytesnumberRequired

slugstring
Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores).

transferobject
Keeps track of the current state of the Edge Config while it gets transferred.

Properties
updatedAtnumber

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`402`	The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/edge-config/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "slug": "SOME_STRING_VALUE"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "put"
9})

Last updated on November 21, 2024

Update or move apex domain

Create an Edge Config

Was this helpful?