Connecting to Vercel

Using API Key Authentication

Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

To obtain a personal access token:

1. Log into your Vercel account at https://vercel.com/
2. Navigate to Account Settings > Tokens.
3. Click Create Token, enter a name and expiration, and click Create.
4. Copy the generated token (it will only be shown once).

After obtaining your token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Vercel personal access token or OAuth access token.

Example Connection String

Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;

Working with Teams

Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

Connecting to Vercel

Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

Available Tables

The Vercel API Profile provides access to the following tables:

• AccessGroupMembers: Retrieve members of a specified access group (requires AccessGroupId; enterprise plan only)
• AccessGroupProjects: Retrieve projects assigned to a specified access group (requires AccessGroupId; enterprise plan only)
• AccessGroups: Retrieve a list of access groups for the account (enterprise plan only)
• Aliases: Retrieve a list of deployment aliases
• Certs: Retrieve a list of SSL certificates
• Deployment: Retrieve details of a single deployment (requires DeploymentId)
• DeploymentAliases: Retrieve aliases assigned to a specified deployment (requires DeploymentId)
• DeploymentChecks: Retrieve check runs registered for a specified deployment (requires DeploymentId)
• DeploymentEvents: Retrieve build and deployment log events for a specified deployment (requires DeploymentId)
• DeploymentFiles: Retrieve the file tree for a specified deployment (requires DeploymentId)
• Deployments: Retrieve a list of Vercel deployments
• DnsRecords: Retrieve DNS records for a specified domain (requires DomainName)
• DomainConfig: Retrieve DNS configuration details for a specified domain (requires DomainName)
• Domains: Retrieve a list of domains registered under the account
• EdgeConfigs: Retrieve a list of Edge Config stores
• Project: Retrieve details of a single project (requires ProjectId)
• ProjectCustomEnvironments: Retrieve custom environments for a specified project (requires ProjectId)
• ProjectDomains: Retrieve domains configured for a specified project (requires ProjectId)
• ProjectEnvVars: Retrieve environment variables for a specified project (requires ProjectId)
• ProjectMembers: Retrieve members with access to a specified project (requires ProjectId)
• Projects: Retrieve a list of Vercel projects
• TeamMembers: Retrieve members of a specified team (requires TeamId)
• Teams: Retrieve a list of teams the authenticated user belongs to
• User: Retrieve information about the authenticated user

Important Notes

• Most team-scoped tables accept TeamId as an optional filter. Set it as a connection property or specify it in your SQL WHERE clause.
• Several child tables require a parent identifier (e.g. DeploymentId, ProjectId, DomainName, AccessGroupId, TeamId) to be specified as a filter.
• AccessGroup tables require an enterprise Vercel plan; queries against them will return HTTP 403 on hobby or pro plans.
• Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.fffZ).
• Rate limiting applies — refer to Vercel API documentation for current limits.

API Documentation

For more information about the Vercel API, see the official Vercel API documentation.

Usage Examples

User:

SELECT * FROM User

Teams:

SELECT * FROM Teams

Projects:

SELECT * FROM Projects

Deployments:

SELECT * FROM Deployments

Domains:

SELECT * FROM Domains

Aliases:

SELECT * FROM Aliases

Certs:

SELECT * FROM Certs

EdgeConfigs:

SELECT * FROM EdgeConfigs

AccessGroups:

SELECT * FROM AccessGroups

TeamMembers:

SELECT * FROM TeamMembers WHERE TeamId = 'your-team-id'

Project:

SELECT * FROM Project WHERE ProjectId = 'my-project'

ProjectMembers:

SELECT * FROM ProjectMembers WHERE ProjectId = 'my-project'

ProjectEnvVars:

SELECT * FROM ProjectEnvVars WHERE ProjectId = 'my-project'

ProjectDomains:

SELECT * FROM ProjectDomains WHERE ProjectId = 'my-project'

ProjectCustomEnvironments:

SELECT * FROM ProjectCustomEnvironments WHERE ProjectId = 'my-project'

Deployment:

SELECT * FROM Deployment WHERE DeploymentId = 'dpl_xxxxxxxxxxxx'

DeploymentAliases:

SELECT * FROM DeploymentAliases WHERE DeploymentId = 'dpl_xxxxxxxxxxxx'

DeploymentChecks:

SELECT * FROM DeploymentChecks WHERE DeploymentId = 'dpl_xxxxxxxxxxxx'

DeploymentEvents:

SELECT * FROM DeploymentEvents WHERE DeploymentId = 'dpl_xxxxxxxxxxxx'

DeploymentFiles:

SELECT * FROM DeploymentFiles WHERE DeploymentId = 'dpl_xxxxxxxxxxxx'

DnsRecords:

SELECT * FROM DnsRecords WHERE DomainName = 'example.com'

DomainConfig:

SELECT * FROM DomainConfig WHERE DomainName = 'example.com'

AccessGroupMembers:

SELECT * FROM AccessGroupMembers WHERE AccessGroupId = 'ag_xxxxxxxxxxxx'

AccessGroupProjects:

SELECT * FROM AccessGroupProjects WHERE AccessGroupId = 'ag_xxxxxxxxxxxx'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The personal access token or OAuth access token used to authenticate against the Vercel API.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT