Help
Log InSign Up
v0.0.1
OAS 3.0.3

Vercel REST API

The Vercel REST API is a REST-styled API that gives you full control over the entire Vercel platform. You can use it with any programming language or framework that can send HTTP requests. You need to authenticate with a Vercel access token for every request.

Production API

No authentication selected
Client Libraries
Fetch JavaScript

access-groups​

access-groups Endpoints

aliases​

aliases Endpoints

api-experimentation​

api-experimentation Endpoints

artifacts​

artifacts Endpoints

authentication​

authentication Endpoints

certs​

certs Endpoints

checks​

checks Endpoints

deployments​

deployments Endpoints

dns​

dns Endpoints

domains​

domains Endpoints

edge-config​

edge-config Endpoints

Create an Edge Config​

Creates an Edge Config.

Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
slug
string
max: 
64^[\\w-]+$
required
items
object
Responses
  • 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.

POST/v1/edge-config
fetch('https://api.vercel.com/v1/edge-config', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    slug: '',
    items: {
      ANY_ADDITIONAL_PROPERTY: 'anything'
    }
  })
})

{
  "createdAt": 1,
  "updatedAt": 1,
  "id": "…",
  "slug": "…",
  "ownerId": "…",
  "digest": "…",
  "transfer": {
    "fromAccountId": "…",
    "startedAt": 1,
    "doneAt": null
  },
  "schema": {},
  "purpose": {
    "type": "flags",
    "projectId": "…"
  },
  "sizeInBytes": 1,
  "itemCount": 1
}

Create an Edge Config token​

Adds a token to an existing Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
label
string
max: 
52
required
Responses
  • 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
POST/v1/edge-config/{edgeConfigId}/token
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/token', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    label: ''
  })
})

{
  "token": "…",
  "id": "…"
}

Delete an Edge Config​

Delete an Edge Config by id.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 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
DELETE/v1/edge-config/{edgeConfigId}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}', {
  method: 'DELETE'
})
No Body

Delete an Edge Config's schema​

Deletes the schema of existing Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 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
DELETE/v1/edge-config/{edgeConfigId}/schema
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/schema', {
  method: 'DELETE'
})
No Body

Delete one or more Edge Config tokens​

Deletes one or more tokens of an existing Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
tokens
array string[]
required
Responses
  • 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
DELETE/v1/edge-config/{edgeConfigId}/tokens
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/tokens', {
  method: 'DELETE',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    tokens: ['']
  })
})
No Body

Get all tokens of an Edge Config​

Returns all tokens of an Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/tokens
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/tokens')

{
  "token": "…",
  "label": "…",
  "id": "…",
  "edgeConfigId": "…",
  "createdAt": 1
}

The EdgeConfig.

Get an Edge Config​

Returns an Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}')

{
  "createdAt": 1,
  "updatedAt": 1,
  "id": "…",
  "slug": "…",
  "ownerId": "…",
  "digest": "…",
  "transfer": {
    "fromAccountId": "…",
    "startedAt": 1,
    "doneAt": null
  },
  "schema": {},
  "purpose": {
    "type": "flags",
    "projectId": "…"
  },
  "sizeInBytes": 1,
  "itemCount": 1
}

The EdgeConfig.

Get an Edge Config item​

Returns a specific Edge Config Item.

Path Parameters
  • edgeConfigId
    string ^ecfg_
    required
  • edgeConfigItemKey
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}')

{
  "key": "…",
  "value": "…",
  "description": "…",
  "edgeConfigId": "…",
  "createdAt": 1,
  "updatedAt": 1
}

The EdgeConfig.

Get Edge Config backup​

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

Path Parameters
  • edgeConfigId
    string
    required
  • edgeConfigBackupVersionId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}')

{
  "id": "…",
  "lastModified": 1,
  "backup": {
    "digest": "…",
    "items": {
      "ANY_ADDITIONAL_PROPERTY": {
        "updatedAt": 1,
        "value": "…",
        "description": "…",
        "createdAt": 1
      }
    },
    "slug": "…",
    "updatedAt": 1
  },
  "metadata": {
    "updatedAt": "…",
    "updatedBy": "…",
    "itemsCount": 1,
    "itemsBytes": 1
  },
  "user": {
    "id": "…",
    "username": "…",
    "email": "…",
    "name": "…",
    "avatar": "…"
  }
}

