VercelApi

The VercelApi MCP Server offers a comprehensive suite of tools for managing Vercel projects, domains, and integrations. Users can efficiently perform actions such as:

Available Tools

VercelApi.ReadAccessGroup

Retrieve details of a specific access group.

Parameters

• access_group_id_or_name (string, required) The ID or name of the access group to retrieve details for.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The Team slug used to perform the request on behalf of the specified team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateAccessGroup

Update metadata for an access group.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• access_group_id_or_name (string, optional) The ID or name of the access group to update. Use either the unique identifier or the group’s name to specify which access group you want to modify. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is performed. Only used when mode is ‘execute’.
• team_slug (string, optional) The identifier for the team, used to perform the request on its behalf. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteAccessGroup

Deletes an access group by ID or name.

Parameters

• group_id_or_name (string, required) The ID or name of the access group to be deleted.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The slug for the team on whose behalf the request will be made. This identifies the team uniquely.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListAccessGroupMembers

Retrieve members of a specific access group.

Parameters

• access_group_id_or_name (string, required) Specify the ID or name of the access group to list its members.
• continuation_cursor_for_paging (string, optional) Cursor used to retrieve the next page of access group members.
• member_limit (integer, optional) Specify the maximum number of access group members to return.
• member_search_query (string, optional) Search for members using their name, username, or email.
• team_identifier (string, optional) The Team identifier for which to list access group members.
• team_slug (string, optional) The unique slug of the team for which you want to list access group members.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListAccessGroups

Retrieve a list of access groups within Vercel.

Parameters

• access_groups_limit (integer, optional) Specify the maximum number of access groups to be returned in the response.
• continuation_cursor_for_next_page (string, optional) A string to retrieve the next page of results using a continuation cursor.
• max_projects_in_response (integer, optional) Specify the maximum number of projects to include in the response list.
• members_inclusion_limit (integer, optional) Specify the number of members to include in the response.
• project_id (string, optional) Filter access groups by the specified project ID in Vercel.
• search_access_groups_by_name (string, optional) Provide a name or keyword to search for specific access groups.
• team_identifier (string, optional) The ID of the team for which to list access groups. Specify this to perform the request on behalf of a specific team.
• team_slug (string, optional) A string representing the Team slug to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateAccessGroup

Create a new access group on Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The identifier of the team on whose behalf the access group is being created. Only used when mode is ‘execute’.
• team_slug (string, optional) The unique slug identifier for the team to create the access group for. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListAccessGroupProjects

Retrieve a list of projects for a given access group.

Parameters

• access_group_identifier (string, required) The ID or name of the Access Group to list its projects.
• continuation_cursor (string, optional) The continuation cursor used to retrieve the next page of results in a paginated response.
• max_project_count (integer, optional) Maximum number of access group projects to return. Must be an integer.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of. This specifies which team’s access group projects to list.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. Specify to filter projects by team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateAccessGroupProject

Create a project within a specific access group.

Parameters

• access_group_id_or_name (string, required) Identifier or name of the access group to associate with the project. It helps specify which access group the new project will be part of.
• project_id (string, required) The unique ID of the project to be added to the access group.
• project_role (string, required) The role to be assigned to the project within the access group. Options: ‘ADMIN’, ‘PROJECT_VIEWER’, ‘PROJECT_DEVELOPER’.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The unique identifier slug for the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetAccessGroupProject

Retrieve details of a specific access group project.

Parameters

• access_group_id_or_name (string, required) The identifier or name of the access group for the project.
• project_id (string, required) The unique identifier for the project within the access group. It is required to fetch the project details.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of. This should be a string representing the team’s unique ID.
• team_slug (string, optional) The Team slug to perform the request on behalf of. Provide the specific slug associated with the team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateAccessGroupProject

Update an access group project in Vercel.

Parameters

• access_group_id_or_name (string, required) Specify the access group by its ID or name to target the update.
• project_id (string, required) The unique identifier for the project to update in the access group.
• project_role (string, required) Specify the project role to add to the access group. Choose from ‘ADMIN’, ‘PROJECT_VIEWER’, or ‘PROJECT_DEVELOPER’.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The unique identifier for the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteAccessGroupProject

Delete a specified access group project on Vercel.

Parameters

• access_group_id_or_name (string, required) Enter the access group ID or name to identify the specific group for project deletion.
• project_id (string, required) The ID of the project you want to delete from the access group.
• team_identifier (string, optional) The ID of the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the deletion on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RecordCacheEvents

Record artifacts cache usage events for Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. Used to specify which team’s cache usage events are being recorded. Only used when mode is ‘execute’.
• team_slug (string, optional) The Team slug to perform the request on behalf of. It identifies the specific team within Vercel. Only used when mode is ‘execute’.
• ci_environment (string, optional) The continuous integration or delivery environment where this artifact is downloaded. Only used when mode is ‘execute’.
• is_interactive_shell (integer, optional) Set to 1 if the client is an interactive shell, otherwise set to 0. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CheckRemoteCachingStatus

Check the status of Remote Caching.

Parameters

• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The unique slug identifier for the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DownloadCacheArtifact

Downloads a cache artifact using its hash identifier.

Parameters

• artifact_hash (string, required) The unique hash identifier for the cache artifact to download.
• ci_environment (string, optional) Specify the continuous integration or delivery environment from which the artifact is downloaded.
• interactive_shell_client (integer, optional) Set to 1 if the client is an interactive shell; otherwise set to 0.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of, identifying which team’s artifact to download.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.QueryArtifactsInfo

Retrieve detailed information about multiple artifacts.

Parameters

• artifact_hashes (array[string], required) An array of artifact hashes to query information for.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug identifying the team for which the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateNewDeploymentCheck

Create a new deployment check using Vercel API.

Parameters

• block_deployment_on_failure (boolean, required) Indicates if the check should block a deployment from succeeding.
• check_name (string, required) The name of the check being created. This is required to identify the check purpose.
• deployment_id (string, required) The unique identifier of the deployment to create the check for.
• allow_rerun_request (boolean, optional) Allow users to request a rerun of the check if it fails. Use a boolean value.
• details_url (string, optional) A URL that provides further details about the check. Expected format is a valid URL string.
• external_identifier (string, optional) A unique identifier used as an external reference for the check.
• page_path_to_check (string, optional) Specify the path of the page that is being checked. This should be a string value representing the specific page path for the deployment check.
• team_identifier (string, optional) The unique identifier used to perform the request on behalf of a team.
• team_slug (string, optional) The slug (unique identifier) of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListDeploymentChecks

List all checks for a specific deployment.

Parameters

• deployment_id (string, required) The ID of the deployment to retrieve checks for.
• team_identifier (string, optional) The ID of the team to perform the request for. This identifies which team’s context is used.
• team_slug (string, optional) The Team slug used to perform the request. This identifies the team under which the deployment was made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDeploymentCheckDetails

Retrieve details for a specific deployment check.

Parameters

• check_identifier (string, required) The unique identifier of the check to fetch details for.
• deployment_id (string, required) The ID of the deployment for which the check details are required.
• team_id (string, optional) The identifier for the team on whose behalf the request is performed.
• team_slug (string, optional) The slug identifier for the team to perform the request on behalf of. It uniquely represents the team within the system.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateExistingCheck

Updates an existing deployment check.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• deployment_id (string, optional) The identifier for the deployment to update the check for. Ensure it is a valid string. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• check_identifier (string, optional) The unique identifier of the check to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier of the Team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. This identifies the team within Vercel. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RerequestCheck

Retries a failed deployment check.

Parameters

• check_to_rerun_id (string, required) The ID of the check you want to rerun. This identifies the specific failed check to retry.
• deployment_id (string, required) The ID of the deployment for which the check needs to be rerun. This specifies the which specific deployment’s check is to be retried.
• mark_check_as_running (boolean, optional) Mark the check as running if set to true when re-requested.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. It specifies which team’s context the request should be executed in.
• team_slug (string, optional) The identifier for the team to perform the check rerequest on behalf of. Use the team’s slug format.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateProjectDataCache

Update the data cache for a Vercel project.

Parameters

• project_id (string, required) The unique identifier for the Vercel project to update the data cache.
• disable_data_cache (boolean, optional) Set to true to disable the project’s data cache, or false to enable it. Default is false.
• team_identifier (string, optional) The unique Team ID to perform the request on behalf of. Required for targeted updates.
• team_slug (string, optional) The Team slug to perform the request on behalf of. Use this to specify which team’s project to update.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchDeploymentLogs

Retrieve build logs for a specific deployment by ID.

Parameters

