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})
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. |
An Edge Config
createdAtnumber digeststring idstring itemCountnumberRequired ownerIdstring purposeobject 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. updatedAtnumber
Code | Description |
---|---|
201 | |
400 | One of the provided values in the request body is invalid. |
401 | |
402 |
|
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
idstringRequired tokenstringRequired
Code | Description |
---|---|
201 | |
400 |
|
401 | |
402 |
|
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 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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
Code | Description |
---|---|
204 | |
400 | One of the provided values in the request query is invalid. |
401 | |
402 |
|
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
Code | Description |
---|---|
204 | |
400 |
|
401 | |
402 |
|
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
The EdgeConfig.
createdAtnumber digeststring idstring itemCountnumberRequired ownerIdstring purposeobject 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. updatedAtnumber
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})
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})
Path Parameter | Description |
---|---|
edgeConfigBackupVersionId | string required |
edgeConfigId | string required |
One of the following objects
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
backupsarrayRequired paginationobjectRequired
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
edgeConfigItemKey | string required |
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
The EdgeConfig.
object or null The EdgeConfig.
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
token | string required |
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
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})
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})
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. |
List of all edge configs.
createdAtnumber digeststring idstring itemCountnumberRequired ownerIdstring purposeobject 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. updatedAtnumber
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 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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
statusstringRequired
Code | Description |
---|---|
200 | |
400 |
|
401 | |
402 |
|
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 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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
The JSON schema uploaded by the user
object or null The JSON schema uploaded by the user
Code | Description |
---|---|
200 | |
400 |
|
401 | |
402 |
|
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})
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})
Path Parameter | Description |
---|---|
edgeConfigId | string required |
An Edge Config
createdAtnumber digeststring idstring itemCountnumberRequired ownerIdstring purposeobject 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. updatedAtnumber
Code | Description |
---|---|
200 | |
400 |
|
401 | |
402 |
|
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})
Was this helpful?