Get Edge Config backups​

Returns backups of an Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • next
    string
  • limit
    number
    min: 
    0
    max: 
    50
  • metadata
    string
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/backups
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/backups')

{
  "backups": [
    {
      "metadata": {
        "updatedAt": "…",
        "updatedBy": "…",
        "itemsCount": 1,
        "itemsBytes": 1
      },
      "id": "…",
      "lastModified": 1
    }
  ],
  "pagination": {
    "hasNext": true,
    "next": "…"
  }
}

Get Edge Config items​

Returns all items of an Edge Config.

Path Parameters
  • edgeConfigId
    string ^ecfg_
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/items
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/items')

{
  "key": "…",
  "value": "…",
  "description": "…",
  "edgeConfigId": "…",
  "createdAt": 1,
  "updatedAt": 1
}

The EdgeConfig.

Get Edge Config schema​

Returns the schema of an Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/schema
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/schema')

null

The EdgeConfig.

Get Edge Config token meta data​

Return meta data about an Edge Config token.

Path Parameters
  • edgeConfigId
    string
    required
  • token
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 404
GET/v1/edge-config/{edgeConfigId}/token/{token}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/token/{token}')

{
  "token": "…",
  "label": "…",
  "id": "…",
  "edgeConfigId": "…",
  "createdAt": 1
}

The EdgeConfig.

Get Edge Configs​

Returns all Edge Configs.

Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

GET/v1/edge-config
fetch('https://api.vercel.com/v1/edge-config')

{
  "id": "…",
  "createdAt": 1,
  "ownerId": "…",
  "slug": "…",
  "updatedAt": 1,
  "digest": "…",
  "transfer": {
    "fromAccountId": "…",
    "startedAt": 1,
    "doneAt": null
  },
  "schema": {},
  "purpose": {
    "type": "flags",
    "projectId": "…"
  },
  "sizeInBytes": 1,
  "itemCount": 1
}

List of all edge configs.

Update an Edge Config​

Updates an Edge Config.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
slug
string
max: 
64^[\\w-]+$
required
Responses
  • 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
PUT/v1/edge-config/{edgeConfigId}
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    slug: ''
  })
})

{
  "createdAt": 1,
  "updatedAt": 1,
  "id": "…",
  "slug": "…",
  "ownerId": "…",
  "digest": "…",
  "transfer": {
    "fromAccountId": "…",
    "startedAt": 1,
    "doneAt": null
  },
  "schema": {},
  "purpose": {
    "type": "flags",
    "projectId": "…"
  },
  "sizeInBytes": 1,
  "itemCount": 1
}

Update Edge Config items in batch​

Update multiple Edge Config Items in batch.

Path Parameters
  • edgeConfigId
    string ^ecfg_
    required
Query Parameters
  • dryRun
    string
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
items
array
required
definition
required
Responses
  • 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
PATCH/v1/edge-config/{edgeConfigId}/items
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/items', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [{
      operation: null,
      key: '',
      value: null,
      description: ''
    }],
    definition: null
  })
})

{
  "status": "…"
}

Update Edge Config schema​

Update an Edge Config's schema.

Path Parameters
  • edgeConfigId
    string
    required
Query Parameters
  • dryRun
    string
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
definition
required
Responses
  • 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
POST/v1/edge-config/{edgeConfigId}/schema
fetch('https://api.vercel.com/v1/edge-config/{edgeConfigId}/schema', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    definition: null
  })
})

null

environment​

environment Endpoints

integrations​

integrations Endpoints

logDrains​

logDrains Endpoints

marketplace​

marketplace Endpoints

projectMembers​

projectMembers Endpoints

projects​

projects Endpoints

secrets​

secrets Endpoints

security​

security Endpoints

teams​

teams Endpoints

user​

user Endpoints

webhooks​

webhooks Endpoints

Models