• deployment_identifier_or_hostname (string, required) The unique identifier or hostname of the deployment to fetch logs for.
• build_event_delimiter (number, optional) Specify the delimiter type for separating logged events. Use ‘0’ for no delimiter and ‘1’ for an alternative separation method.
• deployment_build_id (string, optional) The unique identifier for the deployment build for which logs are to be retrieved.
• enable_live_streaming (number, optional) Set to ‘1’ to enable live streaming of events as they happen. Use ‘0’ to disable live streaming.
• event_order (string, optional) Specifies the order of returned events by timestamp. Use ‘forward’ for chronological order or ‘backward’ for reverse order.
• fetch_until_timestamp (number, optional) Timestamp up to which the build logs should be retrieved.
• filter_by_status_code (string, optional) Specify the HTTP status code range to filter deployment events.
• include_builds (number, optional) Specify whether to include build events (1) or not (0) in the response.
• maximum_events_to_return (number, optional) Specify the max number of events to return. Use -1 for all available logs.
• start_timestamp_for_logs (number, optional) Timestamp from which to start retrieving build logs. Provide in milliseconds.
• team_identifier (string, optional) Identifies the team on whose behalf the request is performed.
• team_slug (string, optional) The unique identifier (slug) of the Team for which the request is made. Used to specify the team context.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateIntegrationDeployment

Update a deployment integration action.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• deployment_id (string, optional) The unique identifier for the deployment to update. This is required to specify which deployment’s integration action should be modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• integration_configuration_id (string, optional) The ID of the integration configuration to update. This is required to specify which integration setup the action applies to. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_id (string, optional) The unique identifier for the resource to be updated in the deployment integration. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• deployment_action (string, optional) Specifies the action to be taken for the deployment integration. Expected as a descriptive string indicating the action type. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDeploymentInfo

Retrieve deployment information by ID or URL.

Parameters

• deployment_id_or_url (string, required) The unique identifier or hostname of the deployment to retrieve details for.
• include_git_repo_information (string, optional) Set to ‘true’ to include Git repository details or ‘false’ to exclude them.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The Team slug for performing the request on behalf of that team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateVercelDeployment

Create a new deployment on Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• force_new_deployment (string, optional) Set to ‘true’ to force a new deployment even if a similar one exists. Only used when mode is ‘execute’.
• skip_framework_detection_confirmation (string, optional) Set to ‘true’ to skip framework detection and avoid confirmation request failures. Only used when mode is ‘execute’.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of for creating a deployment on Vercel. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug identifying the team to perform the deployment on behalf of. This is essential for specifying the target team for the deployment request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CancelDeployment

Cancel a currently building deployment.

Parameters

• deployment_id (string, required) The unique identifier of the deployment to cancel.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of when canceling a deployment.
• team_slug (string, optional) The Team slug for which the deployment cancellation should be performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PurchaseDomain

Facilitates the purchase of a specified domain.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The unique identifier for the team to perform the domain purchase request. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team to perform the purchase on behalf of. This identifies the team within Vercel. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainPrice

Retrieve domain price and purchase period details.

Parameters

• domain_name (string, required) The domain name to check the purchase price for.
• domain_status_for_pricing (string, optional) Specifies the domain status (‘new’, ‘renewal’, ‘transfer’, ‘redemption’) to check the price for.
• team_identifier (string, optional) The Team identifier for executing the request on behalf of a specific team. This is usually a unique string assigned to the team.
• team_slug_for_request (string, optional) The slug identifier of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CheckDomainAvailability

Check if a domain name is available for purchase.

Parameters

• domain_name (string, required) The domain name you want to check for purchase availability.
• team_identifier (string, optional) The identifier of the Team on whose behalf the request is performed.
• team_slug (string, optional) The slug for the team or organization on whose behalf the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDnsRecords

Retrieve DNS records for a specified domain name.

Parameters

• domain_name (string, required) The domain name for which to retrieve DNS records. Must be a valid domain.
• maximum_records_to_list (string, optional) Specify the maximum number of DNS records to retrieve in a single request.
• records_created_after_timestamp (string, optional) Get records created after this specified JavaScript timestamp. It filters DNS records based on the creation date.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug representing the team on whose behalf the request is made.
• until_timestamp (string, optional) Retrieve records created before the specified JavaScript timestamp.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateDnsRecord

Creates a DNS record for a domain.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• domain_name_for_dns_record (string, optional) The domain for which the DNS record will be created. Must be a valid and registered domain name. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The Team identifier for performing the request. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug identifier for the team performing the DNS record creation. It should be a string that represents the team’s unique slug. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateDnsRecord

Update an existing DNS record for a domain.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• dns_record_id (string, optional) The unique identifier of the DNS record to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the team performing the request. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the Team to perform the DNS update on behalf of. It is used to specify the team context for the request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveDnsRecord

Removes an existing DNS record from a domain.

Parameters

• dns_record_id (string, required) The unique identifier of the DNS record to be removed. Required for specifying which record to delete.
• domain_name (string, required) The domain from which the DNS record will be removed. Provide the full domain name.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is performed.
• team_slug (string, optional) The slug representing the team on whose behalf the DNS record is removed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetSupportedTlds

Retrieve a list of TLDs supported by Vercel.

Parameters

• team_id (string, optional) The ID of the team for which to retrieve supported TLDs.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetTldPrice

Retrieve base price for a specific TLD.

Parameters

• top_level_domain (string, required) The top-level domain (TLD) for which to retrieve the base price. Examples include ‘com’, ‘net’, ‘org’.
• registration_years (string, optional) The number of years for which the TLD registration price should be calculated. Provide this as an integer representing the duration in years.
• team_id (string, optional) The ID of the team for which the TLD price data is requested.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DomainAvailabilityStatus

Check if a domain is available for purchase.

Parameters

• domain_name_to_check_availability (string, required) The domain name to check for availability. Must be a valid and complete domain name string.
• team_identifier (string, optional) A unique identifier for the team whose domain availability is being queried. This is a string value.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchDomainPrice

Retrieve price data for a specific domain from Vercel.

Parameters

• domain_name (string, required) The domain name to check the pricing for. Provide a fully qualified domain like ‘example.com’.
• number_of_years (string, optional) Specify the number of years for which the domain pricing is needed. Typically set to 1 or more.
• team_identifier (string, optional) A string representing the unique identifier of the team associated with the domain. This is required for specifying which team’s domain pricing information should be retrieved.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CheckDomainAvailabilityBulk

Check availability for multiple domains.

Parameters

• domain_names (array[string], required) A list of domain names to check, with a maximum of 50 domains.
• team_identifier (string, optional) Unique identifier for the team or organization associated with the request. It may be required to access specific domain availability data.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainAuthCode

Retrieve the auth code for transferring a domain from Vercel.

Parameters

• domain_name (string, required) The domain name for which the auth code is being requested. It should be a valid domain registered with Vercel.
• team_id (string, optional) The ID representing the Vercel team associated with the domain. Required for accessing team-specific domains.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PurchaseDomainVercel

Purchase a domain with Vercel’s API.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• domain_name (string, optional) The domain name that you wish to purchase using Vercel’s API. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_id (string, optional) The unique identifier for the team under which the domain will be purchased. This is expected to be a string. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PurchaseMultipleDomains

Purchase multiple domains simultaneously.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_id (string, optional) The unique identifier for the team under which the domains will be purchased. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.TransferDomainToVercel

Transfer a domain to Vercel from another registrar.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• domain_name (string, optional) The domain name to be transferred to Vercel. It should be a valid domain currently registered elsewhere. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the Vercel team requesting the domain transfer. It helps associate the domain transfer with the correct Vercel team. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CheckDomainTransferStatus

Retrieve the transfer status of a domain.

Parameters

• domain_name (string, required) Specifies the domain name to check the transfer status for. It should be a valid domain string.
• team_id (string, optional) The unique identifier of the team requesting the domain transfer status.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RenewDomain

Renews a domain registration through Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• domain_name (string, optional) The domain name to be renewed, in string format. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team that owns the domain. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateDomainAutoRenew

Update the auto-renew setting for a domain.

Parameters

• domain_name (string, required) The domain for which you want to update the auto-renew setting. It should be a valid domain name, such as ‘example.com’.
• enable_auto_renew (boolean, required) Set to true to enable auto-renewal of the domain, or false to disable it.
• team_id (string, optional) The unique identifier for the team associated with the domain.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateDomainNameservers

Update the nameservers for a domain.

Parameters

• domain_name (string, required) The domain name to update the nameservers for. Provide the full domain, e.g., ‘example.com’.
• nameservers_list (array[string], required) A list of nameservers to set for the domain. Pass an empty list to revert to Vercel’s default nameservers.
• team_id (string, optional) The unique identifier for the team to which the domain belongs. If not provided, the default team context is used.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainContactInfoSchema

Retrieve the schema for TLD-specific contact information.

Parameters

• domain_name (string, required) The domain name for which to retrieve the TLD-specific contact information schema.
• team_id (string, optional) A unique identifier for the team within Vercel. Required to retrieve domain-specific contact info.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainOrderInfo

Retrieve information about a domain order by its ID.

Parameters

• order_id (string, required) The unique ID of the domain order to retrieve information about.
• team_id (string, optional) The ID of the team associated with the domain order. This identifies the specific team within Vercel that the domain order belongs to.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchDomainTransferAvailability

Fetch a domain’s transfer status or availability.

Parameters

• domain_name (string, required) The domain name to check for transfer status or availability.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. It should be a string representing the team’s unique ID.
• team_slug (string, optional) The identifier slug of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainConfiguration

Retrieve configuration details for a specific domain.

