Connectors
Cloud Infrastructure & DevOps
Vercel
Frontend hosting: projects, deployments, domains, and environment variables
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 332
- Ready-made triggers
- 0
Connect Vercel
- In Neblex open Connect › Connections and click New Connection.
- Search for Vercel and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Vercel.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Vercel without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Vercel can send webhooks, a Webhook trigger receives them at its own URL.
Operations
332 operations in 37 groups. Each one is a step you can add to a flow.
Access Group11
Create an access group projectcreateAccessGroupProject | POST | Allows creation of an access group project |
Creates an access groupcreateAccessGroup | POST | Allows to create an access group |
Delete an access group projectdeleteAccessGroupProject | DELETE | Allows deletion of an access group project |
Deletes an access groupdeleteAccessGroup | DELETE | Allows to delete an access group |
List access groups for a team, project or memberlistAccessGroups | GET | List access groups |
List members of an access grouplistAccessGroupMembers | GET | List members of an access group |
List projects of an access grouplistAccessGroupProjects | GET | List projects of an access group |
Reads an access groupreadAccessGroup | GET | Allows to read an access group |
Reads an access group projectreadAccessGroupProject | GET | Allows reading an access group project |
Update an access groupupdateAccessGroup | POST | Allows to update an access group metadata |
Update an access group projectupdateAccessGroupProject | PATCH | Allows update of an access group project |
Aliase6
Assign an AliasassignAlias | POST | Creates a new alias for the deployment resolved from the given deployment or alias ID or URL. |
Delete an AliasdeleteAlias | DELETE | Delete an Alias with the specified ID. |
Get an AliasgetAlias | GET | Retrieves an Alias for the given host name or alias ID. |
List aliaseslistAliases | GET | Retrieves a list of aliases for the authenticated User or Team. |
List Deployment AliaseslistDeploymentAliases | GET | Retrieves all Aliases for the Deployment with the given ID. |
Update the protection bypass for a URLpatchUrlProtectionBypass | PATCH | Update the protection bypass for the alias or deployment URL (used for user access & comment access for deployments). |
Api Observability2
Lists disabled Observability Plus projectsgetObservabilityConfigurationProjects | GET | Lists the projects that are currently configured as disabled for Observability Plus on a team. |
Updates a disabled Observability Plus project settingupdateObservabilityConfigurationProject | PUT | Updates whether Observability Plus is disabled for a single project. |
Artifact6
Delete all cache artifactsdeleteAllArtifacts | DELETE | Deletes all cache artifacts stored for the authenticated team or user, clearing the Remote Cache. |
Download a cache artifactdownloadArtifact | GET | Downloads a cache artifact indentified by its hash specified on the request path. |
Get status of Remote Caching for this principalstatus | GET | Check the status of Remote Caching for this principal. |
Query information about an artifactartifactQuery | POST | Query information about an array of artifacts. |
Record an artifacts cache usage eventrecordEvents | POST | Records an artifacts cache usage event. |
Upload a cache artifactuploadArtifact | PUT | Uploads a cache artifact identified by the hash specified on the path. |
Authentication5
Create an Auth TokencreateAuthToken | POST | Creates and returns a new authentication token for the currently authenticated User. |
Delete an authentication tokendeleteAuthToken | DELETE | Invalidate an authentication token, such that it will no longer be valid for future HTTP requests. |
Get Auth Token MetadatagetAuthToken | GET | Retrieve metadata about an authentication token belonging to the currently authenticated User. |
List Auth TokenslistAuthTokens | GET | Retrieve a list of the current User's authentication tokens. |
SSO Token Exchangeexchange_sso_token | POST | During the autorization process, Vercel sends the user to the provider redirectLoginUrl, that includes the OAuth authorization code parameter. |
Billing3
List FOCUS billing chargeslistBillingCharges | GET | Returns the billing charge data in FOCUS v1.3 JSONL format for a specified Vercel team, within a date range specified by from and to query parameters. |
List FOCUS contract commitmentslistContractCommitments | GET | Returns commitment allocations per contract period in FOCUS v1.3 JSONL format for a specified Vercel team. |
Purchase creditsbuyCredits | POST | Purchases credits for a Vercel team using the default payment method on file. |
Bulk Redirect7
Delete project-level redirects.deleteRedirects | DELETE | Deletes the provided redirects from the latest version of the projects' bulk redirects. |
Edit a project-level redirect.editRedirect | PATCH | Edits a single redirect identified by its source path. |
Get the version history for a project's redirects.getVersions | GET | Get the version history for a project's bulk redirects |
Gets project-level redirects.getRedirects | GET | Get the version history for a project's bulk redirects |
Promote a staging version to production or restore a previousupdateVersion | POST | Update a version by promoting staging to production or restoring a previous production version |
Restore staged project-level redirects to their productionrestoreRedirects | POST | Restores the provided redirects in the staging version to the value in the production version. |
Stages new redirects for a project.stageRedirects | PUT | Stages new redirects for a project and returns the new version. |
Cert4
Get cert by idgetCertById | GET | Get cert by id |
Issue a new certissueCert | POST | Issue a new cert |
Remove certremoveCert | DELETE | Remove cert |
Upload a certuploadCert | PUT | Upload a cert |
Check5
Creates a new CheckcreateCheck | POST | Creates a new check. |
Get a single checkgetCheck | GET | Return a detailed response for a single check. |
Rerequest a checkrerequestCheck | POST | Rerequest a selected check that has failed. |
Retrieve a list of all checksgetAllChecks | GET | List all of the checks created for a deployment. |
Update a checkupdateCheck | PATCH | Update an existing check. |
Checks V210
Create a checkcreateProjectCheck | POST | Creates a new check for a project. |
Create a check runcreateDeploymentCheckRun | POST | Creates a new check run for a deployment. |
Delete a checkdeleteProjectCheck | DELETE | Delete an existing check and all of its runs. |
Get a checkgetProjectCheck | GET | Return a detailed response for a single check. |
Get a check rungetDeploymentCheckRun | GET | Return a detailed response for a single check run. |
List all checks for a projectlistProjectChecks | GET | List all checks for a project, optionally filtered by target. |
List check runs for a deploymentlistDeploymentCheckRuns | GET | List all check runs for a deployment. |
List runs for a checklistCheckRuns | GET | List all runs associated with a given check. |
Update a checkupdateProjectCheck | PATCH | Update an existing check. |
Update a check runupdateDeploymentCheckRun | PATCH | Update an existing check run for a deployment. |
Connect4
Create a Connect authorization requestcreateConnectorAuthorizationRequest | POST | Create an authorization request for a connector and return the URL and verifier details needed to complete the flow. |
Create a connectorcreateConnector | POST | Create a connector from type-specific configuration and optionally link it to a project during creation. |
Get a Connect tokengetConnectorToken | POST | Get an access token for a connector identified by the path parameter and scoped to the requester. |
Import Connect tokensimportConnectorTokens | POST | Import access and refresh tokens for a connector identified by the path parameter. |
Deployment10
Cancel a deploymentcancelDeployment | PATCH | Cancels a deployment that is currently in progress, stopping the build before it completes. |
Create a new deploymentcreateDeployment | POST | Creates a new deployment for the authenticated team or user. |
Delete a DeploymentdeleteDeployment | DELETE | This API allows you to delete a deployment, either by supplying its id in the URL or the url of the deployment as a query parameter. |
Get a deployment by ID or URLgetDeployment | GET | Retrieves information for a deployment either by supplying its ID (id property) or Hostname (url property). |
Get deployment eventsgetDeploymentEvents | GET | Get the build logs of a deployment by deployment ID and build ID. |
Get Deployment File ContentsgetDeploymentFileContents | GET | Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. |
List Deployment FileslistDeploymentFiles | GET | Allows to retrieve the file structure of the source code of a deployment by supplying the deployment unique identifier. |
List deploymentsgetDeployments | GET | List deployments under the authenticated user or team. |
Update deployment integration actionupdate_integration_deployment_action | PATCH | Updates the deployment integration action for the specified integration installation |
Upload Deployment FilesuploadFile | POST | Before you create a deployment you need to upload the required files for that deployment. |
Dn4
Create a DNS recordcreateRecord | POST | Creates a DNS record for a domain. |
Delete a DNS recordremoveRecord | DELETE | Removes an existing DNS record from a domain name. |
List existing DNS recordsgetRecords | GET | Retrieves a list of DNS records created for a domain name. |
Update an existing DNS recordupdateRecord | PATCH | Updates an existing DNS record for a domain name. |
Domain9
Add an existing domain to the Vercel platformcreateOrTransferDomain | POST | This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. |
Claim Domain OwnershipclaimDomainOwnership | POST | Claim ownership of a domain for the authenticated team by verifying a TXT record. |
Get a Domain's configurationgetDomainConfig | GET | Get a Domain's configuration. |
Get Domain Verification RecordgetDomainVerificationRecord | GET | Get the TXT verification record needed to claim ownership of a domain for the authenticated team. |
Get Information for a Single DomaingetDomain | GET | Get information for a single domain in an account or team. |
List all the domainsgetDomains | GET | Retrieves a list of domains registered for the authenticated user or team. |
List Project Domains by Apex DomaingetDomainProjectDomains | GET | List all project domains associated with an apex domain owned by the authenticated account. |
Remove a domain by namedeleteDomain | DELETE | Delete a previously registered domain name from Vercel. |
Update or move apex domainpatchDomain | PATCH | Update or move apex domain. |
Domains Registrar17
Buy a domainbuySingleDomain | POST | Buy a domain |
Buy multiple domainsbuyDomains | POST | Buy multiple domains at once |
Get a domain ordergetOrder | GET | Get information about a domain order by its ID |
Get a domain's transfer statusgetDomainTransferIn | GET | Get the transfer status for a domain |
Get availability for a domaingetDomainAvailability | GET | Get availability for a specific domain. |
Get availability for multiple domainsgetBulkAvailability | POST | Get availability for multiple domains. |
Get contact info schemagetContactInfoSchema | GET | Some TLDs require additional contact information. |
Get contact verification status for a domaingetDomainContactVerification | GET | Get the registrant contact verification status for a domain. |
Get price data for a domaingetDomainPrice | GET | Get price data for a specific domain |
Get supported TLDsgetSupportedTlds | GET | Get a list of TLDs supported by Vercel |
Get the auth code for a domaingetDomainAuthCode | GET | Get the auth code for a domain. |
Get TLDgetTld | GET | Get the metadata for a specific TLD. |
Get TLD price datagetTldPrice | GET | Get price data for a specific TLD. |
Renew a domainrenewDomain | POST | Renew a domain |
Transfer-in a domaintransferInDomain | POST | Transfer a domain in from another registrar |
Update auto-renew for a domainupdateDomainAutoRenew | PATCH | Update the auto-renew setting for a domain |
Update nameservers for a domainupdateDomainNameservers | PATCH | Update the nameservers for a domain. |
Drain6
Create a new DraincreateDrain | POST | Create a new Drain with the provided configuration. |
Delete a draindeleteDrain | DELETE | Delete a specific Drain by passing the drain id in the URL. |
Find a Drain by idgetDrain | GET | Get the information for a specific Drain by passing the drain id in the URL. |
Retrieve a list of all DrainsgetDrains | GET | Allows to retrieve the list of Drains of the authenticated team. |
Update an existing DrainupdateDrain | PATCH | Update the configuration of an existing drain. |
Validate Drain delivery configurationtestDrain | POST | Validate the delivery configuration of a Drain using sample events. |
Edge Cache4
Dangerously delete by source imagedangerouslyDeleteBySrcImages | POST | Marks a source image as deleted, causing cache entries associated with that source image to be revalidated in the foreground on the next request. |
Dangerously delete by tagdangerouslyDeleteByTags | POST | Marks a cache tag as deleted, causing cache entries associated with that tag to be revalidated in the foreground on the next request. |
Invalidate by source imageinvalidateBySrcImages | POST | Marks a source image as stale, causing its corresponding transformed images to be revalidated in the background on the next request. |
Invalidate by taginvalidateByTags | POST | Marks a cache tag as stale, causing cache entries associated with that tag to be revalidated in the background on the next request. |
Edge Config18
Create an Edge ConfigcreateEdgeConfig | POST | Creates an Edge Config. |
Create an Edge Config tokencreateEdgeConfigToken | POST | Adds a token to an existing Edge Config. |
Delete an Edge ConfigdeleteEdgeConfig | DELETE | Delete an Edge Config by id. |
Delete an Edge Config's schemadeleteEdgeConfigSchema | DELETE | Deletes the schema of existing Edge Config. |
Delete one or more Edge Config tokensdeleteEdgeConfigTokens | DELETE | Deletes one or more tokens of an existing Edge Config. |
Get all tokens of an Edge ConfiggetEdgeConfigTokens | GET | Returns all tokens of an Edge Config. |
Get an Edge ConfiggetEdgeConfig | GET | Returns an Edge Config. |
Get an Edge Config itemgetEdgeConfigItem | GET | Returns a specific Edge Config Item. |
Get Edge Config backupgetEdgeConfigBackup | GET | Retrieves a specific version of an Edge Config from backup storage. |
Get Edge Config backupsgetEdgeConfigBackups | GET | Returns backups of an Edge Config. |
Get Edge Config itemsgetEdgeConfigItems | GET | Returns all items of an Edge Config. |
Get Edge Config schemagetEdgeConfigSchema | GET | Returns the schema of an Edge Config. |
Get Edge Config token meta datagetEdgeConfigToken | GET | Return meta data about an Edge Config token. |
Get Edge ConfigsgetEdgeConfigs | GET | Returns all Edge Configs. |
Restore Edge Config backuprestoreEdgeConfigBackup | POST | Restores an Edge Config backup. |
Update an Edge ConfigupdateEdgeConfig | PUT | Updates an Edge Config. |
Update Edge Config items in batchpatchEdgeConfigItems | PATCH | Update multiple Edge Config Items in batch. |
Update Edge Config schemapatchEdgeConfigSchema | POST | Update an Edge Config's schema. |
Environment11
Create a custom environment for the current project.createCustomEnvironment | POST | Creates a custom environment for the current project. |
Create one or more shared environment variablescreateSharedEnvVariable | POST | Creates shared environment variable(s) for a team. |
Delete one or more Env VardeleteSharedEnvVariable | DELETE | Deletes one or many Shared Environment Variables for a given team. |
Disconnects a shared environment variable for a given projectunlinkSharedEnvVariable | PATCH | Disconnects a shared environment variable for a given project |
Lists all Shared Environment Variables for a teamlistSharedEnvVariable | GET | Lists all Shared Environment Variables for a team, taking into account optional filters. |
Remove a custom environmentremoveCustomEnvironment | DELETE | Remove a custom environment for the project. |
Retrieve a custom environmentgetCustomEnvironment | GET | Retrieve a custom environment for the project. |
Retrieve custom environmentsgetProjectsByIdOrNameCustomEnvironments | GET | Retrieve custom environments for the project. |
Retrieve the decrypted value of a Shared Environment VariablegetSharedEnvVar | GET | Retrieve the decrypted value of a Shared Environment Variable by id. |
Update a custom environmentupdateCustomEnvironment | PATCH | Update a custom environment for the project. |
Updates one or more shared environment variablesupdateSharedEnvVariable | PATCH | Updates a given Shared Environment Variable for a Team. |
Feature Flag21
Create a flagcreateFlag | PUT | Create a new feature flag for a project. |
Create a segmentcreateFlagSegment | PUT | Create a new feature flag segment. |
Create an SDK keycreateSdkKey | PUT | Creates an SDK key. |
Delete a flagdeleteFlag | DELETE | Permanently delete a feature flag from the project. |
Delete a segmentdeleteFlagSegment | DELETE | Delete a feature flag segment. |
Delete an SDK keydeleteSdkKey | DELETE | Deletes an SDK key. |
Get a flaggetFlag | GET | Retrieve a specific feature flag by its ID or slug. |
Get a segmentgetFlagSegment | GET | Retrieve a feature flag segment by ID or slug. |
Get all SDK keysgetSdkKeys | GET | Gets all SDK keys for a project. |
Get project flag settingsgetFlagSettings | GET | Retrieve feature flag settings for a project. |
List all flags for a teamlistTeamFlags | GET | Retrieve all feature flags for a team across all projects. |
List all flags for a teamlistTeamFlagsV2 | GET | Retrieve all feature flags for a team across all projects. |
List flag versionslistFlagVersions | GET | Lists flag versions for a given flag. |
List flagslistFlags | GET | Retrieve feature flags for a project. |
List flagslistFlagsV2 | GET | Retrieve feature flags for a project. |
List segmentslistFlagSegments | GET | List all feature flag segments for a project. |
List team project flag settingslistTeamFlagSettings | GET | Retrieve feature flag settings for projects in a team. |
Retrieve the feature flags of a deploymentgetDeploymentFeatureFlags | GET | Retrieve the feature flags of a deployment. |
Update a flagupdateFlag | PATCH | Update an existing feature flag. |
Update a segmentupdateFlagSegment | PATCH | Update an existing feature flag segment. |
Update project flag settingsupdateFlagSettings | PATCH | Update feature flag settings for a project. |
Integration9
Connect integration resource to projectconnectIntegrationResourceToProject | POST | Connects an integration resource to a Vercel project. |
Create integration store (free and paid plans)createIntegrationStoreDirect | POST | Creates an integration store with automatic billing plan handling. |
Delete an integration configurationdeleteConfiguration | DELETE | Allows to remove the configuration with the id provided in the parameters. |
Get configurations for the authenticated user or teamgetConfigurations | GET | Allows to retrieve all configurations for an authenticated integration. |
List git namespaces by providergitNamespaces | GET | Lists git namespaces for a supported provider. |
List git repositories linked to namespace by providersearchRepo | GET | Lists git repositories linked to a namespace id for a supported provider. |
List integration billing plansgetBillingPlans | GET | Get a list of billing plans for an integration and product. |
List products for integration configurationgetConfigurationProducts | GET | Returns products available for an integration configuration. |
Retrieve an integration configurationgetConfiguration | GET | Allows to retrieve a the configuration with the provided id in case it exists. |
Log1
Get logs for a deploymentgetRuntimeLogs | GET | Returns a stream of logs for a given deployment. |
LogDrain7
Creates a Configurable Log Drain (deprecated)createConfigurableLogDrain | POST | Creates a configurable log drain. |
Creates a new Integration Log Drain (deprecated)createLogDrain | POST | Creates an Integration log drain. |
Deletes a Configurable Log Drain (deprecated)deleteConfigurableLogDrain | DELETE | Deletes a Configurable Log Drain. |
Deletes the Integration log drain with the provided iddeleteIntegrationLogDrain | DELETE | Deletes the Integration log drain with the provided id. |
Retrieves a Configurable Log Drain (deprecated)getConfigurableLogDrain | GET | Retrieves a Configurable Log Drain. |
Retrieves a list of all the Log Drains (deprecated)getAllLogDrains | GET | Retrieves a list of all the Log Drains owned by the account. |
Retrieves a list of Integration log drains (deprecated)getIntegrationLogDrains | GET | Retrieves a list of all Integration log drains that are defined for the authenticated user or team. |
Marketplace22
Create Eventcreate_event | POST | Partner notifies Vercel of any changes made to an Installation or a Resource. |
Create one or multiple experimentation itemscreateInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItems | POST | Create one or multiple experimentation items |
Delete an existing experimentation itemdeleteInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItemsByItemId | DELETE | Delete an existing experimentation item |
Delete Integration Resourcedelete_integration_resource | DELETE | Delete a resource owned by the selected installation ID. |
Deprecated: true. Update Resource Secrets (Deprecated)update_resource_secrets | PUT | This endpoint is deprecated and replaced with the endpoint Update Resource Secrets. |
Finalize Installationfinalize_installation | POST | This endpoint allows the partner to mark an installation as finalized. |
Get Account Informationget_account_info | GET | Fetches the best account or user’s contact info |
Get Integration Resourceget_integration_resource | GET | Get a resource by its partner ID. |
Get Integration Resourcesget_integration_resources | GET | Get all resources for a given installation ID. |
Get Invoiceget_invoice | GET | Get Invoice details and status for a given invoice ID. |
Get Member Informationget_member | GET | Returns the member role and other information for a given member ID ("user id" claim in the SSO OIDC token). |
Get the data of a user-provided Edge ConfiggetInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationEdgeConfig | GET | When the user enabled Edge Config syncing, then this endpoint can be used by the partner to fetch the contents of the Edge Config. |
Import Resourceimport_resource | PUT | This endpoint imports (upserts) a resource to Vercel's installation. |
Invoice Actionsupdate_invoice | POST | This endpoint allows the partner to request a refund for an invoice to Vercel. |
Patch an existing experimentation itemupdateInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItemsByItemId | PATCH | Patch an existing experimentation item |
Push data into a user-provided Edge ConfigreplaceInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationEdgeConfig | PUT | When the user enabled Edge Config syncing, then this endpoint can be used by the partner to push their configuration data into the relevant Edge Config. |
Submit Billing Datasubmit_billing_data | POST | Sends the billing and usage data. |
Submit Invoicesubmit_invoice | POST | This endpoint allows the partner to submit an invoice to Vercel. |
Submit Prepayment Balancessubmit_prepayment_balances | POST | Sends the prepayment balances. |
Update Installationupdate_installation | PATCH | This endpoint updates an integration installation. |
Update Resourceupdate_resource | PATCH | This endpoint updates an existing resource in the installation. |
Update Resource Secretsupdate_resource_secrets_by_id | PUT | This endpoint updates the secrets of a resource. |
Microfrontend5
Create a microfrontends group with applicationscreateMicrofrontendsGroupWithApplications | POST | Creates a microfrontends group and attaches multiple projects in a single request. |
Get microfrontends config for a deploymentgetMicrofrontendsConfig | GET | Get the microfrontends config for a deployment. |
Get microfrontends config for a projectgetMicrofrontendsConfigForProject | GET | Get the microfrontends config for a project by ID or name. |
List microfrontends groupsgetMicrofrontendsGroups | GET | Get the microfrontends group IDs for a team. |
List projects in a microfrontends groupgetMicrofrontendsInGroup | GET | Get the microfrontends for a given group ID. |
Networking6
Configures Static IPs for a projectupdateStaticIps | PATCH | Allows configuring Static IPs for a project |
Create a Secure Compute networkcreateNetwork | POST | Allows to create a Secure Compute network. |
Delete a Secure Compute networkdeleteNetwork | DELETE | Allows to delete a Secure Compute network. |
List Secure Compute networkslistNetworks | GET | Allows to list Secure Compute networks. |
Read a Secure Compute networkreadNetwork | GET | Allows to read a Secure Compute network. |
Update a Secure Compute networkupdateNetwork | PATCH | Allows to update a Secure Compute network. |
Project29
Accept project transfer requestacceptProjectTransferRequest | PUT | Accept a project transfer request initated by another team. |
Add a domain to a projectaddProjectDomain | POST | Add a domain to the project by passing its domain name and by specifying the project by either passing the project id or name in the URL. |
Batch remove environment variablesbatchRemoveProjectEnv | DELETE | Delete multiple environment variables for a given project in a single batch operation. |
Create a new projectcreateProject | POST | Allows to create a new project with the provided configuration. |
Create one or more environment variablescreateProjectEnv | POST | Create one or more environment variables for a project by passing its key, value, type and target and by specifying the project by either passing the project id or name in the URL. |
Create project transfer requestcreateProjectTransferRequest | POST | Initiates a project transfer request from one team to another. |
Delete a ProjectdeleteProject | DELETE | Delete a specific project by passing either the project id or name in the URL. |
Edit an environment variableeditProjectEnv | PATCH | Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL. |
Find a project by id or namegetProject | GET | Get the information for a specific project by passing either the project id or name in the URL. |
Get a project domaingetProjectDomain | GET | Get project domain by project id/name and domain name. |
Gets a list of aliases with status for the current promotelistPromoteAliases | GET | Get a list of aliases related to the last promote request with their mapping status |
Move a project domainmoveProjectDomain | POST | Move one project's domain to another project. |
Pause a projectpauseProject | POST | Pause a project by passing its project id in the URL. |
Point production traffic to a given deploymentrequestPromote | POST | Allows users to promote a deployment to production. |
Point production traffic to a previous production deployment byrequestRollback | POST | Allows users to rollback to a deployment. |
Remove a domain from a projectremoveProjectDomain | DELETE | Remove a domain from a project by passing the domain name and by specifying the project by either passing the project id or name in the URL. |
Remove an environment variableremoveProjectEnv | DELETE | Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL. |
Retrieve a list of projectsgetProjects | GET | Allows to retrieve the list of projects of the authenticated user or team. |
Retrieve project domains by project by id or namegetProjectDomains | GET | Retrieve the domains associated with a given project by passing either the project id or name in the URL. |
Retrieve the decrypted value of an environment variable of agetProjectEnv | GET | Retrieve the environment variable for a given project. |
Retrieve the environment variables of a project by id or namefilterProjectEnvs | GET | Retrieve the environment variables for a given project by passing either the project id or name in the URL. |
Unpause a projectunpauseProject | POST | Unpause a project by passing its project id in the URL. |
Update a project domainupdateProjectDomain | PATCH | Update a project domain's configuration, including the name, git branch and redirect of the domain. |
Update an existing projectupdateProject | PATCH | Update the fields of a project using either its name or id. |
Update Protection Bypass for AutomationupdateProjectProtectionBypass | PATCH | Update the deployment protection automation bypass for a project |
Update the microfrontends settingsupdateMicrofrontends | PATCH | Update the microfrontends settings for a project. |
Updates the description for a rollbackupdateProjectsByProjectIdRollbackByDeploymentIdUpdateDescription | PATCH | Updates the reason for a rollback, without changing the rollback status itself. |
Upload a project avataruploadProjectAvatar | POST | Upload an image as the avatar of the project identified by idOrName. |
Verify project domainverifyProjectDomain | POST | Attempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge. |
Project Route8
Add a routing ruleaddRoute | POST | Add a single routing rule to a project at a specified position. |
Delete routing rulesdeleteRoutes | DELETE | Delete one or more routing rules from a project by ID. |
Edit a routing ruleeditRoute | PATCH | Replace a routing rule identified by its ID, or restore it from the current production version. |
Generate a routing rule from natural languagegenerateRoute | POST | Generate a routing rule configuration from a natural language description. |
Get project routing rulesgetRoutes | GET | Get the routing rules for a project. |
Get routing rule version historygetRouteVersions | GET | Get the version history for a project's routing rules. |
Promote, restore, or discard a routing rule versionupdateRouteVersions | POST | Promote staged routing rules to production, restore a previous production version, or discard staged changes. |
Stage routing rulesstageRoutes | PUT | Stage routing rules for a project. |
ProjectMember3
Adds a new member to a project.addProjectMember | POST | Adds a new member to the project. |
List project membersgetProjectMembers | GET | Lists all members of a project. |
Remove a Project MemberremoveProjectMember | DELETE | Remove a member from a specific project |
Rolling Release8
Complete the rolling release for the projectcompleteRollingRelease | POST | Force-complete a Rolling Release. |
Delete rolling release configurationdeleteRollingReleaseConfig | DELETE | Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. |
Get rolling release billing statusgetRollingReleaseBillingStatus | GET | Get the Rolling Releases billing status for a project. |
Get rolling release configurationgetRollingReleaseConfig | GET | Get the Rolling Releases configuration for a project. |
Get the active rolling release information for a projectgetRollingRelease | GET | Return the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed. |
Start a rolling release for the projectstartRollingRelease | POST | Start a rolling release for a deployment. |
Update the active rolling release to the next stage for aapproveRollingReleaseStage | POST | Advance a rollout to the next stage. |
Update the rolling release settings for the projectupdateRollingReleaseConfig | PATCH | Update (or disable) Rolling Releases for a project. |
Sandbox25
Create a directorycreateSessionDirectory | POST | Creates a new directory in a session's filesystem. |
Create a named sandboxcreateSandboxes | POST | Creates a named sandbox environment. |
Create a snapshotcreateSessionSnapshot | POST | Creates a point-in-time snapshot of a running session's filesystem. |
Delete a drivedeleteDrive | DELETE | Deletes a drive by project and name. |
Delete a sandboxdeleteSandbox | DELETE | Deletes a sandbox by name. |
Delete a snapshotdeleteSessionSnapshot | DELETE | Permanently deletes a snapshot and frees its associated storage. |
Execute a commandrunSessionCommand | POST | Executes a shell command inside a running session. |
Extend session timeoutextendSessionTimeout | POST | Extends the maximum execution time of a running session. |
Get a commandgetSessionCommand | GET | Retrieves the current status and details of a command executed in a session. |
Get a named sandboxgetNamedSandbox | GET | Retrieves a named sandbox by name, including its current sandbox and routes. |
Get a sessiongetSession | GET | Retrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes. |
Get a snapshotgetSessionSnapshot | GET | Retrieves detailed information about a specific snapshot, including its creation time, size, expiration date, and the source session it was created from. |
Get or create a drivegetOrCreateDrive | POST | Gets an existing drive by project and name, or creates it when it does not exist. |
Kill a commandkillSessionCommand | POST | Sends a signal to terminate a running command in a session. |
List commandslistSessionCommands | GET | Retrieves a list of all commands that have been executed in a session, including their current status, exit codes, and execution times, ordered from the most recent to the oldest. |
List driveslistDrives | GET | Retrieves a paginated list of drives belonging to a specific project. |
List sandboxeslistSandboxes | GET | Retrieves a paginated list of named sandboxes belonging to a specific project. |
List sessionslistSessions | GET | Retrieves a paginated list of sessions belonging to a specific sandbox. |
List snapshotslistSessionSnapshots | GET | Retrieves a paginated list of snapshots for a specific project. |
Read a filereadSessionFile | POST | Downloads the contents of a file from a session's filesystem. |
Stop a sessionstopSession | POST | Stops a running session and releases its allocated resources. |
Stream command logsgetSessionCommandLogs | GET | Streams the output of a command in real-time using newline-delimited JSON (ND-JSON). |
Update a sandboxupdateSandbox | PATCH | Updates the configuration of a sandbox. |
Update network policyupdateSessionNetworkPolicy | POST | Replaces the network access policy of a running session. |
Write fileswriteSessionFiles | POST | Uploads and extracts files to a session's filesystem. |
Security9
Create System Bypass RuleaddBypassIp | POST | Create new system bypass rules |
Put Firewall ConfigurationputFirewallConfig | PUT | Set the firewall configuration to provided rules and settings. |
Read active attack datagetActiveAttackStatus | GET | Retrieve active attack data within the last N days (default: 1 day) |
Read Firewall Actions by ProjectgetSecurityFirewallEvents | GET | Retrieve firewall actions for a project |
Read Firewall ConfigurationgetFirewallConfig | GET | Retrieve the specified firewall configuration for a project. |
Read System BypassgetBypassIp | GET | Retrieve the system bypass rules configured for the specified project |
Remove System Bypass RuleremoveBypassIp | DELETE | Remove system bypass rules |
Update Attack Challenge modeupdateAttackChallengeMode | POST | Update the setting for determining if the project has Attack Challenge mode enabled. |
Update Firewall ConfigurationupdateFirewallConfig | PATCH | Process updates to modify the existing firewall config for a project |
Team16
Create a TeamcreateTeam | POST | Create a new Team under your account. |
Delete a microfrontends groupdeleteMicrofrontendsGroup | DELETE | Deletes a microfrontends group from the team associated with the group ID. |
Delete a TeamdeleteTeam | DELETE | Delete a team under your account. |
Delete a Team invite codedeleteTeamInviteCode | DELETE | Delete an active Team invite code. |
Get a TeamgetTeam | GET | Get information for the Team specified by the teamId parameter. |
Get access request statusgetTeamAccessRequest | GET | Check the status of a join request. |
Invite a userinviteUserToTeam | POST | Invite a user to join the team specified in the URL. |
Join a teamjoinTeam | POST | Join a team with a provided invite code or team ID. |
List all teamsgetTeams | GET | Get a paginated list of all the Teams the authenticated User is a member of. |
List team membersgetTeamMembers | GET | Get a paginated list of team members for the provided team. |
Remove a Team MemberremoveTeamMember | DELETE | Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. |
Request access to a teamrequestAccessToTeam | POST | Request access to a team as a member. |
Update a microfrontends groupupdateMicrofrontendsGroup | PATCH | Updates the name (and slug) of a microfrontends group. |
Update a TeampatchTeam | PATCH | Update the information of a Team specified by the teamId parameter. |
Update a Team MemberupdateTeamMember | PATCH | Update the membership of a Team Member on the Team specified by teamId, such as changing the role of the member, or confirming a request to join the Team for an unconfirmed member. |
Update Team Directory Sync Role MappingspostTeamDsyncRoles | POST | Update the Directory Sync role mappings for a Team. |
User4
Delete User AccountrequestDelete | DELETE | Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. |
Get the UsergetAuthUser | GET | Retrieves information related to the currently authenticated User. |
List Event TypeslistEventTypes | GET | Returns the list of user-facing event types with descriptions. |
List User EventslistUserEvents | GET | Retrieves a list of "events" generated by the User on Vercel. |
Vcr9
Create a repositorycreateRepository | POST | Create a container registry repository for a project. |
Delete a repositorydeleteRepository | DELETE | Schedule a repository for deletion. |
Delete a repository imagedeleteRepositoryImage | DELETE | Schedule an image for deletion. |
Get a repositorygetRepository | GET | Fetch a container registry repository for a project by ID or name. |
Get a repository imagegetRepositoryImage | GET | Fetch an individual image from a repository, including its tags and Dockerfile history entries with discriminated layer details for UI rendering. |
Get a repository taggetRepositoryTag | GET | Fetch a single tag from a repository, including the backing image's metadata and VHS-readiness status. |
List repositorieslistRepositories | GET | List container registry repositories for a project. |
List repository imageslistRepositoryImages | GET | List images for a container registry repository, including their tags. |
List repository tagslistRepositoryTags | GET | List a repository's tags. |
Web Analytic4
Aggregates custom eventsaggregateEvents | GET | Counts custom events on a project, within the requested date range. |
Aggregates page viewsaggregatePageviews | GET | Counts pageviews on a project, within the requested date range. |
Counts custom eventscountEvents | GET | Counts the number of custom events on a project (production only), since Web Analytics was enabled. |
Counts page viewscountPageviews | GET | Counts the number of page views on a project (production only), since Web Analytics was enabled. |
Webhook4
Creates a webhookcreateWebhook | POST | Creates a webhook |
Deletes a webhookdeleteWebhook | DELETE | Deletes a webhook |
Get a list of webhooksgetWebhooks | GET | Get a list of webhooks |
Get a webhookgetWebhook | GET | Get a webhook |