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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Vercel and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Access tokenRequiredSecret

Use it in a flow

  1. Open a flow, open the node library and search for Vercel.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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 projectcreateAccessGroupProjectPOSTAllows creation of an access group project
Creates an access groupcreateAccessGroupPOSTAllows to create an access group
Delete an access group projectdeleteAccessGroupProjectDELETEAllows deletion of an access group project
Deletes an access groupdeleteAccessGroupDELETEAllows to delete an access group
List access groups for a team, project or memberlistAccessGroupsGETList access groups
List members of an access grouplistAccessGroupMembersGETList members of an access group
List projects of an access grouplistAccessGroupProjectsGETList projects of an access group
Reads an access groupreadAccessGroupGETAllows to read an access group
Reads an access group projectreadAccessGroupProjectGETAllows reading an access group project
Update an access groupupdateAccessGroupPOSTAllows to update an access group metadata
Update an access group projectupdateAccessGroupProjectPATCHAllows update of an access group project
Aliase6
Assign an AliasassignAliasPOSTCreates a new alias for the deployment resolved from the given deployment or alias ID or URL.
Delete an AliasdeleteAliasDELETEDelete an Alias with the specified ID.
Get an AliasgetAliasGETRetrieves an Alias for the given host name or alias ID.
List aliaseslistAliasesGETRetrieves a list of aliases for the authenticated User or Team.
List Deployment AliaseslistDeploymentAliasesGETRetrieves all Aliases for the Deployment with the given ID.
Update the protection bypass for a URLpatchUrlProtectionBypassPATCHUpdate the protection bypass for the alias or deployment URL (used for user access & comment access for deployments).
Api Observability2
Lists disabled Observability Plus projectsgetObservabilityConfigurationProjectsGETLists the projects that are currently configured as disabled for Observability Plus on a team.
Updates a disabled Observability Plus project settingupdateObservabilityConfigurationProjectPUTUpdates whether Observability Plus is disabled for a single project.
Artifact6
Delete all cache artifactsdeleteAllArtifactsDELETEDeletes all cache artifacts stored for the authenticated team or user, clearing the Remote Cache.
Download a cache artifactdownloadArtifactGETDownloads a cache artifact indentified by its hash specified on the request path.
Get status of Remote Caching for this principalstatusGETCheck the status of Remote Caching for this principal.
Query information about an artifactartifactQueryPOSTQuery information about an array of artifacts.
Record an artifacts cache usage eventrecordEventsPOSTRecords an artifacts cache usage event.
Upload a cache artifactuploadArtifactPUTUploads a cache artifact identified by the hash specified on the path.
Authentication5
Create an Auth TokencreateAuthTokenPOSTCreates and returns a new authentication token for the currently authenticated User.
Delete an authentication tokendeleteAuthTokenDELETEInvalidate an authentication token, such that it will no longer be valid for future HTTP requests.
Get Auth Token MetadatagetAuthTokenGETRetrieve metadata about an authentication token belonging to the currently authenticated User.
List Auth TokenslistAuthTokensGETRetrieve a list of the current User's authentication tokens.
SSO Token Exchangeexchange_sso_tokenPOSTDuring the autorization process, Vercel sends the user to the provider redirectLoginUrl, that includes the OAuth authorization code parameter.
Billing3
List FOCUS billing chargeslistBillingChargesGETReturns 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 commitmentslistContractCommitmentsGETReturns commitment allocations per contract period in FOCUS v1.3 JSONL format for a specified Vercel team.
Purchase creditsbuyCreditsPOSTPurchases credits for a Vercel team using the default payment method on file.
Bulk Redirect7
Delete project-level redirects.deleteRedirectsDELETEDeletes the provided redirects from the latest version of the projects' bulk redirects.
Edit a project-level redirect.editRedirectPATCHEdits a single redirect identified by its source path.
Get the version history for a project's redirects.getVersionsGETGet the version history for a project's bulk redirects
Gets project-level redirects.getRedirectsGETGet the version history for a project's bulk redirects
Promote a staging version to production or restore a previousupdateVersionPOSTUpdate a version by promoting staging to production or restoring a previous production version
Restore staged project-level redirects to their productionrestoreRedirectsPOSTRestores the provided redirects in the staging version to the value in the production version.
Stages new redirects for a project.stageRedirectsPUTStages new redirects for a project and returns the new version.
Cert4
Get cert by idgetCertByIdGETGet cert by id
Issue a new certissueCertPOSTIssue a new cert
Remove certremoveCertDELETERemove cert
Upload a certuploadCertPUTUpload a cert
Check5
Creates a new CheckcreateCheckPOSTCreates a new check.
Get a single checkgetCheckGETReturn a detailed response for a single check.
Rerequest a checkrerequestCheckPOSTRerequest a selected check that has failed.
Retrieve a list of all checksgetAllChecksGETList all of the checks created for a deployment.
Update a checkupdateCheckPATCHUpdate an existing check.
Checks V210
Create a checkcreateProjectCheckPOSTCreates a new check for a project.
Create a check runcreateDeploymentCheckRunPOSTCreates a new check run for a deployment.
Delete a checkdeleteProjectCheckDELETEDelete an existing check and all of its runs.
Get a checkgetProjectCheckGETReturn a detailed response for a single check.
Get a check rungetDeploymentCheckRunGETReturn a detailed response for a single check run.
List all checks for a projectlistProjectChecksGETList all checks for a project, optionally filtered by target.
List check runs for a deploymentlistDeploymentCheckRunsGETList all check runs for a deployment.
List runs for a checklistCheckRunsGETList all runs associated with a given check.
Update a checkupdateProjectCheckPATCHUpdate an existing check.
Update a check runupdateDeploymentCheckRunPATCHUpdate an existing check run for a deployment.
Connect4
Create a Connect authorization requestcreateConnectorAuthorizationRequestPOSTCreate an authorization request for a connector and return the URL and verifier details needed to complete the flow.
Create a connectorcreateConnectorPOSTCreate a connector from type-specific configuration and optionally link it to a project during creation.
Get a Connect tokengetConnectorTokenPOSTGet an access token for a connector identified by the path parameter and scoped to the requester.
Import Connect tokensimportConnectorTokensPOSTImport access and refresh tokens for a connector identified by the path parameter.
Deployment10
Cancel a deploymentcancelDeploymentPATCHCancels a deployment that is currently in progress, stopping the build before it completes.
Create a new deploymentcreateDeploymentPOSTCreates a new deployment for the authenticated team or user.
Delete a DeploymentdeleteDeploymentDELETEThis 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 URLgetDeploymentGETRetrieves information for a deployment either by supplying its ID (id property) or Hostname (url property).
Get deployment eventsgetDeploymentEventsGETGet the build logs of a deployment by deployment ID and build ID.
Get Deployment File ContentsgetDeploymentFileContentsGETAllows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier.
List Deployment FileslistDeploymentFilesGETAllows to retrieve the file structure of the source code of a deployment by supplying the deployment unique identifier.
List deploymentsgetDeploymentsGETList deployments under the authenticated user or team.
Update deployment integration actionupdate_integration_deployment_actionPATCHUpdates the deployment integration action for the specified integration installation
Upload Deployment FilesuploadFilePOSTBefore you create a deployment you need to upload the required files for that deployment.
Dn4
Create a DNS recordcreateRecordPOSTCreates a DNS record for a domain.
Delete a DNS recordremoveRecordDELETERemoves an existing DNS record from a domain name.
List existing DNS recordsgetRecordsGETRetrieves a list of DNS records created for a domain name.
Update an existing DNS recordupdateRecordPATCHUpdates an existing DNS record for a domain name.
Domain9
Add an existing domain to the Vercel platformcreateOrTransferDomainPOSTThis endpoint is used for adding a new apex domain name with Vercel for the authenticating user.
Claim Domain OwnershipclaimDomainOwnershipPOSTClaim ownership of a domain for the authenticated team by verifying a TXT record.
Get a Domain's configurationgetDomainConfigGETGet a Domain's configuration.
Get Domain Verification RecordgetDomainVerificationRecordGETGet the TXT verification record needed to claim ownership of a domain for the authenticated team.
Get Information for a Single DomaingetDomainGETGet information for a single domain in an account or team.
List all the domainsgetDomainsGETRetrieves a list of domains registered for the authenticated user or team.
List Project Domains by Apex DomaingetDomainProjectDomainsGETList all project domains associated with an apex domain owned by the authenticated account.
Remove a domain by namedeleteDomainDELETEDelete a previously registered domain name from Vercel.
Update or move apex domainpatchDomainPATCHUpdate or move apex domain.
Domains Registrar17
Buy a domainbuySingleDomainPOSTBuy a domain
Buy multiple domainsbuyDomainsPOSTBuy multiple domains at once
Get a domain ordergetOrderGETGet information about a domain order by its ID
Get a domain's transfer statusgetDomainTransferInGETGet the transfer status for a domain
Get availability for a domaingetDomainAvailabilityGETGet availability for a specific domain.
Get availability for multiple domainsgetBulkAvailabilityPOSTGet availability for multiple domains.
Get contact info schemagetContactInfoSchemaGETSome TLDs require additional contact information.
Get contact verification status for a domaingetDomainContactVerificationGETGet the registrant contact verification status for a domain.
Get price data for a domaingetDomainPriceGETGet price data for a specific domain
Get supported TLDsgetSupportedTldsGETGet a list of TLDs supported by Vercel
Get the auth code for a domaingetDomainAuthCodeGETGet the auth code for a domain.
Get TLDgetTldGETGet the metadata for a specific TLD.
Get TLD price datagetTldPriceGETGet price data for a specific TLD.
Renew a domainrenewDomainPOSTRenew a domain
Transfer-in a domaintransferInDomainPOSTTransfer a domain in from another registrar
Update auto-renew for a domainupdateDomainAutoRenewPATCHUpdate the auto-renew setting for a domain
Update nameservers for a domainupdateDomainNameserversPATCHUpdate the nameservers for a domain.
Drain6
Create a new DraincreateDrainPOSTCreate a new Drain with the provided configuration.
Delete a draindeleteDrainDELETEDelete a specific Drain by passing the drain id in the URL.
Find a Drain by idgetDrainGETGet the information for a specific Drain by passing the drain id in the URL.
Retrieve a list of all DrainsgetDrainsGETAllows to retrieve the list of Drains of the authenticated team.
Update an existing DrainupdateDrainPATCHUpdate the configuration of an existing drain.
Validate Drain delivery configurationtestDrainPOSTValidate the delivery configuration of a Drain using sample events.
Edge Cache4
Dangerously delete by source imagedangerouslyDeleteBySrcImagesPOSTMarks 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 tagdangerouslyDeleteByTagsPOSTMarks 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 imageinvalidateBySrcImagesPOSTMarks a source image as stale, causing its corresponding transformed images to be revalidated in the background on the next request.
Invalidate by taginvalidateByTagsPOSTMarks 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 ConfigcreateEdgeConfigPOSTCreates an Edge Config.
Create an Edge Config tokencreateEdgeConfigTokenPOSTAdds a token to an existing Edge Config.
Delete an Edge ConfigdeleteEdgeConfigDELETEDelete an Edge Config by id.
Delete an Edge Config's schemadeleteEdgeConfigSchemaDELETEDeletes the schema of existing Edge Config.
Delete one or more Edge Config tokensdeleteEdgeConfigTokensDELETEDeletes one or more tokens of an existing Edge Config.
Get all tokens of an Edge ConfiggetEdgeConfigTokensGETReturns all tokens of an Edge Config.
Get an Edge ConfiggetEdgeConfigGETReturns an Edge Config.
Get an Edge Config itemgetEdgeConfigItemGETReturns a specific Edge Config Item.
Get Edge Config backupgetEdgeConfigBackupGETRetrieves a specific version of an Edge Config from backup storage.
Get Edge Config backupsgetEdgeConfigBackupsGETReturns backups of an Edge Config.
Get Edge Config itemsgetEdgeConfigItemsGETReturns all items of an Edge Config.
Get Edge Config schemagetEdgeConfigSchemaGETReturns the schema of an Edge Config.
Get Edge Config token meta datagetEdgeConfigTokenGETReturn meta data about an Edge Config token.
Get Edge ConfigsgetEdgeConfigsGETReturns all Edge Configs.
Restore Edge Config backuprestoreEdgeConfigBackupPOSTRestores an Edge Config backup.
Update an Edge ConfigupdateEdgeConfigPUTUpdates an Edge Config.
Update Edge Config items in batchpatchEdgeConfigItemsPATCHUpdate multiple Edge Config Items in batch.
Update Edge Config schemapatchEdgeConfigSchemaPOSTUpdate an Edge Config's schema.
Environment11
Create a custom environment for the current project.createCustomEnvironmentPOSTCreates a custom environment for the current project.
Create one or more shared environment variablescreateSharedEnvVariablePOSTCreates shared environment variable(s) for a team.
Delete one or more Env VardeleteSharedEnvVariableDELETEDeletes one or many Shared Environment Variables for a given team.
Disconnects a shared environment variable for a given projectunlinkSharedEnvVariablePATCHDisconnects a shared environment variable for a given project
Lists all Shared Environment Variables for a teamlistSharedEnvVariableGETLists all Shared Environment Variables for a team, taking into account optional filters.
Remove a custom environmentremoveCustomEnvironmentDELETERemove a custom environment for the project.
Retrieve a custom environmentgetCustomEnvironmentGETRetrieve a custom environment for the project.
Retrieve custom environmentsgetProjectsByIdOrNameCustomEnvironmentsGETRetrieve custom environments for the project.
Retrieve the decrypted value of a Shared Environment VariablegetSharedEnvVarGETRetrieve the decrypted value of a Shared Environment Variable by id.
Update a custom environmentupdateCustomEnvironmentPATCHUpdate a custom environment for the project.
Updates one or more shared environment variablesupdateSharedEnvVariablePATCHUpdates a given Shared Environment Variable for a Team.
Feature Flag21
Create a flagcreateFlagPUTCreate a new feature flag for a project.
Create a segmentcreateFlagSegmentPUTCreate a new feature flag segment.
Create an SDK keycreateSdkKeyPUTCreates an SDK key.
Delete a flagdeleteFlagDELETEPermanently delete a feature flag from the project.
Delete a segmentdeleteFlagSegmentDELETEDelete a feature flag segment.
Delete an SDK keydeleteSdkKeyDELETEDeletes an SDK key.
Get a flaggetFlagGETRetrieve a specific feature flag by its ID or slug.
Get a segmentgetFlagSegmentGETRetrieve a feature flag segment by ID or slug.
Get all SDK keysgetSdkKeysGETGets all SDK keys for a project.
Get project flag settingsgetFlagSettingsGETRetrieve feature flag settings for a project.
List all flags for a teamlistTeamFlagsGETRetrieve all feature flags for a team across all projects.
List all flags for a teamlistTeamFlagsV2GETRetrieve all feature flags for a team across all projects.
List flag versionslistFlagVersionsGETLists flag versions for a given flag.
List flagslistFlagsGETRetrieve feature flags for a project.
List flagslistFlagsV2GETRetrieve feature flags for a project.
List segmentslistFlagSegmentsGETList all feature flag segments for a project.
List team project flag settingslistTeamFlagSettingsGETRetrieve feature flag settings for projects in a team.
Retrieve the feature flags of a deploymentgetDeploymentFeatureFlagsGETRetrieve the feature flags of a deployment.
Update a flagupdateFlagPATCHUpdate an existing feature flag.
Update a segmentupdateFlagSegmentPATCHUpdate an existing feature flag segment.
Update project flag settingsupdateFlagSettingsPATCHUpdate feature flag settings for a project.
Integration9
Connect integration resource to projectconnectIntegrationResourceToProjectPOSTConnects an integration resource to a Vercel project.
Create integration store (free and paid plans)createIntegrationStoreDirectPOSTCreates an integration store with automatic billing plan handling.
Delete an integration configurationdeleteConfigurationDELETEAllows to remove the configuration with the id provided in the parameters.
Get configurations for the authenticated user or teamgetConfigurationsGETAllows to retrieve all configurations for an authenticated integration.
List git namespaces by providergitNamespacesGETLists git namespaces for a supported provider.
List git repositories linked to namespace by providersearchRepoGETLists git repositories linked to a namespace id for a supported provider.
List integration billing plansgetBillingPlansGETGet a list of billing plans for an integration and product.
List products for integration configurationgetConfigurationProductsGETReturns products available for an integration configuration.
Retrieve an integration configurationgetConfigurationGETAllows to retrieve a the configuration with the provided id in case it exists.
Log1
Get logs for a deploymentgetRuntimeLogsGETReturns a stream of logs for a given deployment.
LogDrain7
Creates a Configurable Log Drain (deprecated)createConfigurableLogDrainPOSTCreates a configurable log drain.
Creates a new Integration Log Drain (deprecated)createLogDrainPOSTCreates an Integration log drain.
Deletes a Configurable Log Drain (deprecated)deleteConfigurableLogDrainDELETEDeletes a Configurable Log Drain.
Deletes the Integration log drain with the provided iddeleteIntegrationLogDrainDELETEDeletes the Integration log drain with the provided id.
Retrieves a Configurable Log Drain (deprecated)getConfigurableLogDrainGETRetrieves a Configurable Log Drain.
Retrieves a list of all the Log Drains (deprecated)getAllLogDrainsGETRetrieves a list of all the Log Drains owned by the account.
Retrieves a list of Integration log drains (deprecated)getIntegrationLogDrainsGETRetrieves a list of all Integration log drains that are defined for the authenticated user or team.
Marketplace22
Create Eventcreate_eventPOSTPartner notifies Vercel of any changes made to an Installation or a Resource.
Create one or multiple experimentation itemscreateInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItemsPOSTCreate one or multiple experimentation items
Delete an existing experimentation itemdeleteInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItemsByItemIdDELETEDelete an existing experimentation item
Delete Integration Resourcedelete_integration_resourceDELETEDelete a resource owned by the selected installation ID.
Deprecated: true. Update Resource Secrets (Deprecated)update_resource_secretsPUTThis endpoint is deprecated and replaced with the endpoint Update Resource Secrets.
Finalize Installationfinalize_installationPOSTThis endpoint allows the partner to mark an installation as finalized.
Get Account Informationget_account_infoGETFetches the best account or user’s contact info
Get Integration Resourceget_integration_resourceGETGet a resource by its partner ID.
Get Integration Resourcesget_integration_resourcesGETGet all resources for a given installation ID.
Get Invoiceget_invoiceGETGet Invoice details and status for a given invoice ID.
Get Member Informationget_memberGETReturns 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 ConfiggetInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationEdgeConfigGETWhen 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_resourcePUTThis endpoint imports (upserts) a resource to Vercel's installation.
Invoice Actionsupdate_invoicePOSTThis endpoint allows the partner to request a refund for an invoice to Vercel.
Patch an existing experimentation itemupdateInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationItemsByItemIdPATCHPatch an existing experimentation item
Push data into a user-provided Edge ConfigreplaceInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationEdgeConfigPUTWhen 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_dataPOSTSends the billing and usage data.
Submit Invoicesubmit_invoicePOSTThis endpoint allows the partner to submit an invoice to Vercel.
Submit Prepayment Balancessubmit_prepayment_balancesPOSTSends the prepayment balances.
Update Installationupdate_installationPATCHThis endpoint updates an integration installation.
Update Resourceupdate_resourcePATCHThis endpoint updates an existing resource in the installation.
Update Resource Secretsupdate_resource_secrets_by_idPUTThis endpoint updates the secrets of a resource.
Microfrontend5
Create a microfrontends group with applicationscreateMicrofrontendsGroupWithApplicationsPOSTCreates a microfrontends group and attaches multiple projects in a single request.
Get microfrontends config for a deploymentgetMicrofrontendsConfigGETGet the microfrontends config for a deployment.
Get microfrontends config for a projectgetMicrofrontendsConfigForProjectGETGet the microfrontends config for a project by ID or name.
List microfrontends groupsgetMicrofrontendsGroupsGETGet the microfrontends group IDs for a team.
List projects in a microfrontends groupgetMicrofrontendsInGroupGETGet the microfrontends for a given group ID.
Networking6
Configures Static IPs for a projectupdateStaticIpsPATCHAllows configuring Static IPs for a project
Create a Secure Compute networkcreateNetworkPOSTAllows to create a Secure Compute network.
Delete a Secure Compute networkdeleteNetworkDELETEAllows to delete a Secure Compute network.
List Secure Compute networkslistNetworksGETAllows to list Secure Compute networks.
Read a Secure Compute networkreadNetworkGETAllows to read a Secure Compute network.
Update a Secure Compute networkupdateNetworkPATCHAllows to update a Secure Compute network.
Project29
Accept project transfer requestacceptProjectTransferRequestPUTAccept a project transfer request initated by another team.
Add a domain to a projectaddProjectDomainPOSTAdd 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 variablesbatchRemoveProjectEnvDELETEDelete multiple environment variables for a given project in a single batch operation.
Create a new projectcreateProjectPOSTAllows to create a new project with the provided configuration.
Create one or more environment variablescreateProjectEnvPOSTCreate 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 requestcreateProjectTransferRequestPOSTInitiates a project transfer request from one team to another.
Delete a ProjectdeleteProjectDELETEDelete a specific project by passing either the project id or name in the URL.
Edit an environment variableeditProjectEnvPATCHEdit 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 namegetProjectGETGet the information for a specific project by passing either the project id or name in the URL.
Get a project domaingetProjectDomainGETGet project domain by project id/name and domain name.
Gets a list of aliases with status for the current promotelistPromoteAliasesGETGet a list of aliases related to the last promote request with their mapping status
Move a project domainmoveProjectDomainPOSTMove one project's domain to another project.
Pause a projectpauseProjectPOSTPause a project by passing its project id in the URL.
Point production traffic to a given deploymentrequestPromotePOSTAllows users to promote a deployment to production.
Point production traffic to a previous production deployment byrequestRollbackPOSTAllows users to rollback to a deployment.
Remove a domain from a projectremoveProjectDomainDELETERemove 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 variableremoveProjectEnvDELETEDelete 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 projectsgetProjectsGETAllows to retrieve the list of projects of the authenticated user or team.
Retrieve project domains by project by id or namegetProjectDomainsGETRetrieve 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 agetProjectEnvGETRetrieve the environment variable for a given project.
Retrieve the environment variables of a project by id or namefilterProjectEnvsGETRetrieve the environment variables for a given project by passing either the project id or name in the URL.
Unpause a projectunpauseProjectPOSTUnpause a project by passing its project id in the URL.
Update a project domainupdateProjectDomainPATCHUpdate a project domain's configuration, including the name, git branch and redirect of the domain.
Update an existing projectupdateProjectPATCHUpdate the fields of a project using either its name or id.
Update Protection Bypass for AutomationupdateProjectProtectionBypassPATCHUpdate the deployment protection automation bypass for a project
Update the microfrontends settingsupdateMicrofrontendsPATCHUpdate the microfrontends settings for a project.
Updates the description for a rollbackupdateProjectsByProjectIdRollbackByDeploymentIdUpdateDescriptionPATCHUpdates the reason for a rollback, without changing the rollback status itself.
Upload a project avataruploadProjectAvatarPOSTUpload an image as the avatar of the project identified by idOrName.
Verify project domainverifyProjectDomainPOSTAttempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge.
Project Route8
Add a routing ruleaddRoutePOSTAdd a single routing rule to a project at a specified position.
Delete routing rulesdeleteRoutesDELETEDelete one or more routing rules from a project by ID.
Edit a routing ruleeditRoutePATCHReplace a routing rule identified by its ID, or restore it from the current production version.
Generate a routing rule from natural languagegenerateRoutePOSTGenerate a routing rule configuration from a natural language description.
Get project routing rulesgetRoutesGETGet the routing rules for a project.
Get routing rule version historygetRouteVersionsGETGet the version history for a project's routing rules.
Promote, restore, or discard a routing rule versionupdateRouteVersionsPOSTPromote staged routing rules to production, restore a previous production version, or discard staged changes.
Stage routing rulesstageRoutesPUTStage routing rules for a project.
ProjectMember3
Adds a new member to a project.addProjectMemberPOSTAdds a new member to the project.
List project membersgetProjectMembersGETLists all members of a project.
Remove a Project MemberremoveProjectMemberDELETERemove a member from a specific project
Rolling Release8
Complete the rolling release for the projectcompleteRollingReleasePOSTForce-complete a Rolling Release.
Delete rolling release configurationdeleteRollingReleaseConfigDELETEDisable Rolling Releases for a project means that future deployments will not undergo a rolling release.
Get rolling release billing statusgetRollingReleaseBillingStatusGETGet the Rolling Releases billing status for a project.
Get rolling release configurationgetRollingReleaseConfigGETGet the Rolling Releases configuration for a project.
Get the active rolling release information for a projectgetRollingReleaseGETReturn the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed.
Start a rolling release for the projectstartRollingReleasePOSTStart a rolling release for a deployment.
Update the active rolling release to the next stage for aapproveRollingReleaseStagePOSTAdvance a rollout to the next stage.
Update the rolling release settings for the projectupdateRollingReleaseConfigPATCHUpdate (or disable) Rolling Releases for a project.
Sandbox25
Create a directorycreateSessionDirectoryPOSTCreates a new directory in a session's filesystem.
Create a named sandboxcreateSandboxesPOSTCreates a named sandbox environment.
Create a snapshotcreateSessionSnapshotPOSTCreates a point-in-time snapshot of a running session's filesystem.
Delete a drivedeleteDriveDELETEDeletes a drive by project and name.
Delete a sandboxdeleteSandboxDELETEDeletes a sandbox by name.
Delete a snapshotdeleteSessionSnapshotDELETEPermanently deletes a snapshot and frees its associated storage.
Execute a commandrunSessionCommandPOSTExecutes a shell command inside a running session.
Extend session timeoutextendSessionTimeoutPOSTExtends the maximum execution time of a running session.
Get a commandgetSessionCommandGETRetrieves the current status and details of a command executed in a session.
Get a named sandboxgetNamedSandboxGETRetrieves a named sandbox by name, including its current sandbox and routes.
Get a sessiongetSessionGETRetrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes.
Get a snapshotgetSessionSnapshotGETRetrieves 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 drivegetOrCreateDrivePOSTGets an existing drive by project and name, or creates it when it does not exist.
Kill a commandkillSessionCommandPOSTSends a signal to terminate a running command in a session.
List commandslistSessionCommandsGETRetrieves 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 driveslistDrivesGETRetrieves a paginated list of drives belonging to a specific project.
List sandboxeslistSandboxesGETRetrieves a paginated list of named sandboxes belonging to a specific project.
List sessionslistSessionsGETRetrieves a paginated list of sessions belonging to a specific sandbox.
List snapshotslistSessionSnapshotsGETRetrieves a paginated list of snapshots for a specific project.
Read a filereadSessionFilePOSTDownloads the contents of a file from a session's filesystem.
Stop a sessionstopSessionPOSTStops a running session and releases its allocated resources.
Stream command logsgetSessionCommandLogsGETStreams the output of a command in real-time using newline-delimited JSON (ND-JSON).
Update a sandboxupdateSandboxPATCHUpdates the configuration of a sandbox.
Update network policyupdateSessionNetworkPolicyPOSTReplaces the network access policy of a running session.
Write fileswriteSessionFilesPOSTUploads and extracts files to a session's filesystem.
Security9
Create System Bypass RuleaddBypassIpPOSTCreate new system bypass rules
Put Firewall ConfigurationputFirewallConfigPUTSet the firewall configuration to provided rules and settings.
Read active attack datagetActiveAttackStatusGETRetrieve active attack data within the last N days (default: 1 day)
Read Firewall Actions by ProjectgetSecurityFirewallEventsGETRetrieve firewall actions for a project
Read Firewall ConfigurationgetFirewallConfigGETRetrieve the specified firewall configuration for a project.
Read System BypassgetBypassIpGETRetrieve the system bypass rules configured for the specified project
Remove System Bypass RuleremoveBypassIpDELETERemove system bypass rules
Update Attack Challenge modeupdateAttackChallengeModePOSTUpdate the setting for determining if the project has Attack Challenge mode enabled.
Update Firewall ConfigurationupdateFirewallConfigPATCHProcess updates to modify the existing firewall config for a project
Team16
Create a TeamcreateTeamPOSTCreate a new Team under your account.
Delete a microfrontends groupdeleteMicrofrontendsGroupDELETEDeletes a microfrontends group from the team associated with the group ID.
Delete a TeamdeleteTeamDELETEDelete a team under your account.
Delete a Team invite codedeleteTeamInviteCodeDELETEDelete an active Team invite code.
Get a TeamgetTeamGETGet information for the Team specified by the teamId parameter.
Get access request statusgetTeamAccessRequestGETCheck the status of a join request.
Invite a userinviteUserToTeamPOSTInvite a user to join the team specified in the URL.
Join a teamjoinTeamPOSTJoin a team with a provided invite code or team ID.
List all teamsgetTeamsGETGet a paginated list of all the Teams the authenticated User is a member of.
List team membersgetTeamMembersGETGet a paginated list of team members for the provided team.
Remove a Team MemberremoveTeamMemberDELETERemove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
Request access to a teamrequestAccessToTeamPOSTRequest access to a team as a member.
Update a microfrontends groupupdateMicrofrontendsGroupPATCHUpdates the name (and slug) of a microfrontends group.
Update a TeampatchTeamPATCHUpdate the information of a Team specified by the teamId parameter.
Update a Team MemberupdateTeamMemberPATCHUpdate 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 MappingspostTeamDsyncRolesPOSTUpdate the Directory Sync role mappings for a Team.
User4
Delete User AccountrequestDeleteDELETEInitiates the deletion process for the currently authenticated User, by sending a deletion confirmation email.
Get the UsergetAuthUserGETRetrieves information related to the currently authenticated User.
List Event TypeslistEventTypesGETReturns the list of user-facing event types with descriptions.
List User EventslistUserEventsGETRetrieves a list of "events" generated by the User on Vercel.
Vcr9
Create a repositorycreateRepositoryPOSTCreate a container registry repository for a project.
Delete a repositorydeleteRepositoryDELETESchedule a repository for deletion.
Delete a repository imagedeleteRepositoryImageDELETESchedule an image for deletion.
Get a repositorygetRepositoryGETFetch a container registry repository for a project by ID or name.
Get a repository imagegetRepositoryImageGETFetch an individual image from a repository, including its tags and Dockerfile history entries with discriminated layer details for UI rendering.
Get a repository taggetRepositoryTagGETFetch a single tag from a repository, including the backing image's metadata and VHS-readiness status.
List repositorieslistRepositoriesGETList container registry repositories for a project.
List repository imageslistRepositoryImagesGETList images for a container registry repository, including their tags.
List repository tagslistRepositoryTagsGETList a repository's tags.
Web Analytic4
Aggregates custom eventsaggregateEventsGETCounts custom events on a project, within the requested date range.
Aggregates page viewsaggregatePageviewsGETCounts pageviews on a project, within the requested date range.
Counts custom eventscountEventsGETCounts the number of custom events on a project (production only), since Web Analytics was enabled.
Counts page viewscountPageviewsGETCounts the number of page views on a project (production only), since Web Analytics was enabled.
Webhook4
Creates a webhookcreateWebhookPOSTCreates a webhook
Deletes a webhookdeleteWebhookDELETEDeletes a webhook
Get a list of webhooksgetWebhooksGETGet a list of webhooks
Get a webhookgetWebhookGETGet a webhook