Parameters

• domain_name (string, required) The name of the domain to retrieve configuration details for.
• include_only_assigned_nameservers (string, optional) When true, only nameservers assigned directly to the domain are included. When false, parent zone nameservers are included if no direct assignment exists.
• project_id_or_name (string, optional) The project ID or name associated with the domain, used if not yet linked to a project.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of. It specifies which team’s context to use when fetching domain configurations.
• team_slug (string, optional) The Team slug used to perform the request on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDomainInfo

Retrieve information on a single domain from Vercel.

Parameters

• domain_name (string, required) The name of the domain to retrieve information for.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of. Typically a unique string.
• team_slug (string, optional) The slug identifier for the team on behalf of whom the request is made. It uniquely identifies the team in Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetRegisteredDomains

Retrieve a list of registered domains for the user or team.

Parameters

• domains_created_since_timestamp (number, optional) Get domains created after the specified JavaScript timestamp.
• maximum_domains_to_list (number, optional) The maximum number of domains to include in the list returned by the request.
• team_id (string, optional) The unique Team identifier to retrieve domains for a specific team instead of the authenticated user.
• team_slug (string, optional) The team slug used to perform the request on behalf of a specific team.
• until_timestamp (number, optional) Fetch domains created before this JavaScript timestamp.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AddNewDomainVercel

Add a new apex domain with Vercel for the user.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The identifier of the Team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The identifier for the team to execute the request on behalf of. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateApexDomain

Update or move the apex domain configuration.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• apex_domain_name (string, optional) The apex domain to update or move. Accepts a string value representing the domain name (e.g., ‘example.com’). Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team to perform the domain update on behalf of. This allows the request to be associated with a specific team. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug identifying the Team on whose behalf the request is made. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteVercelDomain

Delete a domain from Vercel and remove associated aliases.

Parameters

• domain_name (string, required) The domain name to be deleted from Vercel. This action will also remove any associated aliases.
• team_identifier (string, optional) The identifier of the team to perform the domain deletion request on behalf of.
• team_slug (string, optional) The specific team slug to perform the deletion request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.InvalidateCacheByTags

Mark cache tags as stale for revalidation in the background.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) Specify the project ID or name for which the cache tags should be marked as stale. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_id (string, optional) The Team identifier to execute the request for. Provide the team’s unique ID. Only used when mode is ‘execute’.
• team_slug (string, optional) The identifier (slug) for the team to perform the request on their behalf. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteCacheByTags

Marks cache tags as deleted to revalidate associated entries.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) The ID or name of the project associated with the cache tags to delete. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier for the team on whose behalf the cache deletion request is performed. Only used when mode is ‘execute’.
• team_slug (string, optional) Specify the team slug to perform the cache deletion on behalf of a team. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigs

Fetch all Edge Configs from Vercel’s service.

Parameters

• team_identifier (string, optional) Specify the Team identifier for which the Edge Configs need to be fetched.
• team_slug (string, optional) The Team slug to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateEdgeConfig

Create a new Edge Configuration.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The identifier of the team to perform the request for. This is required to specify on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The Team slug that specifies the team to perform the request on behalf of. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfig

Retrieve Edge Config details from Vercel.

Parameters

• edge_config_id (string, required) The unique identifier for the Edge Config to retrieve details from Vercel.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of in Vercel.
• team_slug (string, optional) The slug of the team to perform the request on behalf of in Vercel. This identifier is needed to specify which team’s settings are being accessed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateEdgeConfig

Update an existing Edge Config to apply changes.

Parameters

• edge_config_identifier (string, required) The unique identifier of the Edge Config to be updated. This is required to specify which configuration should be modified.
• edge_config_slug (string, required) The unique slug identifier for the Edge Config that needs updating.
• team_slug (string, required) The slug identifying the team on whose behalf the request is performed.
• team_identifier (string, optional) The unique identifier of the team to perform the request for. Required for updating the Edge Config on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteEdgeConfig

Delete a Vercel Edge Config by ID.

Parameters

• edge_config_id (string, required) The unique identifier of the Edge Config to be deleted.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The slug of the team on whose behalf the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigItems

Retrieve all items from an Edge Config.

Parameters

• edge_config_id (string, required) The ID of the Edge Config to retrieve items from. This is required to specify which Edge Config data to access.
• team_identifier (string, optional) The Team identifier to perform the request for a specific Vercel team.
• team_slug (string, optional) The slug representing the team on whose behalf the request is made. Each team has a unique slug identifier.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateEdgeConfigItems

Batch update Edge Config Items efficiently.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• edge_config_identifier (string, optional) The identifier for the specific Edge Config to update in the batch request. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the Team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The unique slug of the team to perform the request on behalf of. It identifies the team in a URL-friendly format. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigSchema

Retrieve the schema of an Edge Config.

Parameters

• edge_config_id (string, required) The identifier for the specific Edge Config to retrieve its schema. It is required to specify which configuration’s schema you want to query.
• team_identifier (string, optional) The unique identifier for the team to make requests on their behalf.
• team_slug (string, optional) The slug of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateEdgeConfigSchema

Update an Edge Config’s schema to modify its structure.

Parameters

• edge_config_identifier (string, required) The unique identifier for the Edge Config to update its schema.
• edge_config_schema_definition (string, required) JSON string defining the updated structure and settings of the Edge Config.
• enable_dry_run (string, optional) Set to true to simulate the update without applying changes. Useful for testing.
• team_identifier (string, optional) The unique ID of the team on whose behalf the request will be made.
• team_slug (string, optional) The Team slug to perform the request on behalf of. It identifies the specific team for the operation.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteEdgeConfigSchema

Deletes an existing Edge Config schema.

Parameters

• edge_config_id (string, required) The unique identifier for the specific Edge Config schema to be deleted.
• team_identifier (string, optional) The identifier of the team on whose behalf the request is made.
• team_slug (string, optional) The slug representing the team on whose behalf the request is performed. It uniquely identifies the team within Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigItem

Retrieve a specific Edge Config Item by its identifiers.

Parameters

• edge_config_id (string, required) The ID of the Edge Config to retrieve a specific item from.
• edge_config_item_key (string, required) The key of the specific Edge Config Item to retrieve.
• team_identifier (string, optional) The ID of the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team for which the Edge Config Item is requested.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigTokens

Retrieve all tokens of a specific Edge Config.

Parameters

• edge_config_id (string, required) A string representing the unique identifier of the Edge Config to retrieve tokens for. This ID is necessary to specify which Edge Config’s tokens are being accessed.
• team_identifier (string, optional) The ID of the team to perform the request on behalf of. It identifies which team’s Edge Config tokens to retrieve.
• team_slug (string, optional) Slug of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteEdgeConfigTokens

Delete tokens from an existing Edge Config.

Parameters

• edge_config_id (string, required) The unique identifier for the Edge Config from which tokens will be deleted. Required for specifying the target Edge Config.
• tokens_to_delete (array[string], required) A list of token identifiers to be deleted from the Edge Config. Each token should be a string.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The Team slug representing the team on whose behalf the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigTokenInfo

Retrieve metadata about an Edge Config token.

Parameters

• edge_config_id (string, required) The identifier for the Edge Config to retrieve metadata for. This is required to specify which configuration token’s information is needed.
• edge_config_token (string, required) The token used to obtain metadata for a specific Edge Config.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The Team slug for performing the request on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AddEdgeConfigToken

Adds a token to an existing Edge Config.

Parameters

• edge_config_id (string, required) The unique identifier for the Edge Config to which the token will be added.
• token_label (string, required) A descriptive label for the token being added to the Edge Config.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is performed.
• team_slug (string, optional) The slug identifying the Team on whose behalf the request is made. This is used for specifying the target team within Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveEdgeConfigBackup

Retrieve a specific Edge Config version from backup storage.

Parameters

• edge_config_backup_version_id (string, required) The unique identifier for the backup version of the Edge Config to retrieve.
• edge_config_id (string, required) The ID of the Edge Config to retrieve from backup storage.
• team_identifier (string, optional) The unique identifier of the Team to perform the request on behalf of.
• team_slug (string, optional) The team’s unique slug to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetEdgeConfigBackups

Retrieve backups of an Edge Config.

Parameters

• edge_config_id (string, required) The unique identifier for the Edge Config whose backups you want to retrieve.
• backup_limit (number, optional) The maximum number of Edge Config backups to return. This is useful for paginating results.
• include_metadata (string, optional) Indicate if metadata should be included in the response. Use ‘true’ to include.
• next_page_token (string, optional) A token for fetching the next page of results if pagination is needed.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The team slug to perform the request on behalf of. It identifies the specific team in Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListUserEvents

Fetches a list of user-generated events on Vercel.

Parameters

