Vercel API

Accept a project transfer request on Vercel. Use this tool to accept a project transfer request that has been initiated by another team on Vercel. This process requires a transfer code, which is generated by the initiating team. Call this tool when you need to finalize the transfer of a project to your team. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Adds a token to an existing Edge Config. This tool is used to add a new token to an existing Edge Config in Vercel. It should be called when you need to update the configuration with additional access or permissions via token.

Add a new apex domain with Vercel for the user. Use this tool to add a new apex domain name with Vercel for the authenticating user. This tool is not meant for transferring domains from external registrars to Vercel. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Add a domain to a specified Vercel project. This tool adds a domain to a Vercel project by specifying the domain name and project identifier (id or name). If the domain is unverified, the response will indicate it needs verification. If the domain already exists, a 400 error will occur.

Add a new member to a Vercel project. Use this tool to add a new member to a Vercel project using the project's ID or name. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Advance a rollout to the next stage when manual approval is required. Use this tool to advance a release rollout to the next stage when manual approval is enabled in Vercel's rolling releases configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Cancel a currently building deployment. Use this tool to cancel a deployment that is currently in progress by providing its ID.

Check if a domain name is available for purchase. This tool checks the availability of a domain name for purchase, using the deprecated 'checkDomainStatus' endpoint from Vercel. Note that this endpoint has been replaced with 'Get availability for a domain.'

Check availability for multiple domains. Use this tool to check if multiple domains are available for purchase. This can help in planning before acquiring domains via the buying endpoints.

Retrieve the transfer status of a domain. Use this tool to check the current transfer status of a specific domain, providing insights into progress or any issues.

Check the status of Remote Caching. This tool is used to determine if Remote Caching is currently enabled, disabled, or disabled due to usage limits. It provides a quick way to verify the status of caching in Vercel.

Check the status of a team access request. Use this tool to check the status of a user's request to join a team on Vercel. The tool will return the status of the request or a 404 error if the request was declined. If no user ID is provided, it returns the status for the authenticated user.

Connect an integration resource to a Vercel project. This tool connects a provisioned integration resource to a specific Vercel project. It should be used when you need to establish a link between a resource and a project in Vercel. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new access group on Vercel. This tool should be called when there is a need to create a new access group in Vercel. It facilitates setting up user permissions and organization in projects. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a project within a specific access group.

Create a new authentication token for the user. Use this tool to generate and retrieve a new authentication token for the currently authenticated user. Ensure to save the token for subsequent API requests, as it is only provided once.

Create a custom environment for your Vercel project. This tool creates a custom environment in a specified Vercel project, excluding 'Production' or 'Preview' as names. Use it to set up tailored project environments.

Creates a DNS record for a domain. Use this tool to create a DNS record for a specified domain. It helps manage DNS configurations by adding new records as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new Edge Configuration. This tool is used to create a new Edge Config on Vercel. It should be called when there's a need to set up or initialize a configuration for edge functions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create one or multiple experimentation items. This tool is used to create one or multiple experimentation items for a specific installation. It should be called when you need to add experimentation data to a resource tied to an integration configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new firewall bypass rule. This tool should be called to create new system bypass rules in the firewall. Useful for configuring security exceptions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Sets up an Integration log drain for Vercel. This tool creates an Integration log drain in Vercel, accessible via an OAuth2 client. It should be used when you need to tie log drains to specific integrations within Vercel. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create integration stores for FREE and PAID billing plans. This tool creates integration stores on Vercel for both free and paid plans, handling billing automatically. It validates configurations, discovers free plans, and creates billing authorizations for paid resources. It should be called when you need to provision integration storage resources while managing billing. Requires admin access and, for paid plans, a valid payment method. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new deployment check using Vercel API. Use this tool to initiate a new check for a specific deployment in Vercel. This requires providing a deployment ID and must be authorized with OAuth2 to avoid errors.

