> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vercel

> How to set up the Vercel connector, plus the actions and events that are available.

![Vercel](https://stackone-logos.com/api/vercel/filled/svg)

Previewv0.2.0[See changelog](https://docs.stackone.com/connectors/vercel/changelog.md)

[371 actions](#actions) · [31 events](#events) · 2 auth methods

Developer Tools
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/vercel/guides/connector-profile/access-token.md)
>
> Uses a Vercel access token scoped to one team, acting with the permissions of the person who created it. If the token ha...

> [card] [OAuth 2.0 (Vercel Integration) · Connector Profile](https://docs.stackone.com/connectors/vercel/guides/connector-profile/oauth-2-0-vercel-integration.md)
>
> Requires creating a Vercel Integration. The user installs it on a team and picks the projects it can reach; the token do...

Optionally, configure receiving Events for Vercel into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/vercel/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/vercel/guides/link-account/access-token.md)

> [card] [OAuth 2.0 (Vercel Integration) · Link Account](https://docs.stackone.com/connectors/vercel/guides/link-account/oauth-2-0-vercel-integration.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Access Token

OAuth 2.0 (Vercel Integration)

No auth methods found

Scopes

Select all
|
Clear

billing:read

deployment:read

deployment:read-write

domain:read

domain:read-write

drains:read-write

full\_account

global-config:read-write

global-project-env-vars:read-write

integration-configuration:read

integration-configuration:read-write

project:read

project:read-write

team

team:read

user:read

No scopes found

371 actions

ActionDescriptionRequired scopes

List Access Groups`vercel_list_access_groups`

List the Access Groups of a Vercel team.

`team`

Get Access Group`vercel_get_access_group`

Get an Access Group of a Vercel team.

`team`

List Access Group Members`vercel_list_access_group_members`

List the members of an Access Group.

`team`

List Access Group Projects`vercel_list_access_group_projects`

List projects of an access group.

`team`

Read Access Group Project`vercel_read_access_group_project`

Reads an access group project.

`team`

Create Access Group`vercel_create_access_group`

Creates an access group.

`team`

Create Access Group Project`vercel_create_access_group_project`

Create an access group project.

`team`

Update Access Group`vercel_update_access_group`

Update an access group.

`team`

Update Access Group Project`vercel_update_access_group_project`

Update an access group project.

`team`

Delete Access Group`vercel_delete_access_group`

Deletes an access group.

`team`

Delete Access Group Project`vercel_delete_access_group_project`

Delete an access group project.

`team`

List AI Gateway Budget Defaults`vercel_list_ai_gateway_budget_defaults`

List AI Gateway budget defaults.

`team`

List AI Gateway Budgets`vercel_list_ai_gateway_budgets`

List AI Gateway budgets.

`team`

List AI Gateway BYOK Credentials`vercel_list_ai_gateway_byok_credentials`

List BYOK credentials.

`team`

List AI Gateway Routers`vercel_list_ai_gateway_routers`

List AI Gateway routers.

`team`

List AI Gateway Rules`vercel_list_ai_gateway_rules`

List rules.

`team`

List AI Gateway Virtual Model Configs`vercel_list_ai_gateway_virtual_model_configs`

List virtual model configs.

`team`

Get AI Gateway BYOK Credential`vercel_get_ai_gateway_byok_credential`

Get a BYOK credential.

`team`

Get AI Gateway Virtual Model Config`vercel_get_ai_gateway_virtual_model_config`

Get virtual model config.

`team`

Get Virtual Model Config By Slug`vercel_get_virtual_model_config_by_slug`

Get virtual model config.

`team`

Create AI Gateway BYOK Credential`vercel_create_ai_gateway_byok_credential`

Create a BYOK credential.

`team`

Create AI Gateway Rule`vercel_create_ai_gateway_rule`

Create rule.

`team`

Create AI Gateway Virtual Model Config`vercel_create_ai_gateway_virtual_model_config`

Create virtual model config.

`team`

Update AI Gateway BYOK Credential`vercel_update_ai_gateway_byok_credential`

Update a BYOK credential.

`team`

Update AI Gateway Rule`vercel_update_ai_gateway_rule`

Update rule.

`team`

Update AI Gateway Virtual Model Config`vercel_update_ai_gateway_virtual_model_config`

Update virtual model config.

`team`

Update Virtual Model Config By Slug`vercel_update_virtual_model_config_by_slug`

Update virtual model config.

`team`

Upsert AI Gateway Budget`vercel_upsert_ai_gateway_budget`

Upsert AI Gateway budget.

`team`

Upsert AI Gateway Budget Default`vercel_upsert_ai_gateway_budget_default`

Upsert AI Gateway budget default.

`team`

Archive AI Gateway Budget`vercel_archive_ai_gateway_budget`

Archive AI Gateway budget.

`team`

Archive AI Gateway Budget Default`vercel_archive_ai_gateway_budget_default`

Archive AI Gateway budget default.

`team`

Delete AI Gateway BYOK Credential`vercel_delete_ai_gateway_byok_credential`

Delete a BYOK credential.

`team`

Delete AI Gateway Rule`vercel_delete_ai_gateway_rule`

Delete rule.

`team`

Delete AI Gateway Virtual Model Config`vercel_delete_ai_gateway_virtual_model_config`

Delete virtual model config.

`team`

Delete Virtual Model Config By Slug`vercel_delete_virtual_model_config_by_slug`

Delete virtual model config.

`team`

List Aliases`vercel_list_aliases`

List aliases.

`team`

List Deployment Aliases`vercel_list_deployment_aliases`

List Deployment Aliases.

`team``deployment:read`

Get Alias`vercel_get_alias`

Get an Alias.

`team`

Assign Alias`vercel_assign_alias`

Assign an Alias.

`team`

Patch URL Protection Bypass`vercel_patch_url_protection_bypass`

Update the protection bypass for a URL.

`team`

Delete Alias`vercel_delete_alias`

Delete an Alias.

`team`

List Billing Charges`vercel_list_billing_charges`

List FOCUS billing charges.

`team``billing:read`

List Contract Commitments`vercel_list_contract_commitments`

List FOCUS contract commitments.

`team``billing:read`

Get Redirects`vercel_get_redirects`

Gets project-level redirects.

`team`

Get Versions`vercel_get_versions`

Get the version history for a project's redirects.

`team`

Edit Redirect`vercel_edit_redirect`

Edit a project-level redirect.

`team`

Restore Redirects`vercel_restore_redirects`

Restore staged project-level redirects to their production version.

`team`

Stage Redirects`vercel_stage_redirects`

Stages new redirects for a project.

`team`

Update Version`vercel_update_version`

Promote a staging version to production or restore a previous production version.

`team`

Delete Redirects`vercel_delete_redirects`

Delete project-level redirects.

`team`

List Certs`vercel_list_certs`

Get certs.

`team`

Get Cert`vercel_get_cert`

Get cert by id.

`team``domain:read`

Issue Cert`vercel_issue_cert`

Issue a new cert.

`team``domain:read-write`

Upload Cert`vercel_upload_cert`

Upload a cert.

`team``domain:read-write`

Remove Cert`vercel_remove_cert`

Remove cert.

`team``domain:read-write`

List Check Runs`vercel_list_check_runs`

List runs for a check.

`team`

List Deployment Check Runs`vercel_list_deployment_check_runs`

List check runs for a deployment.

`team`

List Project Checks`vercel_list_project_checks`

List all checks for a project.

`team`

Get Deployment Check Run`vercel_get_deployment_check_run`

Get a check run.

`team`

Get Project Check`vercel_get_project_check`

Get a check.

`team`

Create Deployment Check Run`vercel_create_deployment_check_run`

Create a check run.

`team`

Create Project Check`vercel_create_project_check`

Create a check.

`team`

Update Deployment Check Run`vercel_update_deployment_check_run`

Update a check run.

`team`

Update Project Check`vercel_update_project_check`

Update a check.

`team`

Delete Project Check`vercel_delete_project_check`

Delete a check.

`team`

List Connector Project Connections`vercel_list_connector_project_connections`

List projects for a connector.

`team`

List Connectors`vercel_list_connectors`

List connectors.

`team`

List Project Connector Connections`vercel_list_project_connector_connections`

List connectors for a project.

`team`

Get Connector`vercel_get_connector`

Get a connector.

`team`

Get Connector Project Connection`vercel_get_connector_project_connection`

Get a connector project connection.

`team`

Create Connector`vercel_create_connector`

Create a connector.

`team`

Eject Managed Connector`vercel_eject_managed_connector`

Eject a managed connector.

`team`

Replace Connector Trigger Destinations`vercel_replace_connector_trigger_destinations`

Update connector trigger destinations.

`team`

Update Connector`vercel_update_connector`

Update a connector.

`team`

Upsert Connector Project Connection`vercel_upsert_connector_project_connection`

Create or update a connector project connection.

`team`

Delete Connector`vercel_delete_connector`

Delete a connector.

`team`

Delete Connector Project Connection`vercel_delete_connector_project_connection`

Disconnect a connector from a project.

`team`

List Deployment Files`vercel_list_deployment_files`

List Deployment Files.

`team``deployment:read`

List Deployments`vercel_list_deployments`

List deployments.

`team``deployment:read`

Get Deployment`vercel_get_deployment`

Get a deployment by ID or URL.

`team``deployment:read`

Get Deployment Events`vercel_get_deployment_events`

Get deployment events.

`team``deployment:read`

Get Deployment File Contents`vercel_get_deployment_file_contents`

Get Deployment File Contents.

`team``deployment:read`

Cancel Deployment`vercel_cancel_deployment`

Cancel a deployment.

`team``deployment:read-write`

Create Deployment`vercel_create_deployment`

Create a new deployment.

`team``deployment:read-write`

Upload File`vercel_upload_file`

Upload Deployment Files.

`team``deployment:read-write`

Delete Deployment`vercel_delete_deployment`

Delete a Deployment.

`team``deployment:read-write`

List DNS Records`vercel_list_dns_records`

List existing DNS records.

`team``domain:read`

Create DNS Record`vercel_create_dns_record`

Create a DNS record.

`team``domain:read-write`

Update DNS Record`vercel_update_dns_record`

Update an existing DNS record.

`team``domain:read-write`

Delete DNS Record`vercel_delete_dns_record`

Delete a DNS record.

`team``domain:read-write`

List Domains`vercel_list_domains`

List all the domains.

`team``domain:read`

Get DNS Record`vercel_get_dns_record`

Get DNS Record.

`team`

Get Domain`vercel_get_domain`

Get Information for a Single Domain.

`team``domain:read`

Get Domain Config`vercel_get_domain_config`

Get a Domain's configuration.

`team``domain:read`

Get Domain Project Domains`vercel_get_domain_project_domains`

List Project Domains by Apex Domain.

`team`

Get Domain Verification Record`vercel_get_domain_verification_record`

Get Domain Verification Record.

`team`

Claim Domain Ownership`vercel_claim_domain_ownership`

Claim Domain Ownership.

`team`

Create Or Transfer Domain`vercel_create_or_transfer_domain`

Add an existing domain to the Vercel platform.

`team`

Patch Domain`vercel_patch_domain`

Update or move apex domain.

`team`

Replace DNS Records`vercel_replace_dns_records`

Replace DNS Records.

`team`

Delete Domain`vercel_delete_domain`

Remove a domain by name.

`team``domain:read-write`

Get Contact Info Schema`vercel_get_contact_info_schema`

Get contact info schema.

`team`

Get Domain Availability`vercel_get_domain_availability`

Get availability for a domain.

`team``domain:read`

Get Domain Contact Verification`vercel_get_domain_contact_verification`

Get contact verification status for a domain.

`team`

Get Domain Price`vercel_get_domain_price`

Get price data for a domain.

`team``domain:read`

Get Order`vercel_get_order`

Get a domain order.

`team`

Get Supported Tlds`vercel_get_supported_tlds`

Get supported TLDs.

`team`

Get Tld`vercel_get_tld`

Get TLD.

`team`

Get Tld Price`vercel_get_tld_price`

Get TLD price data.

`team`

Buy Domains`vercel_buy_domains`

Buy multiple domains.

`team`

Buy Single Domain`vercel_buy_single_domain`

Buy a domain.

`team``domain:read-write`

Get Bulk Availability`vercel_get_bulk_availability`

Get availability for multiple domains.

`team`

Get Bulk Price`vercel_get_bulk_price`

Get price data for multiple domains.

`team`

Search Domains`vercel_search_domains`

Get Domain Availability and Pricing.

`team`

Update Domain Auto Renew`vercel_update_domain_auto_renew`

Update auto-renew for a domain.

`team`

Update Domain Nameservers`vercel_update_domain_nameservers`

Update nameservers for a domain.

`team`

Get Drain`vercel_get_drain`

Find a Drain by id.

`team``drains:read-write`

Get Drains`vercel_get_drains`

Retrieve a list of all Drains.

`team``drains:read-write`

Create Drain`vercel_create_drain`

Create a new Drain.

`team``drains:read-write`

Test Drain`vercel_test_drain`

Validate Drain delivery configuration.

`team``drains:read-write`

Update Drain`vercel_update_drain`

Update an existing Drain.

`team``drains:read-write`

Delete Drain`vercel_delete_drain`

Delete a drain.

`team``drains:read-write`

Invalidate By Src Images`vercel_invalidate_by_src_images`

Invalidate by source image.

`team`

Invalidate By Tags`vercel_invalidate_by_tags`

Invalidate by tag.

`team`

List Custom Environments`vercel_list_custom_environments`

Retrieve custom environments.

`team`

List Shared Env Variable`vercel_list_shared_env_variable`

Lists all Shared Environment Variables for a team.

`team`

Get Custom Environment`vercel_get_custom_environment`

Retrieve a custom environment.

`team`

Get Shared Env Var`vercel_get_shared_env_var`

Retrieve the decrypted value of a Shared Environment Variable by id.

`team`

Create Custom Environment`vercel_create_custom_environment`

Create a custom environment for the current project.

`team`

Create Shared Env Variable`vercel_create_shared_env_variable`

Create one or more shared environment variables.

`team`

Unlink Shared Env Variable`vercel_unlink_shared_env_variable`

Disconnects a shared environment variable for a given project.

`team`

Update Custom Environment`vercel_update_custom_environment`

Update a custom environment.

`team`

Update Shared Env Variable`vercel_update_shared_env_variable`

Updates one or more shared environment variables.

`team`

Delete Shared Env Variable`vercel_delete_shared_env_variable`

Delete one or more Env Var.

`team`

Remove Custom Environment`vercel_remove_custom_environment`

Remove a custom environment.

`team`

List Flag Label Counts`vercel_list_flag_label_counts`

List attribute label counts.

`team`

List Flag Labels`vercel_list_flag_labels`

List attribute labels.

`team`

List Flag Segments`vercel_list_flag_segments`

List segments.

`team`

List Flag Versions`vercel_list_flag_versions`

List flag versions.

`team`

List Flags`vercel_list_flags`

List flags.

`team`

List Team Flag Settings`vercel_list_team_flag_settings`

List team project flag settings.

`team`

List Team Flags`vercel_list_team_flags`

List all flags for a team.

`team`

Get Deployment Feature Flags`vercel_get_deployment_feature_flags`

Retrieve the feature flags of a deployment.

`team`

Get Flag`vercel_get_flag`

Get a flag.

`team`

Get Flag Segment`vercel_get_flag_segment`

Get a segment.

`team`

Get Flag Settings`vercel_get_flag_settings`

Get project flag settings.

`team`

Get SDK Keys`vercel_get_sdk_keys`

Get all SDK keys.

`team`

Create Flag`vercel_create_flag`

Create a flag.

`team`

Create Flag Segment`vercel_create_flag_segment`

Create a segment.

`team`

Create SDK Key`vercel_create_sdk_key`

Create an SDK key.

`team`

Lookup Flag Labels`vercel_lookup_flag_labels`

Look up attribute labels.

`team`

Update Flag`vercel_update_flag`

Update a flag.

`team`

Update Flag Segment`vercel_update_flag_segment`

Update a segment.

`team`

Update Flag Settings`vercel_update_flag_settings`

Update project flag settings.

`team`

Delete Flag`vercel_delete_flag`

Delete a flag.

`team`

Delete Flag Segment`vercel_delete_flag_segment`

Delete a segment.

`team`

Delete SDK Key`vercel_delete_sdk_key`

Delete an SDK key.

`team`

List Edge Configs`vercel_list_edge_configs`

Get Global Configs.

`team``global-config:read-write`

Get Edge Config`vercel_get_edge_config`

Get a Global Config.

`team``global-config:read-write`

Get Edge Config Backup`vercel_get_edge_config_backup`

Get Global Config backup.

`team`

Get Edge Config Backups`vercel_get_edge_config_backups`

Get Global Config backups.

`team`

Get Edge Config Item`vercel_get_edge_config_item`

Get a Global Config item.

`team``global-config:read-write`

Get Edge Config Items`vercel_get_edge_config_items`

Get Global Config items.

`team``global-config:read-write`

Get Edge Config Schema`vercel_get_edge_config_schema`

Get Global Config schema.

`team`

Get Edge Config Token`vercel_get_edge_config_token`

Get Global Config token meta data.

`team``global-config:read-write`

Get Edge Config Tokens`vercel_get_edge_config_tokens`

Get all tokens of a Global Config.

`team``global-config:read-write`

Create Edge Config`vercel_create_edge_config`

Create a Global Config.

`team``global-config:read-write`

Create Edge Config Token`vercel_create_edge_config_token`

Create a Global Config token.

`team``global-config:read-write`

Patch Edge Config Items`vercel_patch_edge_config_items`

Update Global Config items in batch.

`team``global-config:read-write`

Patch Edge Config Schema`vercel_patch_edge_config_schema`

Update Global Config schema.

`team`

Restore Edge Config Backup`vercel_restore_edge_config_backup`

Restore Global Config backup.

`team`

Update Edge Config`vercel_update_edge_config`

Update a Global Config.

`team``global-config:read-write`

Delete Edge Config`vercel_delete_edge_config`

Delete a Global Config.

`team``global-config:read-write`

Delete Edge Config Schema`vercel_delete_edge_config_schema`

Delete a Global Config's schema.

`team`

Delete Edge Config Tokens`vercel_delete_edge_config_tokens`

Delete one or more Global Config tokens.

`team``global-config:read-write`

Get Unified Credentials`vercel_unified_get_me`

Get the current Vercel connection's unified credentials and identity.

`team``team:read``user:read`

List Unified Groups`vercel_unified_list_groups`

List unified groups in a Vercel team.

`team`

Get Unified Group`vercel_unified_get_group`

Get a unified Vercel group by ID.

`team`

List Unified Organizations`vercel_unified_list_organizations`

List unified organizations in Vercel.

`team`

Get Unified Organization`vercel_unified_get_organization`

Get a unified Vercel organization by ID.

`team``team:read`

List Unified Roles`vercel_unified_list_roles`

List the team and project roles of Vercel.

`team``user:read`

Get Unified Role`vercel_unified_get_role`

Get a unified Vercel role by ID.

`team``user:read`

List Unified Users`vercel_unified_list_users`

List unified users in a Vercel team.

`team``team:read`

Get Unified User`vercel_unified_get_user`

Get a unified Vercel team member by ID.

`team``team:read`

List Integration Configurations`vercel_list_integration_configurations`

Get configurations for the authenticated user or team.

`team`

Get Billing Plans`vercel_get_billing_plans`

List integration billing plans.

`team`

Get Configuration`vercel_get_configuration`

Retrieve an integration configuration.

`team``integration-configuration:read`

Get Configuration Products`vercel_get_configuration_products`

List products for integration configuration.

`team`

Git Namespaces`vercel_git_namespaces`

List git namespaces by provider.

`team`

Search Repo`vercel_search_repo`

List git repositories linked to namespace by provider.

`team`

Connect Integration Resource To Project`vercel_connect_integration_resource_to_project`

Connect integration resource to project.

`team`

Create Integration Store Direct`vercel_create_integration_store_direct`

Create integration store (free and paid plans).

`team`

Delete Configuration`vercel_delete_configuration`

Delete an integration configuration.

`team``integration-configuration:read-write`

List KMS Issuers`vercel_list_kms_issuers`

List issuers.

`team`

Get KMS Issuer`vercel_get_kms_issuer`

Get an issuer.

`team`

Activate KMS Signing Key`vercel_activate_kms_signing_key`

Activate a signing key.

`team`

Create KMS Issuer`vercel_create_kms_issuer`

Create an issuer.

`team`

Create KMS Issuer Policy`vercel_create_kms_issuer_policy`

Create an issuer policy.

`team`

Create KMS Signing Key`vercel_create_kms_signing_key`

Create a signing key.

`team`

Revoke KMS Signing Key`vercel_revoke_kms_signing_key`

Revoke a signing key.

`team`

Update KMS Issuer`vercel_update_kms_issuer`

Update an issuer.

`team`

Update KMS Issuer Policy`vercel_update_kms_issuer_policy`

Update an issuer policy.

`team`

Delete KMS Issuer`vercel_delete_kms_issuer`

Delete an issuer.

`team`

Delete KMS Issuer Policy`vercel_delete_kms_issuer_policy`

Delete an issuer policy.

`team`

List Team Members`vercel_list_team_members`

List the members of a Vercel team.

`team``team:read`

Invite Users To Team`vercel_invite_users_to_team`

Invite a person to a Vercel team by email.

`team`

Update Team Member`vercel_update_team_member`

Change the role of a Vercel team member or accept an access request.

`team`

Remove Team Member`vercel_remove_team_member`

Remove a member from a Vercel team or dismiss an access request.

`team`

Get Microfrontends Config`vercel_get_microfrontends_config`

Get microfrontends config for a deployment.

`team`

Get Microfrontends Config For Project`vercel_get_microfrontends_config_for_project`

Get microfrontends config for a project.

`team`

Get Microfrontends Groups`vercel_get_microfrontends_groups`

List microfrontends groups.

`team`

Get Microfrontends In Group`vercel_get_microfrontends_in_group`

List projects in a microfrontends group.

`team`

Create Microfrontends Group With Applications`vercel_create_microfrontends_group_with_applications`

Create a microfrontends group with applications.

`team`

List Networks`vercel_list_networks`

List Secure Compute networks.

`team`

List Private Link Endpoints`vercel_list_private_link_endpoints`

List PrivateLink endpoints.

`team`

Read Network`vercel_read_network`

Read a Secure Compute network.

`team`

Read Private Link Endpoint`vercel_read_private_link_endpoint`

Read a PrivateLink endpoint.

`team`

Create Network`vercel_create_network`

Create a Secure Compute network.

`team`

Create Private Link Endpoint`vercel_create_private_link_endpoint`

Create a PrivateLink endpoint.

`team`

Update Network`vercel_update_network`

Update a Secure Compute network.

`team`

Update Private Link Endpoint`vercel_update_private_link_endpoint`

Update a PrivateLink endpoint.

`team`

Update Static IPs`vercel_update_static_ips`

Configures Static IPs for a project.

`team`

Delete Network`vercel_delete_network`

Delete a Secure Compute network.

`team`

Delete Private Link Endpoint`vercel_delete_private_link_endpoint`

Delete a PrivateLink endpoint.

`team`

Get Observability Configuration Projects`vercel_get_observability_configuration_projects`

Lists disabled Observability Plus projects.

`team`

Get Observability Metric Schema`vercel_get_observability_metric_schema`

Get Observability Metric Schema.

`team`

Get Observability Schema`vercel_get_observability_schema`

Get Observability Schema.

`team`

Create Observability Query`vercel_create_observability_query`

Create Observability Query.

`team`

Update Observability Configuration Project`vercel_update_observability_configuration_project`

Updates a disabled Observability Plus project setting.

`team`

Get Project Members`vercel_get_project_members`

List project members.

`team`

Add Project Member`vercel_add_project_member`

Adds a new member to a project.

`team`

Remove Project Member`vercel_remove_project_member`

Remove a Project Member.

`team`

Get Route Versions`vercel_get_route_versions`

Get routing rule version history.

`team`

Get Routes`vercel_get_routes`

Get project routing rules.

`team`

Add Route`vercel_add_route`

Add a routing rule.

`team`

Edit Route`vercel_edit_route`

Edit a routing rule.

`team`

Generate Route`vercel_generate_route`

Generate a routing rule from natural language.

`team`

Stage Routes`vercel_stage_routes`

Stage routing rules.

`team`

Update Route Versions`vercel_update_route_versions`

Promote, restore, or discard a routing rule version.

`team`

Delete Routes`vercel_delete_routes`

Delete routing rules.

`team`

List Projects`vercel_list_projects`

Retrieve a list of projects.

`team``project:read`

List Promote Aliases`vercel_list_promote_aliases`

Gets a list of aliases with status for the current promote.

`team`

Filter Project Envs`vercel_filter_project_envs`

Retrieve the environment variables of a project by id or name.

`team``global-project-env-vars:read-write`

Get Project`vercel_get_project`

Find a project by id or name.

`team``project:read`

Get Project Domain`vercel_get_project_domain`

Get a project domain.

`team``project:read`

Get Project Domains`vercel_get_project_domains`

Retrieve project domains by project by id or name.

`team``project:read`

Get Project Env`vercel_get_project_env`

Retrieve the decrypted value of an environment variable of a project by id.

`team``global-project-env-vars:read-write`

Get Project Trace`vercel_get_project_trace`

Get a project trace by request ID.

`team`

Accept Project Transfer Request`vercel_accept_project_transfer_request`

Accept project transfer request.

`team`

Add Project Domain`vercel_add_project_domain`

Add a domain to a project.

`team``project:read-write`

Create Project`vercel_create_project`

Create a new project.

`team``project:read-write`

Create Project Env`vercel_create_project_env`

Create one or more environment variables.

`team``global-project-env-vars:read-write`

Create Project Transfer Request`vercel_create_project_transfer_request`

Create project transfer request.

`team`

Create Trace Session`vercel_create_trace_session`

Create a trace session token for a deployment.

`team`

Edit Project Env`vercel_edit_project_env`

Edit an environment variable.

`team``global-project-env-vars:read-write`

Get Project Token`vercel_get_project_token`

Generate a project OIDC token.

`team`

Move Project Domain`vercel_move_project_domain`

Move a project domain.

`team`

Pause Project`vercel_pause_project`

Pause a project.

`team`

Request Promote`vercel_request_promote`

Point production traffic to a given deployment.

`team`

Request Rollback`vercel_request_rollback`

Point production traffic to a previous production deployment by ID.

`team`

Unpause Project`vercel_unpause_project`

Unpause a project.

`team`

Update Microfrontends`vercel_update_microfrontends`

Update the microfrontends settings.

`team`

Update Project`vercel_update_project`

Update an existing project.

`team``project:read-write`

Update Project Domain`vercel_update_project_domain`

Update a project domain.

`team``project:read-write``domain:read-write`

Update Project Protection Bypass`vercel_update_project_protection_bypass`

Update Protection Bypass for Automation.

`team`

Update Rollback Description`vercel_update_rollback_description`

Updates the description for a rollback.

`team`

Upload Project Avatar`vercel_upload_project_avatar`

Upload a project avatar.

`team`

Verify Project Domain`vercel_verify_project_domain`

Verify project domain.

`team``project:read-write`

Batch Remove Project Env`vercel_batch_remove_project_env`

Batch remove environment variables.

`team``global-project-env-vars:read-write`

Delete Project`vercel_delete_project`

Delete a Project.

`team``project:read-write`

Delete Project Avatar`vercel_delete_project_avatar`

Delete a project avatar.

`team`

Remove Project Domain`vercel_remove_project_domain`

Remove a domain from a project.

`team``project:read-write`

Remove Project Env`vercel_remove_project_env`

Remove an environment variable.

`team``global-project-env-vars:read-write`

Get Rolling Release`vercel_get_rolling_release`

Get the active rolling release information for a project.

`team`

Get Rolling Release Billing Status`vercel_get_rolling_release_billing_status`

Get rolling release billing status.

`team`

Get Rolling Release Config`vercel_get_rolling_release_config`

Get rolling release configuration.

`team`

Approve Rolling Release Stage`vercel_approve_rolling_release_stage`

Update the active rolling release to the next stage for a project.

`team`

Complete Rolling Release`vercel_complete_rolling_release`

Complete the rolling release for the project.

`team`

Start Rolling Release`vercel_start_rolling_release`

Start a rolling release for the project.

`team`

Update Rolling Release Config`vercel_update_rolling_release_config`

Update the rolling release settings for the project.

`team`

Delete Rolling Release Config`vercel_delete_rolling_release_config`

Delete rolling release configuration.

`team`

List Drives`vercel_list_drives`

List drives.

`team`

List Named Sandboxes`vercel_list_named_sandboxes`

List sandboxes.

`team`

List Session Commands`vercel_list_session_commands`

List commands.

`team`

List Session Snapshots`vercel_list_session_snapshots`

List snapshots.

`team`

List Sessions`vercel_list_sessions`

List sessions.

`team`

Get Drive`vercel_get_drive`

Get a drive.

`team`

Get Named Sandbox`vercel_get_named_sandbox`

Get a named sandbox.

`team`

Get Session`vercel_get_session`

Get a session.

`team`

Get Session Command`vercel_get_session_command`

Get a command.

`team`

Get Session Command Logs`vercel_get_session_command_logs`

Stream command logs.

`team`

Get Session Snapshot`vercel_get_session_snapshot`

Get a snapshot.

`team`

Create Sandbox`vercel_create_sandbox`

Create a named sandbox.

`team`

Create Session Directory`vercel_create_session_directory`

Create a directory.

`team`

Create Session Snapshot`vercel_create_session_snapshot`

Create a snapshot.

`team`

Extend Session Timeout`vercel_extend_session_timeout`

Extend session timeout.

`team`

Fork Drive`vercel_fork_drive`

Fork a drive.

`team`

Fork Sandbox`vercel_fork_sandbox`

Fork a named sandbox.

`team`

Get Or Create Drive`vercel_get_or_create_drive`

Get or create a drive.

`team`

Kill Session Command`vercel_kill_session_command`

Kill a command.

`team`

Read Session File`vercel_read_session_file`

Read a file.

`team`

Run Session Command`vercel_run_session_command`

Execute a command.

`team`

Stop Session`vercel_stop_session`

Stop a session.

`team`

Update Sandbox`vercel_update_sandbox`

Update a sandbox.

`team`

Update Session Network Policy`vercel_update_session_network_policy`

Update network policy.

`team`

Write Session Command Stdin`vercel_write_session_command_stdin`

Write to command stdin.

`team`

Write Session Files`vercel_write_session_files`

Write files.

`team`

Delete Drive`vercel_delete_drive`

Delete a drive.

`team`

Delete Sandbox`vercel_delete_sandbox`

Delete a sandbox.

`team`

Delete Session Snapshot`vercel_delete_session_snapshot`

Delete a snapshot.

`team`

List Bypass IPs`vercel_list_bypass_ips`

Read System Bypass.

`team`

Get Active Attack Status`vercel_get_active_attack_status`

Read active attack data.

`team`

Get Active Firewall Config`vercel_get_active_firewall_config`

Returns activated WAF config.

`team`

Get Conditional Bypass`vercel_get_conditional_bypass`

Get conditional firewall bypasses.

`team`

Get Firewall Config Version`vercel_get_firewall_config_version`

Read Firewall Configuration.

`team`

Get Security Firewall Events`vercel_get_security_firewall_events`

Read Firewall Actions by Project.

`team`

Get Security Firewall Events Summary`vercel_get_security_firewall_events_summary`

Read Firewall Actions Summary by Project.

`team`

Activate Firewall Config Version`vercel_activate_firewall_config_version`

Returns activated WAF config.

`team`

Add Bypass IP`vercel_add_bypass_ip`

Create System Bypass Rule.

`team`

Create Conditional Bypass`vercel_create_conditional_bypass`

Create conditional firewall bypass.

`team`

Generate Firewall Rule`vercel_generate_firewall_rule`

Generate a firewall rule from natural language.

`team`

Put Firewall Config`vercel_put_firewall_config`

Put Firewall Configuration.

`team`

Update Attack Challenge Mode`vercel_update_attack_challenge_mode`

Update Attack Challenge mode.

`team`

Update Firewall Config`vercel_update_firewall_config`

Update Firewall Configuration.

`team`

Delete Conditional Bypass`vercel_delete_conditional_bypass`

Delete conditional firewall bypass.

`team`

Delete Firewall Config Version`vercel_delete_firewall_config_version`

Returns activated WAF config.

`team`

Remove Bypass IP`vercel_remove_bypass_ip`

Remove System Bypass Rule.

`team`

Get Store`vercel_get_store`

Get a store.

`team`

Create Blob Store`vercel_create_blob_store`

Create a Blob store.

`team`

Delete Blob Store`vercel_delete_blob_store`

Delete a Blob store.

`team`

List Teams`vercel_list_teams`

List the Vercel teams the access token can see.

`team`

Get Team`vercel_get_team`

Get a Vercel team by ID.

`team``team:read`

Create Team`vercel_create_team`

Create a Team.

`team`

Patch Team`vercel_patch_team`

Update a Team.

`team`

Update Microfrontends Group`vercel_update_microfrontends_group`

Update a microfrontends group.

`team`

Delete Microfrontends Group`vercel_delete_microfrontends_group`

Delete a microfrontends group.

`team`

Get Current User`vercel_get_current_user`

Get the Vercel user that owns the access token.

`team``user:read`

Get Current Token`vercel_get_current_token`

Get the metadata of the Vercel access token in use.

`team`

List Auth Tokens`vercel_list_auth_tokens`

List Auth Tokens.

`full_account`

List Event Types`vercel_list_event_types`

List Event Types.

`team`

List User Events`vercel_list_user_events`

List User Events.

`team`

Get Auth Token`vercel_get_auth_token`

Get Auth Token Metadata.

`full_account`

Create Auth Token`vercel_create_auth_token`

Create an Auth Token.

`full_account`

Delete Auth Token`vercel_delete_auth_token`

Delete an authentication token.

`full_account`

List Vercel CI Branches`vercel_list_vercel_ci_branches`

List Vercel CI branch suggestions for a team.

`team`

List Vercel CI Invocation Attempts`vercel_list_vercel_ci_invocation_attempts`

List all attempts for an invocation.

`team`

List Vercel CI Invocations`vercel_list_vercel_ci_invocations`

List invocations for a team, optionally filtered by repository and invocation metadata.

`team`

List Vercel CI Job Definitions`vercel_list_vercel_ci_job_definitions`

List job definitions for an invocation attempt.

`team`

List Vercel CI Job Runs`vercel_list_vercel_ci_job_runs`

List all runs for a job definition.

`team`

List Vercel CI Task Analysis Tasks`vercel_list_vercel_ci_task_analysis_tasks`

List discovered tasks for a completed Vercel CI task analysis.

`team`

List Vercel CI Task Definitions`vercel_list_vercel_ci_task_definitions`

List all task definitions for a job run.

`team`

List Vercel CI Task Runs`vercel_list_vercel_ci_task_runs`

List task runs for a job run.

`team`

Get Vercel CI Invocation`vercel_get_vercel_ci_invocation`

Get a specific invocation attempt.

`team`

Get Vercel CI Invocation Logs`vercel_get_vercel_ci_invocation_logs`

Get log lines for an invocation attempt.

`team`

Get Vercel CI Invocation Tree`vercel_get_vercel_ci_invocation_tree`

Get an invocation with its jobs and tasks.

`team`

Get Vercel CI Job Definition`vercel_get_vercel_ci_job_definition`

Get a specific job definition.

`team`

Get Vercel CI Job Run`vercel_get_vercel_ci_job_run`

Get a specific job run attempt.

`team`

Get Vercel CI Job Run Logs`vercel_get_vercel_ci_job_run_logs`

Get log lines for a specific job run attempt.

`team`

Get Vercel CI Repository Settings`vercel_get_vercel_ci_repository_settings`

Get Vercel CI settings for a connected repository.

`team`

Get Vercel CI Task Analysis`vercel_get_vercel_ci_task_analysis`

Get the current status of a Vercel CI task analysis.

`team`

Get Vercel CI Task Logs`vercel_get_vercel_ci_task_logs`

Get log lines for the tasks of an invocation attempt.

`team`

Get Vercel CI Task Run Logs`vercel_get_vercel_ci_task_run_logs`

Get log lines for a specific task run attempt.

`team`

Search Vercel CI Logs`vercel_search_vercel_ci_logs`

Search the task logs of several invocation attempts.

`team`

Create Vercel CI Task Analysis`vercel_create_vercel_ci_task_analysis`

Start an asynchronous Vercel CI task analysis.

`team`

Create Vercel CI Task Config Pull Request`vercel_create_vercel_ci_task_config_pull_request`

Create a GitHub pull request that adds Vercel CI tags for the completed analysis.

`team`

Retry Vercel CI Invocation`vercel_retry_vercel_ci_invocation`

Retry a terminal Vercel CI invocation attempt.

`team`

Update Vercel CI Repository Settings`vercel_update_vercel_ci_repository_settings`

Enable or disable Vercel CI for a connected repository.

`team`

Aggregate Events`vercel_aggregate_events`

Aggregates custom events.

`team`

Aggregate Pageviews`vercel_aggregate_pageviews`

Aggregates page views.

`team`

Count Events`vercel_count_events`

Counts custom events.

`team`

Count Pageviews`vercel_count_pageviews`

Counts page views.

`team`

## Events

Tags

Select all
|
Clear

Deployments

Domains

Feature Flags

Projects

Verification

No tags found

31 events

EventDescriptionTags

Test Webhook`vercel_webhook_test`

Acknowledges a Vercel test-webhook delivery without emitting an event.

Verification

Deployment Created Webhook`vercel_webhook_deployment_created`

Processes Vercel deployment.created events, sent when a deployment starts.

Deployments

Deployment Succeeded Webhook`vercel_webhook_deployment_succeeded`

Processes Vercel deployment.succeeded events, sent when a deployment succeeds, after any blocking checks pass.

Deployments

Deployment Error Webhook`vercel_webhook_deployment_error`

Processes Vercel deployment.error events, sent when a deployment fails.

Deployments

Deployment Canceled Webhook`vercel_webhook_deployment_canceled`

Processes Vercel deployment.canceled events, sent when a deployment is canceled.

Deployments

Deployment Promoted Webhook`vercel_webhook_deployment_promoted`

Processes Vercel deployment.promoted events, sent when a deployment is promoted to production, manually or automatically...

Deployments

Deployment Rollback Webhook`vercel_webhook_deployment_rollback`

Processes Vercel deployment.rollback events, sent when Vercel accepts an instant rollback request.

Deployments

Domain Auto-Renew Changed Webhook`vercel_webhook_domain_auto_renew_changed`

Processes Vercel domain.auto-renew\.changed events, sent when auto-renew is turned on or off for a domain.

Domains

Domain Certificate Added Webhook`vercel_webhook_domain_certificate_add`

Processes Vercel domain.certificate.add events, sent when a certificate is issued.

Domains

Domain Certificate Deleted Webhook`vercel_webhook_domain_certificate_deleted`

Processes Vercel domain.certificate.deleted events, sent when a certificate is deleted.

Domains

Domain DNS Records Changed Webhook`vercel_webhook_domain_dns_records_changed`

Processes Vercel domain.dns.records.changed events, sent when DNS records of a domain change.

Domains

Flag Created Webhook`vercel_webhook_flag_created`

Processes Vercel flag.created events, sent when a feature flag is created.

Feature Flags

Flag Updated Webhook`vercel_webhook_flag_updated`

Processes Vercel flag.updated events, sent when a feature flag is updated.

Feature Flags

Flag Deleted Webhook`vercel_webhook_flag_deleted`

Processes Vercel flag.deleted events, sent when a feature flag is deleted.

Feature Flags

Flag Segment Created Webhook`vercel_webhook_flag_segment_created`

Processes Vercel flag.segment.created events, sent when a flag segment is created.

Feature Flags

Flag Segment Updated Webhook`vercel_webhook_flag_segment_updated`

Processes Vercel flag.segment.updated events, sent when a flag segment is updated.

Feature Flags

Flag Segment Deleted Webhook`vercel_webhook_flag_segment_deleted`

Processes Vercel flag.segment.deleted events, sent when a flag segment is deleted.

Feature Flags

Project Created Webhook`vercel_webhook_project_created`

Processes Vercel project.created events, sent when a project is created.

Projects

Project Removed Webhook`vercel_webhook_project_removed`

Processes Vercel project.removed events, sent when a project is deleted.

Projects

Project Renamed Webhook`vercel_webhook_project_renamed`

Processes Vercel project.renamed events, sent when a project is renamed.

Projects

Project Environment Variable Created Webhook`vercel_webhook_project_env_variable_created`

Processes Vercel project.env-variable.created events, sent when a project environment variable is created.

Projects

Project Environment Variable Updated Webhook`vercel_webhook_project_env_variable_updated`

Processes Vercel project.env-variable.updated events, sent when a project environment variable is updated.

Projects

Project Environment Variable Deleted Webhook`vercel_webhook_project_env_variable_deleted`

Processes Vercel project.env-variable.deleted events, sent when a project environment variable is deleted.

Projects

Project Domain Created Webhook`vercel_webhook_project_domain_created`

Processes Vercel project.domain.created events, sent when a domain is added to a project.

Projects

Project Domain Updated Webhook`vercel_webhook_project_domain_updated`

Processes Vercel project.domain.updated events, sent when a project domain changes (redirect, Git branch or name).

Projects

Project Domain Deleted Webhook`vercel_webhook_project_domain_deleted`

Processes Vercel project.domain.deleted events, sent when a domain is removed from a project.

Projects

Project Domain Verified Webhook`vercel_webhook_project_domain_verified`

Processes Vercel project.domain.verified events, sent when a project domain is verified.

Projects

Project Domain Moved Webhook`vercel_webhook_project_domain_moved`

Processes Vercel project.domain.moved events, sent when a domain moves from one project to another.

Projects

Rolling Release Started Webhook`vercel_webhook_project_rolling_release_started`

Processes Vercel project.rolling-release.started events, sent when a rolling release starts.

Projects

Rolling Release Approved Webhook`vercel_webhook_project_rolling_release_approved`

Processes Vercel project.rolling-release.approved events, sent when a rolling release stage is approved.

Projects

Rolling Release Completed Webhook`vercel_webhook_project_rolling_release_completed`

Processes Vercel project.rolling-release.completed events, sent when a rolling release completes.

Projects


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.