• deprecated_user_id (string, optional) Deprecated. Use ‘principal_id’ instead. If both ‘principal_id’ and ‘deprecated_user_id’ exist, ‘principal_id’ will be used.
• end_time_filter (string, optional) Timestamp to filter events created until this time.
• event_types_filter (string, optional) Comma-delimited list of event types to filter the results by.
• filter_by_principal_id (string, optional) Filter events generated by a specific principal when retrieving events for a Team.
• include_event_payload (string, optional) Set to ‘true’ to include the ‘payload’ field in each event response.
• include_items_since_timestamp (string, optional) Timestamp to only include items created since then. Use ISO 8601 format.
• maximum_items_to_return (number, optional) Maximum number of items that can be returned from the request.
• project_ids_filter (string, optional) Comma-separated list of project IDs to filter the events by.
• team_identifier (string, optional) Specify the Team ID to retrieve events related to that team.
• team_slug (string, optional) The Team slug to perform the request on behalf of. Use this to specify which team’s events to retrieve.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveBillingPlans

Retrieve billing plans for a specific integration and product.

Parameters

• integration_identifier_or_slug (string, required) The unique identifier or slug for the integration to retrieve billing plans for. Use the specific key related to the integration.
• product_id_or_slug (string, required) The unique identifier or slug for the product to retrieve billing plans.
• additional_metadata (string, optional) Optional metadata for the request, provided as a string.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The unique team slug used to identify which team’s context the request should be performed in.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ConnectIntegrationResourceToProject

Connect an integration resource to a Vercel project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The identifier for the integration configuration to be connected to the Vercel project. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_id (string, optional) The ID of the integration resource to connect to the Vercel project. This is required to establish the link. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The unique team slug used to perform the request on behalf of a specific team in Vercel. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateIntegrationInstallation

Updates an integration installation configuration.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The ID of the integration configuration to update. This should be a string identifying the specific installation. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchAccountInfo

Fetch the best account or user’s contact info.

Parameters

• integration_configuration_id (string, required) The unique identifier for the integration configuration. Required to fetch the user’s account info.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetMemberRoleInfo

Retrieve member role and details for a specific member ID.

Parameters

• integration_configuration_id (string, required) A unique identifier for the integration configuration. Required to specify which integration to retrieve member details from.
• member_id (string, required) The ID of the member to retrieve role and details for. This corresponds to the “user_id” claim in the SSO OIDC token.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.NotifyVercelOfUpdates

Send update notifications to Vercel for installations or resources.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The ID of the integration configuration. It links the notification to the specific Vercel installation or resource. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetIntegrationResources

Retrieve all resources for a given installation ID.

Parameters

• installation_id (string, required) The unique identifier of the integration installation to fetch resources for.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchIntegrationResource

Fetch a resource using its partner ID.

Parameters

• integration_configuration_id (string, required) The ID of the specific installation to which the resource belongs.
• third_party_resource_id (string, required) The ID provided by the third-party provider for the specific resource.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteIntegrationResource

Delete a resource from an integration by ID.

Parameters

• integration_installation_id (string, required) The ID of the installation to delete the resource from.
• resource_id (string, required) The ID of the resource to be deleted. Required for identifying the specific resource within the integration.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ImportResourceToVercel

Import or synchronize a resource to Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique identifier for the integration configuration in Vercel. Required to specify which configuration to use when importing the resource. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_identifier (string, optional) The unique identifier for the resource to be imported or synchronized with Vercel. This ID is used to match the resource between the partner’s system and Vercel’s system. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateResource

Update an existing resource with new information.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique identifier for the integration configuration to update. Required for identifying which integration configuration is being modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_id (string, optional) The unique identifier of the resource to be updated. This is required to specify which resource you are targeting for updates. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.SubmitBillingData

Submit billing and usage data to the server.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) A string representing the unique identifier for the integration configuration. This is required to submit billing data. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.SubmitInvoiceToVercel

Submit an invoice to Vercel’s billing system.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique ID for the Vercel integration configuration. This links the invoice submission to the correct integration setup in Vercel. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetInvoiceDetails

Retrieve invoice details and status by ID.

Parameters

• integration_configuration_id (string, required) The unique identifier for the integration configuration. Required to specify the configuration context for the invoice retrieval.
• invoice_id (string, required) The unique identifier of the invoice to retrieve details and status for.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RequestVercelInvoiceRefund

Request a refund for an invoice in Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• vercel_integration_configuration_id (string, optional) The unique identifier for the Vercel integration configuration related to the invoice. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• invoice_id (string, optional) The unique identifier for the invoice for which the refund is requested. This ID is obtained from the invoice creation process. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.SubmitPrepaymentBalances

Submit prepayment balances to Vercel for billing.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique identifier for the integration configuration. Use the ID provided during the integration setup. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateResourceSecrets

Updates the secrets of a specified resource.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique identifier for the integration configuration associated with the resource. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• integration_product_id_or_slug (string, optional) Specify the product ID or slug to identify the integration product for the resource update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_id (string, optional) The unique identifier for the resource whose secrets are being updated. This is required to specify which resource’s secrets need modification. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateSecretsById

Update the secrets of a Vercel resource by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The ID of the integration configuration. This identifies the specific configuration in Vercel to update secrets for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_id (string, optional) The unique identifier of the Vercel resource whose secrets are to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveIntegrationConfigurations

Retrieve all configurations for an authenticated integration.

Parameters

• configuration_view_type (string, required) Specify ‘account’ to view all configurations or ‘project’ to exclude configurations generated from the authorization flow.
• installation_type (string, optional) Specifies the installation type. Options are ‘marketplace’ or ‘external’.
• integration_id (string, optional) The ID or slug of the integration to retrieve configurations for.
• team_identifier (string, optional) Specifies the Team ID to perform the request on behalf of.
• team_slug (string, optional) The Team slug to perform the request on behalf of when retrieving configurations.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetIntegrationConfiguration

Retrieve configuration details by ID.

Parameters

• configuration_id (string, required) ID of the configuration to retrieve. The user or team must own this configuration.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The unique team slug to perform the request on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveVercelConfiguration

Delete a Vercel configuration by ID.

Parameters

• configuration_id (string, required) The unique identifier of the Vercel configuration to be deleted.
• team_identifier (string, optional) The identifier for the team on behalf of which the configuration is removed.
• team_slug (string, optional) The team slug representing the Vercel team to perform the action on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListIntegrationConfigurationProducts

Retrieve products for a specific integration configuration.

Parameters

• integration_configuration_id (string, required) ID of the specific integration configuration to list available products for.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. It specifies which team’s configuration products to list.
• team_slug (string, optional) The slug of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ExchangeSsoToken

Exchange OAuth code for an OIDC token to authenticate users.

Parameters

• authorization_code (string, required) The sensitive OAuth authorization code received from Vercel for the SSO token exchange process.
• integration_client_id (string, required) The unique client ID for the integration, required for authentication.
• integration_client_secret (string, required) The secret key for the integration client, used for authentication.
• authorization_state (string, optional) The state received from the initialization request for security validation.
• integration_redirect_uri (string, optional) The URL where the user will be redirected after authentication.
• sso_grant_type (string, optional) Specifies the grant type as ‘authorization_code’ for OAuth process.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveIntegrationLogDrains

Retrieve all integration log drains for the user or team.

Parameters

• team_identifier (string, optional) The identifier for the Team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. Used to specify which team’s log drains to retrieve.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateIntegrationLogDrain

Sets up an Integration log drain for Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The Team identifier for performing the request on behalf of a specific team in Vercel. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team to perform the request on behalf of. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteIntegrationLogDrain

Delete an Integration log drain by ID.

Parameters

• log_drain_id (string, required) The ID of the log drain to be deleted. This identifies the specific log drain for removal.
• team_identifier (string, optional) The identifier of the Team on whose behalf the request is made.
• team_slug (string, optional) The slug of the team on whose behalf the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDeploymentRuntimeLogs

Get logs for a specific deployment’s runtime.

Parameters

• deployment_id (string, required) The unique identifier for the deployment whose runtime logs are to be retrieved.
• project_id (string, required) The unique identifier for the project related to the deployment. This is necessary to retrieve the correct runtime logs.
• team_identifier (string, optional) The unique identifier for the team to make the request on behalf of.
• team_slug (string, optional) The unique slug representing the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateExperimentationItems

Create one or multiple experimentation items.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The ID of the integration configuration for which to create experimentation items. This ties the items to a specific setup or environment. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_identifier (string, optional) The unique identifier of the resource to associate with the experimentation items. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateExperimentationItem

Update an existing experimentation item.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The ID of the integration configuration to be updated. This identifies which configuration is being patched. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_identifier (string, optional) The unique identifier of the experimentation resource to update. Provides context for which item needs modification. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• experiment_item_id (string, optional) The unique identifier for the experimentation item to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteExperimentationItem

Delete an existing experimentation item.

Parameters

• experiment_item_id (string, required) The unique identifier for the experimentation item to be deleted.
• integration_configuration_id (string, required) The ID of the integration configuration to identify the correct setup.
• resource_id (string, required) The unique identifier for the resource containing the item to be deleted. This is required to specify which resource the item belongs to.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PushEdgeConfig

Push configuration data to Edge Config for syncing.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• integration_configuration_id (string, optional) The unique identifier for the integration configuration. Use this to specify which configuration to push to Edge Config. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• resource_identifier (string, optional) The ID of the resource for the configuration data to be pushed. Required for identifying the target Edge Config. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListProjectMembers

Retrieve all members of a specified project on Vercel.

Parameters

• project_id_or_name (string, required) The ID or name of the project to list members for.
• added_since_timestamp (integer, optional) Timestamp in milliseconds to include members added since this time.
• end_time_timestamp (integer, optional) The timestamp in milliseconds to include project members added until this time.
• member_limit (integer, optional) Specify the maximum number of project members to return. Provide an integer value.
• search_project_members (string, optional) Search for project members by name, username, or email.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of. This should be a string.
• team_slug (string, optional) The Team slug to perform the request on behalf of, identifying the specific team associated with the project.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AddProjectMember

Add a new member to a Vercel project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) The ID or name of the Vercel project to which a new member will be added. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the Team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug identifying the team for performing the request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveProjectMember

Removes a member from a specific project.

Parameters

• project_id_or_name (string, required) The ID or name of the project from which the member will be removed.
• user_id (string, required) The unique user ID of the member to be removed from the project.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made. This should be a string.
• team_slug (string, optional) The slug used to identify the Team for which the request is being made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveProjectsList

Retrieve the list of user’s or team’s projects.

Parameters

• exclude_repositories (string, optional) Comma-separated list of repository names to exclude from the results.
• filter_by_edge_config_id (string, optional) Filter results by connected Edge Config ID. Provide the ID as a string to retrieve projects linked to this specific config.
• filter_by_edge_config_token_id (string, optional) Filter results by the connected Edge Config Token ID. Provide the specific token ID to refine project search.
• filter_by_elastic_concurrency (string, optional) Filter projects by elastic concurrency status. Use ‘1’ for enabled or ‘0’ for disabled.
• filter_by_repo (string, optional) Filter the project results by the specified repository name, also used for project count.
• filter_by_repository_id (string, optional) Filter the project results by specifying the Repository ID.
• filter_by_static_ips_enabled (string, optional) Set to ‘1’ to filter projects with Static IPs enabled, ‘0’ otherwise.
• include_deprecated_projects (boolean, optional) Include deprecated projects in the results when set to True.
• max_projects_returned (string, optional) Specifies the maximum number of projects to return in the list.
• repository_url_filter (string, optional) URL to filter projects associated with a specific repository.
• require_git_fork_authorization (string, optional) Set to ‘1’ to require authorization for Git fork PRs before deployment, or ‘0’ to disable.
• search_by_project_name (string, optional) Search for projects using a keyword or term in the name field.
• team_identifier (string, optional) The ID of the team to perform the request on behalf of.
• team_slug (string, optional) The team slug to perform the request on behalf of, representing a specific team within Vercel.
• updated_after (string, optional) Filter projects updated after the specified timestamp or using a continuation token.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateNewProject

Create a new project with specified configurations.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The identifier of the team on whose behalf the project will be created. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the Team to perform the request on behalf of. It should be a string identifier. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetProjectInfo

Retrieve specific project details using project ID or name.

Parameters

• project_identifier_or_name (string, required) The unique project identifier or the project name to retrieve details.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The unique slug representing the team on whose behalf the request is performed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateProjectDetails

Update a project’s fields using its name or ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) The unique identifier or name of the Vercel project to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug of the team on whose behalf the request is made. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteProject

Delete a Vercel project by ID or name.

Parameters

• project_identifier_or_name (string, required) The unique project identifier or the project name to specify which project to delete.
• team_identifier (string, optional) The unique identifier of the team to perform the project deletion.
• team_slug (string, optional) The slug representing the team to execute the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateProjectNetworkLinks

Update project connections to shared Secure Compute networks.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_identifier_or_name (string, optional) Specify the unique project identifier or project name for the network connection update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made. This is required to specify the context of the update. Only used when mode is ‘execute’.
• team_slug (string, optional) The unique slug of the team that this request should be performed on behalf of. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateCustomEnvironment

Create a custom environment for your Vercel project.

Parameters

• project_unique_identifier_or_name (string, required) The unique project identifier or project name for which the custom environment is being created.
• branch_matcher_type (string, optional) Specifies the type of branch matcher: ‘equals’, ‘startsWith’, or ‘endsWith’.
• copy_environment_variables_from (string, optional) Specify the source environment to copy variables from. This is optional.
• custom_environment_slug (string, optional) Specify the slug for the new custom environment. It cannot be ‘Production’ or ‘Preview’.
• environment_description (string, optional) Optional description for the custom environment being created.
• git_branch_name_pattern (string, optional) Git branch name or part of it to match with the custom environment.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. It is required to specify the unique team for the custom environment.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetCustomProjectEnvironments

Retrieve custom environments for a specified project.

Parameters

• project_id_or_name (string, required) The unique identifier or name of the project to retrieve custom environments.
• git_branch_name (string, optional) Specify the git branch to fetch custom environments from. This identifies the branch to retrieve environments for.
• team_identifier (string, optional) The identifier for the Team to perform the request on behalf of. Expected as a string.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. This identifies the specific team related to the project.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveCustomEnvironment

Retrieve custom environment details for a project.

Parameters

• custom_environment_identifier (string, required) The unique identifier for a custom environment within the project, excluding ‘Production’ or ‘Preview’.
• project_identifier_or_name (string, required) The unique project identifier or the project’s name to retrieve details for.
• team_identifier (string, optional) The unique Team identifier used to perform the request on behalf of a specified team.
• team_slug (string, optional) The Team slug used to perform the request.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateCustomEnvironment

Update a custom environment for a Vercel project.

Parameters

• custom_environment_id (string, required) The unique identifier for the custom environment within the project.
• project_identifier_or_name (string, required) The unique project identifier or project name for the custom environment.
• branch_matcher_type (string, optional) Specifies the branch matcher type: ‘equals’, ‘startsWith’, or ‘endsWith’.
• branch_name_pattern (string, optional) Specify a portion or full Git branch name for matching. Used to identify branches in custom environments.
• custom_environment_description (string, optional) Optional description of the custom environment to be updated.
• custom_environment_slug (string, optional) Slug of the custom environment to update. Must not be ‘Production’ or ‘Preview’.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the update on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveCustomEnvironment

Remove a specified custom environment from a project.

Parameters

• custom_environment_identifier (string, required) The unique identifier for the custom environment within the project to be removed.
• project_identifier_or_name (string, required) The unique project identifier or the project name to target the environment removal.
• delete_unassigned_environment_variables (boolean, optional) Delete environment variables that are not assigned to any environments when set to true.
• team_identifier (string, optional) The identifier for the team to make the request on behalf of.
• team_slug (string, optional) The slug representing the team on whose behalf to perform the request.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveProjectDomains

Retrieve domains linked to a specific project.

Parameters

• project_id_or_name (string, required) Specify the unique project identifier or the project name.
• created_before_timestamp (number, optional) Get domains created before this JavaScript timestamp for filtering results.
• custom_environment_id (string, optional) The unique custom environment identifier within the project.
• domains_created_since_timestamp (number, optional) Get domains created after this JavaScript timestamp.
• domains_sort_order (string, optional) Sort order for domains based on creation date.
• filter_by_git_branch (string, optional) Specify the branch to filter domains associated with that branch.
• filter_by_redirect_target (string, optional) Specify the redirect target to filter domains. Useful for targeting specific redirections.
• filter_by_verification_status (string, optional) Filter domains by their verification status (e.g., verified, unverified).
• filter_production_domains (string, optional) Set to ‘true’ to filter only production domains; otherwise, returns all.
• filter_target_domain (string, optional) Specify ‘production’ or ‘preview’ to filter domains based on their target environment.
• include_redirect_domains (string, optional) Specify whether to include redirect project domains. Use “true” to include (default), “false” to exclude.
• max_domains_to_list (number, optional) The maximum number of domains to list in the response, with a maximum value of 100.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug representing the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.FetchProjectDomain

Fetch domain details for a specific project.

Parameters

• project_domain_name (string, required) The name of the project’s domain to fetch details for.
• project_id_or_name (string, required) The unique project identifier or the project name for fetching domain details.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of.
• team_slug (string, optional) The slug of the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateProjectDomainConfig

Update a project’s domain configuration.

Parameters

• project_domain_name (string, required) The project domain name to be updated. Example: ‘example.com’.
• project_identifier_or_name (string, required) The unique project identifier or the project name used to update domain configuration.
• linked_git_branch (string, optional) The Git branch to associate with the project domain.
• redirect_status_code (integer, optional) HTTP status code for the domain redirect. Acceptable values are 301, 302, 307, 308, or None if no redirect is required.
• redirect_target_domain (string, optional) Specify the target destination domain for the redirect of a project domain.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug identifier for the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveProjectDomain

Removes a domain from a specified project.

Parameters

• project_domain_name (string, required) The domain name of the project to be removed.
• project_id_or_name (string, required) The unique project identifier or name to specify which project’s domain is to be removed.
• remove_redirects (boolean, optional) Set to true to remove all domains from the project that redirect to the domain being removed.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is performed.
• team_slug (string, optional) The slug identifier of the team to perform the request on behalf of. Used to specify which team’s project domain should be removed.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AddProjectDomain