Create a new project with specified configurations. This tool creates a new project using the provided configurations. You can specify only the project name or add additional configurations to customize the project further. Call this tool when you need to initialize a new project. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create or update environment variables for a Vercel project. This tool creates or updates one or more environment variables for a specified Vercel project. The project can be identified by its `id` or `name`. The tool allows specifying the `key`, `value`, `type`, and `target` of the environment variables. If `upsert=true` is included, existing variables will be updated instead of creating new ones. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new deployment on Vercel. This tool helps create a new deployment on Vercel, ideal for deploying projects that aren't directly linked to a git repository. Use it to initiate a deployment by providing necessary files either as references or inlined content. It also allows redeployment of previous deployments by specifying a deployment ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new team in your Vercel account. Use this tool to create a new team under your Vercel account by specifying a team slug, and optionally a team name. This is useful for organizing projects and members under a unified group.

Create a new webhook in Vercel projects. This tool is used to create a new webhook in Vercel. It should be called when you need to set up automated notifications or integrations by creating a webhook within your Vercel projects.

Deletes an access group by ID or name. Use this tool to delete an access group on Vercel by specifying the group's ID or name. It is useful for managing and updating your access control configurations.

Delete a specified access group project on Vercel. Use this tool to delete a specific access group project on Vercel by providing the access group ID or name and project ID.

Delete a specific alias by its ID. Use this tool to delete an alias from Vercel using its unique ID.

Marks cache tags as deleted to revalidate associated entries. Use this tool to delete cache entries marked by specific tags, causing associated entries to be revalidated. This should be employed cautiously due to potential cache stampede risks. It's useful when the origin returns status codes like 404 or 410. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Delete a Vercel deployment using its ID or URL. Use this tool to delete a Vercel deployment by providing the deployment's `id` or `url`. Useful for managing and cleaning up deployments.

Delete a Vercel Edge Config by ID. Use this tool to delete a specific Edge Config in Vercel by providing its unique ID. This will remove the configuration from the system.

Deletes an existing Edge Config schema. Use this tool to delete the schema of an existing Edge Config in a Vercel project. This can be useful for managing and updating Edge Configurations efficiently.

Delete tokens from an existing Edge Config. Use this tool to delete one or more tokens associated with a specific Edge Config in Vercel. It is useful for managing and securing access by removing outdated or compromised tokens.

Delete an existing experimentation item. This tool deletes a specific experimentation item identified by its itemId within the given integration configuration and resource.

Delete an Integration log drain by ID. Use this tool to delete a specific Integration log drain by its ID. Applicable when you need to remove log drains associated with an integration, especially under OAuth2 constraints.

Delete a resource from an integration by ID. Use this tool to delete a resource associated with a specific integration installation. You need the installation and resource IDs to successfully execute this operation.

Delete a Vercel project by ID or name. Use this tool to delete a specific Vercel project by providing either the project's ID or name. Ideal for cleaning up unused projects or managing active projects through automation.

Delete a project's specific environment variable. This tool deletes a specified environment variable from a project by using the environment variable's identifier. You can specify the project using its ID or name.

Delete multiple environment variables from a Vercel project. Use this tool to delete several environment variables for a specific Vercel project at once. It's useful when managing project configurations and needing to remove obsolete or sensitive data efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Delete a team from your Vercel account. Use this tool to send a request to delete a specific team under your Vercel account by providing the team ID. Optional reasons for deletion can be included. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Delete an active team invite code in Vercel. Use this tool to remove an active team invite code for a specified team on Vercel. Call this tool when you need to cancel or invalidate an existing invite.

Delete a domain from Vercel and remove associated aliases. Use this tool to delete a previously registered domain from Vercel. This action also removes any aliases linked to the domain.

Delete a specific webhook from Vercel. This tool deletes a specified webhook from a Vercel project using its unique ID. It should be called when you need to remove an existing webhook integration.

Disable rolling releases for a Vercel project. Use this tool to disable future rolling releases for a specified Vercel project. Note that this will not affect any current rollouts in progress. For ongoing rollouts, additional actions like completing or aborting may be required.

