# Vercel Integration via LowCodeAPI
## Overview
Frontend deployment
## Base Endpoint
```
https://api.lowcodeapi.com/vercel/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Vercel](https://vercel.com)
2. **Get your credentials** from [credential page](https://vercel.com/account/api)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: TOKEN
## API Categories
- **Access Groups** - 11 endpoints
- **Aliases** - 4 endpoints
- **Artifacts** - 6 endpoints
- **Bulk Redirects** - 7 endpoints
- **Certificates** - 4 endpoints
- **Checks** - 5 endpoints
- **DNS** - 4 endpoints
- **Deployments** - 5 endpoints
- **Domains** - 4 endpoints
- **Edge Config** - 5 endpoints
- **Environment Variables** - 5 endpoints
- **Files** - 1 endpoints
- **Integrations** - 6 endpoints
- **Logs** - 1 endpoints
- **Project Members** - 3 endpoints
- **Project Settings** - 2 endpoints
- **Projects** - 5 endpoints
- **Secrets** - 4 endpoints
- **Teams** - 5 endpoints
- **User** - 1 endpoints
- **Webhooks** - 5 endpoints
## Common Endpoints
### Category: Access Groups
#### Reads an access group
**Method**: `GET` | **LowCodeAPI Path**: `/v1/access-groups/idorname`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Allows to read an access group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Update an access group
**Method**: `POST` | **LowCodeAPI Path**: `/v1/access-groups/idorname`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Update an access group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Deletes an access group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/access-groups/idorname`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Deletes an access group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### List access groups for a team, project or member
**Method**: `GET` | **LowCodeAPI Path**: `/v1/access-groups`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups?teamId={teamId}&slug={slug}&projectId={projectId}&memberId={memberId}&api_token={api_token}
```
**Description**: List access groups for a team, project or member
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
|`projectId` | string | No | Filter by project ID |
|`memberId` | string | No | Filter by member ID |
---
#### Creates an access group
**Method**: `POST` | **LowCodeAPI Path**: `/v1/access-groups`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups?teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Creates an access group
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### List members of an access group
**Method**: `GET` | **LowCodeAPI Path**: `/v1/access-groups/idorname/members`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/members?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: List members of an access group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### List projects of an access group
**Method**: `GET` | **LowCodeAPI Path**: `/v1/access-groups/idorname/projects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/projects?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: List projects of an access group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Create an access group project
**Method**: `POST` | **LowCodeAPI Path**: `/v1/access-groups/idorname/projects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/projects?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Create an access group project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"projectId": "<string>"
}
```
---
#### Reads an access group project
**Method**: `GET` | **LowCodeAPI Path**: `/v1/access-groups/idorname/projects/projectid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/projects/projectid?idOrName={idOrName}&projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Reads an access group project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
|`projectId` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Update an access group project
**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/access-groups/idorname/projects/projectid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/projects/projectid?idOrName={idOrName}&projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Update an access group project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
|`projectId` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete an access group project
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/access-groups/idorname/projects/projectid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/access-groups/idorname/projects/projectid?idOrName={idOrName}&projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Delete an access group project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | Access group ID or name |
|`projectId` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
### Category: Aliases
#### List aliases
**Method**: `GET` | **LowCodeAPI Path**: `/v2/deployments/deployment_id/aliases`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id/aliases?teamId={teamId}&api_token={api_token}
```
**Description**: List aliases
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Create an alias
**Method**: `POST` | **LowCodeAPI Path**: `/v2/deployments/deployment_id/aliases`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id/aliases?teamId={teamId}&api_token={api_token}
```
**Description**: Create an alias
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"alias": "<string>"
}
```
---
#### Get alias
**Method**: `GET` | **LowCodeAPI Path**: `/v2/aliases/alias_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/aliases/alias_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get alias
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`alias_id` | string | Yes | Alias ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Delete alias
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/aliases/alias_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/aliases/alias_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete alias
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`alias_id` | string | Yes | Alias ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Artifacts
#### Record an artifacts cache usage event
**Method**: `POST` | **LowCodeAPI Path**: `/v8/artifacts`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts?teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Record an artifacts cache usage event
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"hash": "<string>"
}
```
---
#### Get status of Remote Caching for this principal
**Method**: `GET` | **LowCodeAPI Path**: `/v8/artifacts/status`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts/status?teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Get status of Remote Caching for this principal
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Download a cache artifact
**Method**: `GET` | **LowCodeAPI Path**: `/v8/artifacts/hash`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts/hash?hash={hash}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Download a cache artifact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`hash` | string | Yes | Artifact hash |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Upload a cache artifact
**Method**: `PUT` | **LowCodeAPI Path**: `/v8/artifacts/hash`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts/hash?hash={hash}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Upload a cache artifact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`hash` | string | Yes | Artifact hash |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"file": "<file>"
}
```
---
#### Check if a cache artifact exists
**Method**: `HEAD` | **LowCodeAPI Path**: `/v8/artifacts/hash`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts/hash?hash={hash}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Check if a cache artifact exists
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`hash` | string | Yes | Artifact hash |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Query information about an artifact
**Method**: `POST` | **LowCodeAPI Path**: `/v8/artifacts/events`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v8/artifacts/events?teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Query information about an artifact
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"hashes": "<array>"
}
```
---
### Category: Bulk Redirects
#### Gets project-level redirects
**Method**: `GET` | **LowCodeAPI Path**: `/v1/bulk-redirects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects?projectId={projectId}&versionId={versionId}&q={q}&diff={diff}&page={page}&per_page={per_page}&sort_by={sort_by}&sort_order={sort_order}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Get the version history for a project's bulk redirects
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`versionId` | string | No | Version ID |
|`q` | string | No | Search query |
|`diff` | boolean | No | Show diff |
|`page` | integer | No | Page number |
|`per_page` | integer | No | Items per page |
|`sort_by` | string | No | Sort by |
|`sort_order` | string | No | Sort order |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Stages new redirects for a project
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/bulk-redirects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects?projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Stages new redirects for a project
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"redirects": "<array>"
}
```
---
#### Delete project-level redirects
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/bulk-redirects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects?projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Delete project-level redirects
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Edit a project-level redirect
**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/bulk-redirects/redirectid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects/redirectid?redirectId={redirectId}&projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Edit a project-level redirect
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`redirectId` | string | Yes | Redirect ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Restore staged project-level redirects to their production version
**Method**: `POST` | **LowCodeAPI Path**: `/v1/bulk-redirects/restore`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects/restore?projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Restore staged project-level redirects to their production version
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Get the version history for a project's redirects
**Method**: `GET` | **LowCodeAPI Path**: `/v1/bulk-redirects/versions`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects/versions?projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Get the version history for a project's redirects
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Promote a staging version to production or restore a previous production version
**Method**: `POST` | **LowCodeAPI Path**: `/v1/bulk-redirects/versions/promote`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/bulk-redirects/versions/promote?projectId={projectId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Promote a staging version to production or restore a previous production version
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`projectId` | string | Yes | Project ID |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"versionId": "<string>"
}
```
---
### Category: Certificates
#### List certificates
**Method**: `GET` | **LowCodeAPI Path**: `/v2/certificates`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/certificates?teamId={teamId}&limit={limit}&api_token={api_token}
```
**Description**: List certificates
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter certificates by team ID |
|`limit` | integer | No | Maximum number of certificates to return |
---
#### Create a certificate
**Method**: `POST` | **LowCodeAPI Path**: `/v2/certificates`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/certificates?teamId={teamId}&api_token={api_token}
```
**Description**: Create a certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"domains": "<array>"
}
```
---
#### Get certificate
**Method**: `GET` | **LowCodeAPI Path**: `/v2/certificates/certificate_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/certificates/certificate_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get certificate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`certificate_id` | string | Yes | Certificate ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Delete certificate
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/certificates/certificate_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/certificates/certificate_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete certificate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`certificate_id` | string | Yes | Certificate ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Checks
#### Retrieve a list of all checks
**Method**: `GET` | **LowCodeAPI Path**: `/v1/deployments/deploymentid/checks`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/deployments/deploymentid/checks?deploymentId={deploymentId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: List all of the checks created for a deployment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deploymentId` | string | Yes | The deployment to get all checks for |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Creates a new Check
**Method**: `POST` | **LowCodeAPI Path**: `/v1/deployments/deploymentid/checks`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/deployments/deploymentid/checks?deploymentId={deploymentId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Creates a new Check
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deploymentId` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"name": "<string>",
"integrationId": "<string>"
}
```
---
#### Get a single check
**Method**: `GET` | **LowCodeAPI Path**: `/v1/deployments/deploymentid/checks/checkid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/deployments/deploymentid/checks/checkid?deploymentId={deploymentId}&checkId={checkId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Get a single check
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deploymentId` | string | Yes | Deployment ID |
|`checkId` | string | Yes | Check ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Update a check
**Method**: `PATCH` | **LowCodeAPI Path**: `/v1/deployments/deploymentid/checks/checkid`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/deployments/deploymentid/checks/checkid?deploymentId={deploymentId}&checkId={checkId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Update a check
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deploymentId` | string | Yes | Deployment ID |
|`checkId` | string | Yes | Check ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Rerequest a check
**Method**: `POST` | **LowCodeAPI Path**: `/v1/deployments/deploymentid/checks/checkid/rerequest`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/deployments/deploymentid/checks/checkid/rerequest?deploymentId={deploymentId}&checkId={checkId}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Rerequest a check
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deploymentId` | string | Yes | Deployment ID |
|`checkId` | string | Yes | Check ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
### Category: DNS
#### List DNS records
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/domain/records`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain/records?teamId={teamId}&api_token={api_token}
```
**Description**: List DNS records
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Create a DNS record
**Method**: `POST` | **LowCodeAPI Path**: `/v2/domains/domain/records`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain/records?teamId={teamId}&api_token={api_token}
```
**Description**: Create a DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>",
"type": "<string>",
"value": "<string>"
}
```
---
#### Get DNS record
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/domain/records/record_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain/records/record_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
|`record_id` | string | Yes | Record ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Delete DNS record
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/domains/domain/records/record_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain/records/record_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
|`record_id` | string | Yes | Record ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Deployments
#### List deployments
**Method**: `GET` | **LowCodeAPI Path**: `/v2/deployments`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments?teamId={teamId}&projectId={projectId}&target={target}&limit={limit}&since={since}&until={until}&api_token={api_token}
```
**Description**: List deployments
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter deployments by team ID |
|`projectId` | string | No | Filter deployments by project ID |
|`target` | string | No | Filter deployments by target |
|`limit` | integer | No | Maximum number of deployments to return |
|`since` | string | No | Only return deployments created after this timestamp |
|`until` | string | No | Only return deployments created before this timestamp |
---
#### Create a deployment
**Method**: `POST` | **LowCodeAPI Path**: `/v2/deployments`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments?teamId={teamId}&api_token={api_token}
```
**Description**: Create a deployment
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>",
"files": "<array>"
}
```
---
#### Get deployment
**Method**: `GET` | **LowCodeAPI Path**: `/v2/deployments/deployment_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get deployment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Cancel deployment
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/deployments/deployment_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id?teamId={teamId}&api_token={api_token}
```
**Description**: Cancel deployment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Delete deployment
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/deployments/deployment_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete deployment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Domains
#### List domains
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains?teamId={teamId}&limit={limit}&since={since}&until={until}&api_token={api_token}
```
**Description**: List domains
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter domains by team ID |
|`limit` | integer | No | Maximum number of domains to return |
|`since` | string | No | Only return domains created after this timestamp |
|`until` | string | No | Only return domains created before this timestamp |
---
#### Add a domain
**Method**: `POST` | **LowCodeAPI Path**: `/v2/domains`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains?teamId={teamId}&api_token={api_token}
```
**Description**: Add a domain
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Get domain
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/domain`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain?teamId={teamId}&api_token={api_token}
```
**Description**: Get domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Remove a domain
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/domains/domain`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/domains/domain?teamId={teamId}&api_token={api_token}
```
**Description**: Remove a domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`domain` | string | Yes | Domain name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Edge Config
#### List edge configs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/edge-config`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/edge-config?teamId={teamId}&api_token={api_token}
```
**Description**: List edge configs
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter edge configs by team ID |
---
#### Create an edge config
**Method**: `POST` | **LowCodeAPI Path**: `/v2/edge-config`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/edge-config?teamId={teamId}&api_token={api_token}
```
**Description**: Create an edge config
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Get edge config
**Method**: `GET` | **LowCodeAPI Path**: `/v2/edge-config/edge_config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/edge-config/edge_config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get edge config
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`edge_config_id` | string | Yes | Edge config ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update edge config
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/edge-config/edge_config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/edge-config/edge_config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Update edge config
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`edge_config_id` | string | Yes | Edge config ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"items": "<object>"
}
```
---
#### Delete edge config
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/edge-config/edge_config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/edge-config/edge_config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete edge config
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`edge_config_id` | string | Yes | Edge config ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Environment Variables
#### List environment variables
**Method**: `GET` | **LowCodeAPI Path**: `/v2/projects/project_id/env`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/env?teamId={teamId}&api_token={api_token}
```
**Description**: List environment variables
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Create an environment variable
**Method**: `POST` | **LowCodeAPI Path**: `/v2/projects/project_id/env`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/env?teamId={teamId}&api_token={api_token}
```
**Description**: Create an environment variable
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "<string>",
"value": "<string>"
}
```
---
#### Get environment variable
**Method**: `GET` | **LowCodeAPI Path**: `/v2/projects/project_id/env/env_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/env/env_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get environment variable
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
|`env_id` | string | Yes | Environment variable ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update environment variable
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/projects/project_id/env/env_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/env/env_id?teamId={teamId}&api_token={api_token}
```
**Description**: Update environment variable
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
|`env_id` | string | Yes | Environment variable ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete environment variable
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/projects/project_id/env/env_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/env/env_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete environment variable
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
|`env_id` | string | Yes | Environment variable ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Files
#### List deployment files
**Method**: `GET` | **LowCodeAPI Path**: `/v2/deployments/deployment_id/files`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id/files?teamId={teamId}&pathname={pathname}&api_token={api_token}
```
**Description**: List deployment files
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
|`pathname` | string | No | File path |
---
### Category: Integrations
#### List integrations
**Method**: `GET` | **LowCodeAPI Path**: `/v2/integrations`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations?teamId={teamId}&api_token={api_token}
```
**Description**: List integrations
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter integrations by team ID |
---
#### List integration configurations
**Method**: `GET` | **LowCodeAPI Path**: `/v2/integrations/configurations`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations/configurations?teamId={teamId}&projectId={projectId}&api_token={api_token}
```
**Description**: List integration configurations
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter configurations by team ID |
|`projectId` | string | No | Filter configurations by project ID |
---
#### Create an integration configuration
**Method**: `POST` | **LowCodeAPI Path**: `/v2/integrations/configurations`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations/configurations?teamId={teamId}&api_token={api_token}
```
**Description**: Create an integration configuration
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"integrationId": "<string>",
"configuration": "<object>"
}
```
---
#### Get integration configuration
**Method**: `GET` | **LowCodeAPI Path**: `/v2/integrations/configurations/config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations/configurations/config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get integration configuration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`config_id` | string | Yes | Configuration ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update integration configuration
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/integrations/configurations/config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations/configurations/config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Update integration configuration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`config_id` | string | Yes | Configuration ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete integration configuration
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/integrations/configurations/config_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/integrations/configurations/config_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete integration configuration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`config_id` | string | Yes | Configuration ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Logs
#### Get deployment events
**Method**: `GET` | **LowCodeAPI Path**: `/v2/deployments/deployment_id/events`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/deployments/deployment_id/events?teamId={teamId}&follow={follow}&since={since}&api_token={api_token}
```
**Description**: Get deployment events
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deployment_id` | string | Yes | Deployment ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
|`follow` | boolean | No | Follow logs in real-time |
|`since` | string | No | Only return events after this timestamp |
---
### Category: Project Members
#### List project members
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/idorname/members`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/projects/idorname/members?idOrName={idOrName}&limit={limit}&since={since}&until={until}&search={search}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Lists all members of a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | The ID or name of the Project |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`limit` | integer | No | Limit how many project members should be returned |
|`since` | integer | No | Timestamp in milliseconds to only include members added since then |
|`until` | integer | No | Timestamp in milliseconds to only include members added until then |
|`search` | string | No | Search project members by their name, username, and email |
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
#### Adds a new member to a project
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/idorname/members`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/projects/idorname/members?idOrName={idOrName}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Adds a new member to a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | The ID or name of the Project |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
**Request Body**:
```json
{
"email": "<string>"
}
```
---
#### Remove a Project Member
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/idorname/members/email`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v1/projects/idorname/members/email?idOrName={idOrName}&email={email}&teamId={teamId}&slug={slug}&api_token={api_token}
```
**Description**: Remove a Project Member
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`idOrName` | string | Yes | The ID or name of the Project |
|`email` | string | Yes | Member email |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | The Team identifier to perform the request on behalf of |
|`slug` | string | No | The Team slug to perform the request on behalf of |
---
### Category: Project Settings
#### Get project settings
**Method**: `GET` | **LowCodeAPI Path**: `/v2/projects/project_id/settings`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/settings?teamId={teamId}&api_token={api_token}
```
**Description**: Get project settings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update project settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/projects/project_id/settings`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id/settings?teamId={teamId}&api_token={api_token}
```
**Description**: Update project settings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
### Category: Projects
#### List projects
**Method**: `GET` | **LowCodeAPI Path**: `/v2/projects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects?teamId={teamId}&limit={limit}&since={since}&until={until}&api_token={api_token}
```
**Description**: List projects
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter projects by team ID |
|`limit` | integer | No | Maximum number of projects to return |
|`since` | string | No | Only return projects created after this timestamp |
|`until` | string | No | Only return projects created before this timestamp |
---
#### Create a project
**Method**: `POST` | **LowCodeAPI Path**: `/v2/projects`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects?teamId={teamId}&api_token={api_token}
```
**Description**: Create a project
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Get project
**Method**: `GET` | **LowCodeAPI Path**: `/v2/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update project
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id?teamId={teamId}&api_token={api_token}
```
**Description**: Update project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete project
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/projects/project_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | Yes | Project ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Secrets
#### List secrets
**Method**: `GET` | **LowCodeAPI Path**: `/v2/secrets`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/secrets?teamId={teamId}&projectId={projectId}&api_token={api_token}
```
**Description**: List secrets
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter secrets by team ID |
|`projectId` | string | No | Filter secrets by project ID |
---
#### Create a secret
**Method**: `POST` | **LowCodeAPI Path**: `/v2/secrets`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/secrets?teamId={teamId}&api_token={api_token}
```
**Description**: Create a secret
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"name": "<string>",
"value": "<string>"
}
```
---
#### Get secret
**Method**: `GET` | **LowCodeAPI Path**: `/v2/secrets/name`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/secrets/name?teamId={teamId}&api_token={api_token}
```
**Description**: Get secret
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`name` | string | Yes | Secret name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Delete secret
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/secrets/name`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/secrets/name?teamId={teamId}&api_token={api_token}
```
**Description**: Delete secret
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`name` | string | Yes | Secret name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
### Category: Teams
#### List teams
**Method**: `GET` | **LowCodeAPI Path**: `/v2/teams`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/teams?limit={limit}&since={since}&until={until}&api_token={api_token}
```
**Description**: List teams
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`limit` | integer | No | Maximum number of teams to return |
|`since` | string | No | Only return teams created after this timestamp |
|`until` | string | No | Only return teams created before this timestamp |
---
#### Create a team
**Method**: `POST` | **LowCodeAPI Path**: `/v2/teams`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/teams?api_token={api_token}
```
**Description**: Create a team
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Get team information
**Method**: `GET` | **LowCodeAPI Path**: `/v2/teams/team_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/teams/team_id?api_token={api_token}
```
**Description**: Get team information
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |
---
#### Update team
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/teams/team_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/teams/team_id?api_token={api_token}
```
**Description**: Update team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete team
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/teams/team_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/teams/team_id?api_token={api_token}
```
**Description**: Delete team
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |
---
### Category: User
#### Get authenticated user
**Method**: `GET` | **LowCodeAPI Path**: `/v2/user`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/user?api_token={api_token}
```
**Description**: Get authenticated user
---
### Category: Webhooks
#### List webhooks
**Method**: `GET` | **LowCodeAPI Path**: `/v2/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/webhooks?teamId={teamId}&projectId={projectId}&api_token={api_token}
```
**Description**: List webhooks
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Filter webhooks by team ID |
|`projectId` | string | No | Filter webhooks by project ID |
---
#### Create a webhook
**Method**: `POST` | **LowCodeAPI Path**: `/v2/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/webhooks?teamId={teamId}&api_token={api_token}
```
**Description**: Create a webhook
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"url": "<string>",
"events": "<array>"
}
```
---
#### Get webhook
**Method**: `GET` | **LowCodeAPI Path**: `/v2/webhooks/webhook_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/webhooks/webhook_id?teamId={teamId}&api_token={api_token}
```
**Description**: Get webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`webhook_id` | string | Yes | Webhook ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
#### Update webhook
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/webhooks/webhook_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/webhooks/webhook_id?teamId={teamId}&api_token={api_token}
```
**Description**: Update webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`webhook_id` | string | Yes | Webhook ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete webhook
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/webhooks/webhook_id`
**Full URL**:
```
https://api.lowcodeapi.com/vercel/v2/webhooks/webhook_id?teamId={teamId}&api_token={api_token}
```
**Description**: Delete webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`webhook_id` | string | Yes | Webhook ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`teamId` | string | No | Team ID |
---
## Complete Endpoint Reference
For a complete list of all 93 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/vercel/definition`
- **Official Provider Documentation**: https://vercel.com/docs/rest-api