Add a domain to a specified Vercel project.

Parameters

• project_domain_name (string, required) The domain name to be added to the specified Vercel project.
• project_identifier_or_name (string, required) The unique identifier or name of the project to which the domain will be added.
• custom_environment_id (string, optional) The unique custom environment identifier within the project.
• git_branch_to_link_domain (string, optional) The Git branch to associate with the project domain when adding it to a Vercel project. This allows the domain to be tied to a specific branch in the repository.
• redirect_status_code (integer, optional) HTTP status code for redirecting the domain. Options are: 301, 302, 307, 308, or None.
• redirect_target_domain (string, optional) Specify the target destination domain to redirect to.
• team_identifier (string, optional) The identifier of the team for which the request is made. This ensures the request is executed on behalf of the specified team.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. This identifies the team context for the domain addition.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.MoveProjectDomain

Transfer a domain from one project to another.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) Provide the unique project identifier or the project name for the domain transfer. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• project_domain_name (string, optional) The domain name of the project to be moved to another project. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug for the team on whose behalf the request is made. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.VerifyProjectDomain

Verify the status of a project domain’s verification challenge.

Parameters

• project_id_or_name (string, required) The unique project identifier or the project name to verify the domain for.
• verify_domain_name (string, required) The domain name you want to verify for the project.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. Provide as a string.
• team_slug (string, optional) The Team slug used to perform the verification request on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetProjectEnvironmentVariables

Retrieve environment variables for a specified project.

Parameters

• project_id_or_name (string, required) The unique identifier or name of the project to retrieve environment variables for.
• caller_source (string, optional) Specify the source making the API call.
• custom_environment_id (string, optional) The unique custom environment identifier within the project. Use this to specify a specific custom environment.
• custom_environment_slug (string, optional) The custom environment slug (name) within the project to filter specific settings.
• decrypt_values (string, optional) Set to ‘true’ to decrypt environment variable values. Use ‘false’ to keep them encrypted.
• filter_by_git_branch (string, optional) Specify the git branch to filter the environment variable results. Must have target set to ‘preview’.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The Team slug to perform the request on behalf of. Use this to specify the team context for the request.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateProjectEnvironmentVariables

Create or update environment variables for a Vercel project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_identifier_or_name (string, optional) The unique identifier or name of the Vercel project to create or update environment variables for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• allow_override_existing_variable (string, optional) Allows updating the value of an existing environment variable if set to true. Only used when mode is ‘execute’.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of, specified as a string. Only used when mode is ‘execute’.
• team_slug (string, optional) The Team slug for the project. Used to perform the request on behalf of a specific team. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveProjectEnvironmentVariable

Retrieve the environment variable for a given project.

Parameters

• environment_variable_id (string, required) The unique ID for the environment variable to retrieve its decrypted value.
• project_identifier_or_name (string, required) The unique identifier or name of the project to retrieve its environment variable.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug for the team to perform the request on behalf of. This identifies the team in a user-friendly way.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteProjectEnvVariable

Delete a project’s specific environment variable.

Parameters

• environment_variable_identifier (string, required) The unique identifier of the environment variable to be deleted.
• project_identifier_or_name (string, required) The unique project identifier or name to identify the target project for which the environment variable should be deleted.
• custom_environment_identifier (string, optional) The unique custom environment identifier within the project.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of.
• team_slug (string, optional) The Team slug used to perform the request on behalf of a team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.EditProjectEnvironmentVariable

Edit a specific environment variable for a project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) Specify the unique project identifier or the project name. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• environment_variable_id (string, optional) The unique environment variable identifier for the Vercel project. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The identifier for the team on whose behalf the request is made. This is usually a URL-friendly name for the team. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteProjectEnvVariables

Delete multiple environment variables from a Vercel project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) The unique project identifier or the project name to specify which project to delete variables from. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of when deleting environment variables. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team on whose behalf the request is performed. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UploadClientCertToProject

Upload a client certificate for mTLS authentication.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id_or_name (string, optional) The unique identifier or name of the Vercel project to upload the client certificate to. This is required to specify which project the mTLS certificate should be associated with. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The string identifier of the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team on whose behalf the request is made. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetRollingReleaseBillingStatus

Get the billing status for a project’s rolling releases.

Parameters

• project_id_or_name (string, required) Project ID or name, URL-encoded, to identify the project for which to retrieve billing status.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug representation of the team to perform the request for. Used to specify which team’s billing status is being queried.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetRollingReleaseConfig

Fetch the rolling releases configuration for a project.

Parameters

• project_identifier (string, required) The project ID or name, URL-encoded, to identify the project for the configuration request.
• team_identifier (string, optional) The unique identifier for the Team on whose behalf the request is made.
• team_slug (string, optional) The slug representing the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DisableRollingReleases

Disable rolling releases for a Vercel project.

Parameters

• project_id_or_name (string, required) Project ID or URL-encoded name to specify the Vercel project.
• team_identifier (string, optional) The identifier of the team to execute the request on behalf of.
• team_slug (string, optional) The slug identifying the team to perform the request on behalf of. This should be a string value.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateRollingReleaseConfig

Update or disable rolling releases for a Vercel project.

Parameters

• project_id_or_name (string, required) Project ID or name (URL-encoded) for updating rolling release settings.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug identifying the team for which the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetRollingRelease

Retrieve the rolling release for a specific project.

Parameters

• project_id_or_name (string, required) The project ID or URL-encoded project name to identify the specific project.
• filter_by_release_state (string, optional) Filter the rolling release by its state: ACTIVE, COMPLETE, or ABORTED.
• team_identifier (string, optional) The unique identifier of the team on whose behalf the request is made.
• team_slug (string, optional) The slug that identifies the team on whose behalf the request is made. This is required for team-specific data access.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AdvanceRolloutStage

Advance a rollout to the next stage when manual approval is required.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_identifier (string, optional) Project ID or URL-encoded project name to identify the project. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The Team identifier used for performing the request on behalf of the specified team. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team for which the rollout action will be performed. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ForceCompleteRollingRelease

Complete a rolling release to serve 100% traffic from canary.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_identifier (string, optional) The project ID or URL-encoded project name in Vercel. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is performed. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug of the team for which the request is performed. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.InitiateProjectTransfer

Initiate a project transfer request between teams.

Parameters

• project_id_or_name (string, required) The ID or name of the project to transfer between teams.
• team_identifier (string, optional) The unique identifier of the team initiating the project transfer.
• team_slug (string, optional) The Team slug to perform the project transfer request on behalf of. This is a unique identifier for the team on Vercel.
• webhook_callback_url (string, optional) The URL to send a webhook to when the project transfer is accepted.
• webhook_signing_secret (string, optional) The secret key used to sign the webhook payload with HMAC-SHA256 for security verification.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.AcceptProjectTransfer

Accept a project transfer request on Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_transfer_code (string, optional) The unique code of the project transfer request, required to accept the transfer. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The team slug used to perform the project transfer request on behalf of a specific team. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateProjectProtectionBypass

Update the deployment protection bypass for a Vercel project.

Parameters

• project_id_or_name (string, required) The unique Vercel project identifier or project name to update the protection bypass for.
• create_new_automation_bypass (boolean, optional) Create a new automation bypass after revoking the current secret.
• optional_secret_value (string, optional) Optional value of the secret to generate; omit for OAuth2 tokens.
• revoke_automation_bypass (string, optional) Secret value of the automation bypass to be revoked for a Vercel project.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PromoteDeploymentToProduction

Promotes a deployment to production without rebuilding it.

Parameters

• deployment_identifier (string, required) The ID of the deployment to be promoted to production. It should be a valid string representing the deployment ID.
• project_id (string, required) The unique identifier of the project associated with the deployment to promote.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made. It should be a string value.
• team_slug (string, optional) The slug of the team to perform the promotion request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetLastPromoteAliasesStatus

Retrieve aliases and their mapping status from last promote request.

Parameters

• project_id (string, required) Specify the Project ID to filter the promote aliases related to that specific project.
• aliases_created_before_timestamp (number, optional) Get aliases created before this epoch timestamp.
• filter_failed_aliases (boolean, optional) Set to true to filter results to only include aliases that failed to map to the requested deployment.
• get_aliases_created_after_epoch (number, optional) Get aliases created after the specified epoch timestamp.
• max_aliases_to_list (number, optional) Specify the maximum number of aliases to list from the request. The maximum allowed is 100.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of. Must be a string.
• team_slug (string, optional) The slug representing the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.PauseProject

Pause a Vercel project by its ID.

Parameters

• project_id (string, required) The unique identifier for the Vercel project you wish to pause.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The Team slug to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UnpauseProject

Unpause a Vercel project using its project ID.

Parameters

• project_id (string, required) The unique identifier for the Vercel project to be unpaused.
• team_identifier (string, optional) The identifier for the team on behalf of which the request is performed. Used to specify the target team in Vercel.
• team_slug (string, optional) The slug identifying the team to perform the request on behalf of. Required for targeting the correct team’s project.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateAttackChallengeMode

Updates Attack Challenge mode setting for a project.

Parameters