Check if a domain is available for purchase. This tool checks the availability of a specified domain. If the domain is available, it can be purchased using the appropriate Vercel endpoints.

Downloads a cache artifact using its hash identifier. Use this tool to retrieve a cache artifact from Vercel by specifying its hash. The artifact is returned as an octet-stream. Ensure to verify the content-length header and response body for correctness.

Edit a specific environment variable for a project. Use this tool to modify an environment variable of a Vercel project by providing the variable's ID and the project's ID or name. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Exchange OAuth code for an OIDC token to authenticate users. Call this tool to exchange an OAuth authorization code for an OIDC token during the SSO process. This helps authenticate users in Vercel without persisting the token. Refer to the Vercel SSO documentation for more details.

Fetch the best account or user's contact info. Use this tool to retrieve detailed contact information for a user's account, ideal for scenarios where you need user engagement or account verification.

Retrieve build logs for a specific deployment by ID. Use this tool to access the build logs or events of a deployment using its deployment ID and build ID. It can stream logs continuously or return them in JSON format based on input parameters.

Retrieve price data for a specific domain from Vercel. Use this tool to get pricing information for a particular domain. It should be called when you need to verify or compare the cost of registering or renewing a domain via Vercel's registrar service.

Fetch a domain's transfer status or availability. Use this tool to check if a domain transfer is available or to obtain the transfer status if a transfer is in progress.

Fetch a resource using its partner ID. Use this tool to get detailed information about a specific resource by providing the integration configuration and resource IDs.

Fetch domain details for a specific project. Use this tool to obtain detailed information about a project's domain using the project's ID or name and the domain name.

Complete a rolling release to serve 100% traffic from canary. This tool should be used to force-complete a rolling release in Vercel projects, ensuring that the canary deployment is now serving 100% of the traffic. Call this tool when you need to finalize a rolling release deployment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Retrieve details of a specific access group project. Use this tool to obtain information about a specific project within an access group by providing the access group identifier or name and the project ID.

Retrieve active attack data from the Vercel firewall. Use this tool to obtain information about any active attacks detected by Vercel's firewall within the specified number of days.

Retrieve current authenticated user's information. Use this tool to obtain details about the currently authenticated user from Vercel.

Retrieve custom environments for a specified project. Use this tool to get custom environments of a project on Vercel. These environments cannot be named 'Production' or 'Preview'.

Fetch aliases for a specific deployment by ID. Retrieves all aliases associated with a given deployment ID. Use this to find or verify domain aliases linked to a specific Vercel deployment.

Retrieve details for a specific deployment check. This tool is used to obtain detailed information about a single check within a specified deployment. Use it when you need insights or results from a specific deployment check.

Retrieve deployment information by ID or URL. Use this tool to get details about a Vercel deployment using either its ID or URL. This is useful for obtaining deployment specifics, especially when the user or team owns the deployment.

Get logs for a specific deployment's runtime. Use this tool to retrieve a stream of runtime logs for a given deployment in a project. This is useful for monitoring and debugging deployment processes.

Retrieve DNS records for a specified domain name. This tool fetches DNS records for a given domain. It returns up to 20 records by default, with additional records available through pagination.

Retrieve the auth code for transferring a domain from Vercel. This tool is used to obtain the auth code needed to transfer a domain from Vercel to another registrar. It should be called when a domain transfer from Vercel is intended.

Retrieve configuration details for a specific domain. This tool calls the Vercel API to get the configuration settings for a given domain. It should be used when you need insights into the current setup or settings of a domain on Vercel.

Retrieve the schema for TLD-specific contact information. Use this tool to get the necessary contact information schema required by specific TLDs for a domain. This is helpful when additional TLD-specific details are needed for domain registration or management.

Retrieve information on a single domain from Vercel. Use this tool to get detailed information about a specific domain associated with a Vercel account or team. This can be useful for managing domains or checking their configuration.

Retrieve information about a domain order by its ID. Use this tool to get detailed information about a specific domain order using its unique ID. It is useful for checking the status and details of a domain order processed through the registrar.

Retrieve domain price and purchase period details. Use this tool to obtain the cost of purchasing a specific domain and the duration of a single purchase period, replacing the deprecated endpoint for domain price checking.

Retrieve Edge Config details from Vercel. Use this tool to obtain configuration details for a specific Edge Config in Vercel. It should be called when you need to access or review settings for an Edge Config using its unique identifier.

Retrieve backups of an Edge Config. This tool retrieves and returns backups for a specified Edge Config. It should be called when there is a need to access or review past configurations of an Edge Config managed by Vercel.

Retrieve a specific Edge Config Item by its identifiers. Use this tool to get details of a specific Edge Config Item using its configuration ID and item key.

Retrieve all items from an Edge Config. Call this tool to obtain all items within a specified Edge Config by providing the Edge Config ID. Useful for accessing configuration details stored in Vercel's Edge Config.

Fetch all Edge Configs from Vercel's service. Use this tool to retrieve a comprehensive list of all Edge Configurations available in a Vercel account.

Retrieve the schema of an Edge Config. This tool is used to obtain the schema details of a specific Edge Config by its ID. It should be called when there's a need to understand the structure or configuration of a given Edge Config.

Retrieve metadata about an Edge Config token. Use this tool to obtain metadata for a specific Edge Config token by providing the edgeConfigId and token. Ideal for understanding token attributes and usage in Edge Config.

Retrieve all tokens of a specific Edge Config. This tool retrieves all tokens related to a specified Edge Config. It should be called when you need to access or manage tokens for an Edge Config identified by its edgeConfigId.

Retrieve the active firewall configuration for a project. This tool is used to obtain the active firewall configuration for a specific project by retrieving the specified version of the configuration.

Retrieve configuration details by ID. Use this tool to fetch the configuration details using a specific ID. The authenticated user or team must own the configuration to access it.

Retrieve all resources for a given installation ID. Use this tool to get all resources associated with a specific integration installation. It requires the installation ID to fetch the relevant information.

Retrieve invoice details and status by ID. This tool retrieves the details and status of an invoice using its ID. Use this when you need specific information about a particular invoice, such as its current status or other details.

Retrieve aliases and their mapping status from last promote request. Call this tool to obtain a list of aliases related to the most recent promote request, along with their current mapping status for a specified project.

Retrieve member role and details for a specific member ID. Use this tool to get the role and additional information for a member using their member ID. It is useful for verifying membership details and roles within installations.

Retrieve environment variables for a specified project. Use this tool to get the environment variables associated with a project by providing its `id` or `name`. Useful for managing and configuring project settings.

Retrieve specific project details using project ID or name. This tool retrieves information about a specific project by using the project ID or name. It's useful for accessing project details from Vercel.

Retrieve a list of registered domains for the user or team. This tool fetches a list of domains registered under the authenticated user or team from Vercel. It is useful for managing or reviewing domain configurations.

Retrieve the rolling release for a specific project. Use this tool to get details about a project's rolling release, including its current status (active, aborted, or completed). Useful when monitoring or managing project deployments.

Get the billing status for a project's rolling releases. This tool retrieves the billing status for a specific project's rolling releases from Vercel. It determines if the project is eligible for configuration under rolling releases based on the team's billing status.

Fetch the rolling releases configuration for a project. Use this tool to obtain the template configuration for future rolling releases in a given project on Vercel. It does not provide settings for already active releases.

Retrieve a list of TLDs supported by Vercel. This tool provides a list of Top-Level Domains (TLDs) that are supported by Vercel. Use this tool to find out which TLDs can be managed or registered through Vercel's platform.

Retrieve information for a specified team using teamId. Use this tool to get detailed information about a team by specifying the teamId. It retrieves the data related to the team, which can include various details pertinent to the team specified.