• enable_attack_challenge_mode (boolean, required) Set to true to enable Attack Challenge mode; false to disable it.
• project_id (string, required) The unique identifier of the project to update the Attack Challenge mode for.
• attack_mode_active_until (number, optional) The UNIX timestamp indicating when the Attack Challenge mode should be active until. Specify this to control the duration of the mode being enabled.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made.
• team_slug (string, optional) The unique slug of the team on behalf of which the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.SetFirewallConfiguration

Update firewall configuration with specified rules.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id (string, optional) The unique identifier for the project to configure the firewall settings. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug representing the team for which the firewall configuration will be updated. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateFirewallConfig

Modify the existing firewall config for a project.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_identifier (string, optional) The unique identifier for the project to modify the firewall config. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) The Team slug used to identify the team for the request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetFirewallConfig

Retrieve the active firewall configuration for a project.

Parameters

• firewall_configuration_version (string, required) The deployed version of the firewall configuration to retrieve.
• project_id (string, required) The unique identifier for the project whose firewall configuration is being retrieved.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of.
• team_slug (string, optional) The team slug to perform the request on behalf of. It identifies the specific team by its slug name.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetActiveAttackStatus

Retrieve active attack data from the Vercel firewall.

Parameters

• project_id (string, required) The unique identifier of the project to retrieve attack data for.
• active_days_since (number, optional) Number of days in the past to look for active attack data. Defaults to 1 day if not specified.
• team_identifier (string, optional) The unique identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. This identifies which team to target for the retrieval of attack data within Vercel’s system.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveProjectBypassRules

Retrieve the bypass rules for a specified project.

Parameters

• project_id (string, required) The unique identifier of the project for which to retrieve bypass rules.
• filter_by_domain (string, optional) Specify the domain to filter bypass rules. This filters rules related to the given domain.
• filter_by_project_scope (boolean, optional) Set to true to filter results by project-scoped rules.
• filter_by_source_ip (string, optional) Specify a source IP to filter the system bypass rules for a project.
• pagination_offset (string, optional) Pagination offset, retrieving results after the specified ID.
• result_limit (number, optional) The maximum number of rules to retrieve. Specify as a number. This is useful for controlling the volume of data returned.
• team_identifier (string, optional) The unique identifier of the team on whose behalf the request is performed.
• team_slug (string, optional) The slug representing the team to make the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateFirewallBypassRule

Create a new firewall bypass rule.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id (string, optional) The identifier for the project to create a bypass rule for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug identifier of the team for which the bypass rule is created. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveBypassRule

Removes a bypass rule from the firewall.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• project_id (string, optional) The unique identifier for the project from which to remove the bypass rule. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The Team slug indicating which team to perform the request on behalf of. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateIntegrationStore

Create integration stores for FREE and PAID billing plans.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The unique identifier of the team on whose behalf the request is being made. Only used when mode is ‘execute’.
• team_slug (string, optional) The unique slug of the team for which the integration store is being created. This identifies the team on behalf of which the request is made. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetTeamMembers

Retrieve a list of team members for a specified team.

Parameters

• added_since_timestamp (number, optional) Include team members added since this timestamp in milliseconds.
• exclude_project_id (string, optional) Exclude members belonging to the specified project using the project ID.
• filter_by_team_role (string, optional) Return members with the specified team role. Valid roles include OWNER, MEMBER, DEVELOPER, SECURITY, BILLING, VIEWER, VIEWER_FOR_PLUS, and CONTRIBUTOR.
• include_members_until (number, optional) Timestamp in milliseconds to include members added until this time.
• member_limit (number, optional) Specify the maximum number of team members to return in a single request.
• project_id_for_eligible_members (string, optional) Include team members eligible for the specified project by providing the project ID.
• search_team_members (string, optional) Search for team members by their name, username, or email.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.InviteUserToTeam

Invite a user to join a Vercel team.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_id (string, optional) The unique identifier for the Vercel team to which the user is being invited. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RequestTeamAccess

Request to join a team on Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_id (string, optional) The unique identifier of the Vercel team you want to join. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CheckTeamAccessStatus

Check the status of a team access request.

Parameters

• team_id (string, required) The unique identifier for the team whose access request status is being checked.
• user_id (string, required) The ID of the user whose team access request status is being checked. Leave empty to use the authenticated user.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.JoinVercelTeam

Join a Vercel team using invite code or team ID.

Parameters

• team_id (string, required) The unique ID of the Vercel team to join. Use this if you have the team ID instead of an invite code.
• team_invite_code (string, optional) The invite code used to join a specific Vercel team. This is a string value provided to new members for team access.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateTeamMember

Update a team member’s role or confirm membership.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• member_id (string, optional) The unique identifier for the team member to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_id (string, optional) The unique ID of the team where the member’s role or membership status will be updated. It is required to identify the specific team. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveTeamMember

Remove or dismiss a team member or leave a team.

Parameters

• team_id (string, required) The ID of the team from which to remove or dismiss a member, or leave.
• user_id (string, required) The unique identifier of the user to be removed or dismissed from the team.
• new_default_team_id (string, optional) The ID of the team to set as the new default team for the Northstar user when removing another team member.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetTeamInfo

Retrieve information for a specified team using teamId.

Parameters

• team_identifier (string, required) The unique identifier for the team to retrieve information about.
• team_slug (string, optional) A string representing the unique slug of the team. Used to specify which team’s data to retrieve.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateTeamInfo

Update information of a specified team.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The unique identifier for the team whose information you want to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_slug (string, optional) The unique slug for the team used to perform the request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetUserTeams

Retrieve all teams for the authenticated user.

Parameters

• max_number_of_teams (number, optional) Maximum number of teams to return in the response.
• teams_created_since_timestamp (number, optional) Timestamp in milliseconds to include only teams created since this time.
• teams_created_until (number, optional) Timestamp in milliseconds to filter Teams created until the specified time.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateVercelTeam

Create a new team in your Vercel account.

Parameters

• team_slug (string, required) The desired slug for the new team, used as a team identifier.
• session_landing_page (string, optional) The URL of the landing page where the session started. This is used for session attribution on Vercel.
• session_referrer (string, optional) Referrer URL for the session initiating the team creation process.
• signup_referrer_page (string, optional) The referrer URL of the page before the signup page, used for tracking attribution.
• team_name (string, optional) The desired name for the Team. If not provided, it will be generated from the slug.
• utm_campaign_name (string, optional) Specifies the UTM campaign name for tracking purposes when creating a team.
• utm_medium (string, optional) The medium through which the user arrived, such as email, social, or cpc.
• utm_source (string, optional) The UTM source identifier, indicating where the traffic originates from, such as a search engine or newsletter.
• utm_term (string, optional) The UTM term used for tracking specific keywords in marketing campaigns.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteTeam

Delete a team from your Vercel account.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The unique identifier of the team to be deleted in your Vercel account. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• new_default_team_id (string, optional) Specify the team ID to set as the new default after deletion. Only used when mode is ‘execute’.
• team_slug (string, optional) The slug of the team you want to delete. Used to identify the team for the delete operation. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteTeamInviteCode

Delete an active team invite code in Vercel.

Parameters

• team_identifier (string, required) The unique identifier of the team to perform the operation for in Vercel.
• team_invite_code_id (string, required) The ID of the team invite code to be deleted in Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveAuthTokens

Retrieve a list of the current user’s authentication tokens.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateAuthToken

Create a new authentication token for the user.

Parameters

• token_name (string, required) A descriptive name for the authentication token. This helps in identifying the token’s purpose or context.
• expiration_timestamp (number, optional) The expiration time for the token, specified as a Unix timestamp. This defines when the token will no longer be valid.
• team_identifier (string, optional) The unique identifier for the Team to perform the request on behalf of.
• team_slug (string, optional) The slug of the Team to perform the request on behalf of. This identifies the specific team within your Vercel account.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveAuthTokenMetadata

Retrieve metadata about an authentication token.

Parameters

• authentication_token_identifier (string, required) The ID of the token to retrieve metadata for. Use “current” for the token that the current request is authenticated with.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.InvalidateAuthToken

Invalidate an authentication token to revoke access.

Parameters

• token_id (string, required) The ID of the token to invalidate. Use ‘current’ to invalidate the token used for this request.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetAuthenticatedUserInfo

Retrieve current authenticated user’s information.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.InitiateUserDeletion

Initiates user deletion and sends a confirmation email.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.CreateVercelWebhook

Create a new webhook in Vercel projects.

Parameters

• events_list (array[string], required) A list of event types that trigger the webhook. Must be an array of strings, each representing an event.
• webhook_url (string, required) The target URL where the webhook will send POST requests. It should be a valid and publicly accessible URL.
• project_ids (array[string], optional) List of project IDs for which the webhook is being created. Each ID should be a string.
• team_identifier (string, optional) The identifier for the team on whose behalf the request is performed.
• team_slug (string, optional) The slug representing the Vercel team to target the request for. It identifies the team on whose behalf the webhook is created.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListVercelWebhooks

Retrieve a list of webhooks from Vercel.

Parameters

• project_id (string, optional) The unique identifier for the project to retrieve webhooks from.
• team_identifier (string, optional) The identifier for the Vercel team to perform the request on behalf of.
• team_slug (string, optional) The slug identifier for the team to perform the request on behalf of. This is used to specify which team’s webhooks you want to retrieve.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetWebhook

Retrieve details of a specific webhook using its ID.

Parameters

• webhook_id (string, required) The unique identifier of the webhook to retrieve details for.
• team_identifier (string, optional) The identifier of the team on whose behalf the request is made. Required to specify the team context.
• team_slug (string, optional) The slug representing the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteVercelWebhook

Delete a specific webhook from Vercel.

Parameters

• webhook_id (string, required) The unique identifier of the webhook to be deleted.
• team_identifier (string, optional) The Team identifier used to perform the request on behalf of the specified team.
• team_slug (string, optional) The slug representing the Vercel team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetDeploymentAliases

Fetch aliases for a specific deployment by ID.

Parameters

• deployment_id (string, required) The ID of the deployment for which to list the aliases.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of. It is required to retrieve deployment aliases.
• team_slug (string, optional) The slug representing the team on whose behalf the request is made.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.SetDeploymentAlias

Assigns a new alias to a Vercel deployment.

Parameters

• deployment_id (string, required) The ID of the deployment to assign the alias to. This identifier is crucial for specifying which deployment will receive the new alias.
• deployment_alias (string, optional) The alias to assign to the specified Vercel deployment.
• redirect_hostname (string, optional) Hostname to redirect the alias to, using status code 307. This will override the deployment ID from the URL.
• team_identifier (string, optional) The identifier of the team to perform the alias assignment on behalf of. Required for team-based operations.
• team_slug (string, optional) The Team slug to perform the request on behalf of. This identifies the team for the deployment operation.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListAliases

Retrieve a list of Vercel aliases for a user or team.

Parameters

• aliases_created_after_timestamp (number, optional) Get aliases created after this JavaScript timestamp. Use a timestamp in milliseconds since the epoch.
• created_after_timestamp (number, optional) Return aliases created after this UNIX timestamp.
• filter_by_domain (string, optional) Return only aliases associated with the specified domain name.
• get_aliases_before_timestamp (number, optional) Retrieve aliases created before the specified JavaScript timestamp.
• maximum_aliases_to_list (number, optional) Specifies the maximum number of aliases to retrieve in the request.
• project_id_filter (string, optional) Filter to list aliases associated with the specified project ID.
• rollback_deployment_id (string, optional) Specify the deployment ID to get aliases that would be rolled back for that deployment.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of. Use this to specify the team whose aliases should be listed.
• team_slug (string, optional) The slug identifier for the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveVercelAlias

Retrieve Vercel alias information for a host name or alias ID.

Parameters

• alias_identifier (string, required) The alias or alias ID of the Vercel entity to retrieve.
• after_timestamp (number, optional) Get the alias only if it was created after this JavaScript timestamp (milliseconds since epoch).
• created_after_timestamp (number, optional) Retrieve the alias only if it was created after the specified timestamp (in milliseconds).
• created_before_timestamp (number, optional) Retrieve the alias only if it was created before this JavaScript timestamp.
• project_id (string, optional) Fetch the alias only if it is associated with this project ID in Vercel.
• team_identifier (string, optional) The Team identifier to perform the request on behalf of.
• team_slug (string, optional) The Team slug to perform the request on behalf of. This specifies the team context for the alias retrieval.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteAliasById

Delete a specific alias by its ID.

Parameters

• alias_id_to_remove (string, required) The unique ID or alias of the item to be removed from Vercel.
• team_identifier (string, optional) The unique identifier for the team to execute the request.
• team_slug (string, optional) The unique slug of the team for which the alias will be deleted.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UpdateUrlProtectionBypass

Update the protection bypass for a Vercel URL.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• alias_or_deployment_id (string, optional) The ID of the alias or deployment for which to update the protection bypass. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• team_identifier (string, optional) The unique identifier of the team on whose behalf the request is made. Only used when mode is ‘execute’.
• team_slug (string, optional) The team slug representing which team the request should be performed for in Vercel. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveCertificateById

Retrieve a Vercel certificate using its ID.

Parameters

• certificate_id (string, required) The unique identifier of the certificate to be retrieved from Vercel.
• team_identifier (string, optional) The identifier of the team to perform the request on behalf of.
• team_slug (string, optional) The slug identifying the team to perform the request on behalf of.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RemoveCertificate

Remove a certificate from Vercel using its ID.

Parameters

• certificate_id (string, required) The unique identifier of the certificate to remove.
• team_identifier (string, optional) The identifier for the team on whose behalf the removal request is made.
• team_slug (string, optional) The slug of the team to perform the request on behalf of in Vercel.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.IssueVercelCertificate

Request a new SSL certificate from Vercel.

Parameters

• common_names_for_certificate (array[string], optional) List of common names (domains) that the SSL certificate should be issued for.
• team_id (string, optional) The identifier for the Vercel team on whose behalf the certificate request is made.
• team_slug (string, optional) The team slug identifier for cert request on behalf of a specific team.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.UploadCertificate

Uploads a certificate to Vercel.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• team_identifier (string, optional) The unique identifier for the team to perform the request on behalf of. Only used when mode is ‘execute’.
• team_slug (string, optional) Specify the team slug to perform the request on behalf of in Vercel. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.GetVercelDeploymentFiles

Retrieve the file structure of a Vercel deployment.

Parameters

• deployment_identifier (string, required) The unique identifier for the deployment to retrieve its file structure.
• team_identifier (string, optional) The identifier of the team on whose behalf the request is made.
• team_slug (string, optional) The slug of the team performing the request. It is required for team-scoped requests.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.RetrieveDeploymentFileContents

Retrieve the contents of a file from a Vercel deployment.

Parameters

• deployment_unique_identifier (string, required) The unique identifier for the deployment from which to retrieve the file.
• file_identifier (string, required) The unique identifier for the file you want to retrieve from the deployment.
• file_path (string, optional) Path to the file to fetch, applicable only for Git-based deployments.
• team_identifier (string, optional) The identifier of the team to make the request on behalf of.
• team_slug (string, optional) The slug of the team to perform the request on behalf of. Specify which team’s context to use.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.ListVercelDeployments

Retrieve deployments from Vercel for a user or team.

Parameters

• branch_name_filter (string, optional) Specify the branch name to filter deployments.
• created_after_timestamp (number, optional) Retrieve deployments created after this Date timestamp. Defaults to current time if not specified.
• deployment_name (string, optional) The name of the deployment to filter results.
• deployment_since_timestamp (number, optional) Retrieve deployments created after this JavaScript timestamp.
• deployment_state_filter (string, optional) Filter deployments by their state, such as BUILDING, ERROR, INITIALIZING, QUEUED, READY, or CANCELED.
• fetch_deployments_before_timestamp (number, optional) Specify a JavaScript timestamp to retrieve deployments created before this time.
• filter_by_environment (string, optional) Specify the environment to filter deployments (e.g., ‘production’, ‘staging’).
• filter_by_project_id (string, optional) Filter deployments using a specific project ID or name.
• filter_by_project_ids (array[string], optional) Filter deployments from specified project IDs. Cannot be used with the ‘filter_by_project_id’ argument.
• filter_by_rollback_candidacy (boolean, optional) Set to true to filter and include only rollback candidate deployments.
• filter_by_sha (string, optional) Filter deployments based on the specific SHA value.
• get_deployments_before_timestamp (number, optional) A timestamp to get deployments created before a specific date. Useful for filtering older deployments. Defaults to the current time if not specified.
• maximum_deployments_to_list (number, optional) Sets the maximum number of deployments to retrieve in one request.
• team_identifier (string, optional) The identifier for the team to perform the request on behalf of. Use when filtering deployments by team.
• team_slug (string, optional) The team slug to perform the request on behalf of. Specify which team’s deployments to retrieve.
• user_filter (string, optional) Filter deployments by the user who created them. Provide a username or user ID.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

VercelApi.DeleteDeployment

Delete a Vercel deployment using its ID or URL.

Parameters

• deployment_id (string, required) The ID of the deployment to be deleted. Use this if not providing a URL.
• deployment_url (string, optional) A Deployment or Alias URL for identifying the deployment to delete. The ID will be ignored if this is provided.
• team_identifier (string, optional) The unique identifier for the team on whose behalf the request is executed.
• team_slug (string, optional) The Team slug to perform the deletion on behalf of. Specify which team’s deployment to delete.

Secrets

This tool requires the following secrets: VERCEL_ACCESS_TOKEN (learn how to configure secrets)

To obtain a Vercel access token:

1. Log in to your Vercel Dashboard 
2. Go to Settings → Tokens
3. Click “Create” and provide a descriptive name
4. Set the desired scope and click “Create Token”
5. Copy and securely store the token (it won’t be displayed again)

For detailed instructions, see the Vercel API Access Token guide .

Reference

Below is a reference of enumerations used by some of the tools in the VercelApi MCP Server:

ToolMode

• GET_REQUEST_SCHEMA: get_request_schema
• EXECUTE: execute

pip install arcade_vercel_api