Skip to main content
Vercel logo
  • Category: developer tools
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 414
  • Triggers: 0
  • Slug: VERCEL
  • Version: 20261101_00

Tools

Slug: VERCEL_ACTIVATE_FIREWALL_CONFIGReturns activated WAF config. Promotes a draft WAF config to an active config

Input Parameters

string
Team slug for the project.
string
Team identifier for the project.
string
required
Project whose draft WAF configuration will be activated.
string
required
configVersion path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_BYPASS_IPCreate System Bypass Rule. Create new system bypass rules

Input Parameters

number
Time to live in milliseconds
string
note body value.
string
slug query value.
string
domain body value.
string
teamId query value.
string
sourceIp body value.
string
required
projectId query value.
boolean
allSources body value.
boolean
If the specified bypass will apply to all domains for a project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_ENVIRONMENT_VARIABLETool to add an environment variable to a Vercel project. Variables only take effect in subsequent deployments — already-running deployments are not updated. Use after confirming the project exists and you need to configure secrets or configuration values across environments before deployment. Example: “Add API_KEY=secret to production”.

Input Parameters

string
required
Name of the environment variable
string
Team slug to perform the request on behalf of
string ("plain" | "encrypted" | "sensitive")
required
Type of the variable storage: ‘plain’ (non-sensitive values), ‘encrypted’ (standard encrypted values visible to project users), or ‘sensitive’ (values that are non-readable once created, only decrypted during builds). NOTE: ‘sensitive’ type variables can only target ‘production’ and ‘preview’ environments - ‘development’ is not allowed.
string
required
Value of the environment variable
array
required
List of environments where this variable should be available. Must be provided as a list even for a single environment. Valid values: ‘production’, ‘preview’, ‘development’. NOTE: When type=‘sensitive’, ‘development’ is NOT allowed - only ‘production’ and ‘preview’ are valid targets for sensitive variables.
string
Team identifier to perform the request on behalf of
boolean
If true, overwrite existing variables with the same key Silently overwrites without confirmation — only set true when user has explicitly confirmed the existing value should be replaced.
string
Optional comment for context
string
required
The unique identifier or name of the project
string
Git branch to scope this variable to
array
List of custom environment identifiers. Must be provided as a list even for a single ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_PROJECT_DOMAINTool to attach a custom domain to a Vercel project. Use when you need to add a domain to a project for production or branch-specific deployments. After adding, the domain must be verified by completing the verification challenges returned in the response.

Input Parameters

string
required
The domain name to add to the project (e.g., ‘www.example.com’, ‘app.mydomain.com’)
string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
string
required
The unique project identifier or project name
string
Target destination domain for redirection. PREREQUISITE: The target domain must already be added to the project first (call this action without redirect parameters to add the target domain, then call again with redirect parameters to add the redirecting domain). When set, requests to this domain will redirect to the specified target domain. IMPORTANT: Cannot be used together with ‘git_branch’ - these are mutually exclusive domain configuration modes.
string
Git branch to associate with this domain. When set, deployments from this branch will be accessible via this domain. Maximum 250 characters. IMPORTANT: Cannot be used together with ‘redirect’ or ‘redirect_status_code’ - these are mutually exclusive domain configuration modes.
integer ("301" | "302" | "307" | "308")
HTTP status code for redirect. Required when ‘redirect’ is set. 301: Permanent redirect (cached by browsers), 302: Temporary redirect, 307: Temporary redirect (preserves method), 308: Permanent redirect (preserves method). IMPORTANT: Cannot be used together with ‘git_branch’ - these are mutually exclusive domain configuration modes.
string
Custom environment identifier within the project to associate with this domain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_PROJECT_MEMBERAdds a new member to a project.. Adds a new member to the project.

Input Parameters

string
The ID of the team member that should be added to this project.
string ("ADMIN" \| "PROJECT_VIEWER" \| "PROJECT_DEVELOPER")
required
The project role of the member that will be added.
string
slug query value.
string
The email of the team member that should be added to this project.
string
teamId query value.
string
The username of the team member that should be added to this project.
string
required
The ID or name of the Project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_REPOSITORY_PERMISSIONAdd a repository permission. Grant a team access to a VCR repository. Sharing applies to the whole repository.

Input Parameters

string
slug query value.
string
teamId query value.
string
Slug of a team that is granted access to a repository.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.
string
ID of a team that is granted access to a repository.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ADD_ROUTEAdd a routing rule. Add a single routing rule to a project at a specified position. Defaults to the end of the list if no position is provided. The route is enabled by default. Stages a new version with the added route.

Input Parameters

string
slug query value.
object
required
route body value.
string
teamId query value.
object
Controls where the route is inserted. Defaults to “end” if omitted.
string
required
projectId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_AGGREGATE_EVENTSAggregates custom events. Counts custom events on a project, within the requested date range. Results are either aggregated or broken down over time. Results can additionally be broken down by one dimension, and filtered by multiple dimensions.

Input Parameters

array
required
Up to two dimensions used to break down results. At most one time granularity is allowed: hour, day, week, month, year. Other dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions: flags, eventData. Used bare, they break down results by key, for example flags returns one group per flag name. With a key, they break down results by that key’s value, for example eventData/plan. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/‘my-flag’.
string
slug query value.
integer
Number of distinct results, default to 10. Other results are grouped into “Others” group.
number \| string
required
Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
number \| string
required
Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
string
OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. By default, filters for production environment only. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions filtered by key: flags/<name>, eventData/<property>, for example eventData/plan eq ‘pro’. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/‘my-flag’ eq ‘true’. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
string
teamId query value.
string
required
The project identifier or the project name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_AGGREGATE_PAGE_VIEWSAggregate Web Analytics page views for a Vercel project and time range.

Input Parameters

array
required
One or two dimensions to group by. Time dimensions are hour, day, week, month, and year; at most one may be used.
string
Team slug to perform the request on behalf of.
integer
Maximum number of distinct results before grouping others.
string
required
Inclusive start as Unix milliseconds or a valid date string.
string
required
Inclusive end as Unix milliseconds or a valid date string.
string
OData-compliant dimension filter.
string
required
Project identifier or project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_APPROVE_ROLLING_RELEASE_STAGEUpdate the active rolling release to the next stage for a project. Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Project ID or project name (URL-encoded)
number
required
The index of the stage to transition to
string
required
The id of the canary deployment to approve for the next stage

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ARCHIVE_AI_GATEWAY_BUDGETArchive AI Gateway budget. Archive a team-, project-, or user-scope AI Gateway budget.

Input Parameters

string
slug query value.
string
teamId query value.
string
Required when scopeType is “user”.
string
Required when scopeType is “project”.
string ("team" \| "project" \| "user")
required
The budget scope to archive.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ARCHIVE_AI_GATEWAY_BUDGET_DEFAULTArchive AI Gateway budget default. Delete an AI Gateway budget default for one scope. Team-level authority only (owners/admins).

Input Parameters

string
slug query value.
string
teamId query value.
string ("team" \| "project" \| "api-key" \| "user")
required
The budget default scope to delete.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ASSIGN_ALIASTool to assign an alias to a specific Vercel deployment. Use when you need to associate a custom domain or subdomain with a deployment.

Input Parameters

string
required
The ID of the deployment to assign the alias to
string
The Team slug to perform the request on behalf of
string
required
The alias we want to assign to the deployment
string
The Team identifier to perform the request on behalf of
string
The redirect property will take precedence over the deployment id from the URL and consists of a hostname (like test.com) to which the alias should redirect using status code 307

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_BATCH_REMOVE_PROJECT_ENVTool to batch remove environment variables from a Vercel project. Use when you need to delete multiple environment variables at once. More efficient than deleting variables one by one when removing multiple variables.

Input Parameters

array
required
Array of environment variable IDs to delete. Must contain at least 1 and at most 1000 IDs.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_BUY_DOMAINSTool to purchase multiple domains through Vercel’s domain registrar. Use when registering new domains after checking availability and price. Important: Always check domain availability and price before attempting purchase. Some TLDs may require additional contact information fields.

Input Parameters

string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
array
required
List of domains to purchase. Must contain at least one domain.
object
required
Contact information for domain registration. Some TLDs may require additional fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_BUY_SINGLE_DOMAINTool to purchase a domain through Vercel’s domain registrar. Use when you need to register and buy a domain after confirming availability and pricing.

Input Parameters

integer
required
Number of years to register the domain for
string
required
The fully qualified domain name to purchase (e.g., example.com)
string
Optional team ID to purchase the domain on behalf of a team
boolean
required
Whether the domain should be automatically renewed before it expires. Can be configured later via the Vercel Dashboard or API.
number
required
Expected price in USD for the domain purchase. Use check_domain_price to get current pricing.
object
required
Contact information for domain registration. Some TLDs require additional fields - use get_contact_info_schema endpoint to check requirements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CANCEL_DEPLOYMENTCancel a deployment. Cancels a deployment that is currently in progress, stopping the build before it completes. Use this to recover quickly from accidental deploys, wrong-branch pushes, or builds with known errors — without waiting for them to finish. Returns 400 if the deployment is no longer cancelable (already READY, ERROR, or CANCELED). Returns the updated deployment object with readyState: 'CANCELED' on success.

Input Parameters

string
required
The unique identifier of the deployment.
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CANCEL_REGISTRY_BLOB_UPLOADCancel a blob upload. DELETE /v2/:teamSlug/:projectSlug/:repositoryName/blobs/uploads/:uuid Cancel an in-flight blob upload. Aborts the underlying S3 multipart upload (if one was started) and discards the session.

Input Parameters

string
required
Blob upload session identifier.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_CACHE_ARTIFACT_EXISTSTool to check if a cache artifact exists by its hash. Use when verifying whether a cache artifact is already stored before upload or when validating artifact availability.

Input Parameters

string
required
The artifact hash to check for existence.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_DOMAIN_AVAILABILITYTool to check if a domain is available for registration. Read-only: does not reserve or purchase the domain. Use when you need to verify domain availability before purchase. Response field available=false means the domain is taken (not an error); actual failures return HTTP 4xx. IMPORTANT: Vercel only supports specific TLDs. Common supported TLDs include: .com, .net, .org, .io, .co, .dev, .app, .ai, .xyz, .me. Some TLDs are NOT supported (e.g., .cam, .berlin, .wales). For the full list, see: https://vercel.com/docs/domains/supported-domains

Input Parameters

string
Optional team slug to perform the request on behalf of.
string
required
The domain name to check for availability (e.g., ‘example.com’). Can also be passed as ‘domain’. IMPORTANT: Only domains with Vercel-supported TLDs can be checked. Common supported TLDs include: .com, .net, .org, .io, .co, .dev, .app, .ai, .xyz, .me, .info, .biz, .tech, .online, .site, .store, .shop, .cloud, .digital, .agency, .design, .studio, .solutions, .systems, .tools, .world, .today, .life, .plus, .one, .pro, .zone, .team, .works, .page, .email, .link, .global, .live, .network, .services, .software, .technology. Some TLDs are NOT supported (e.g., .cam, .berlin, .wales). For the complete list of 500+ supported TLDs, see: https://vercel.com/docs/domains/supported-domains
string
Optional team identifier to perform the request on behalf of. Can also be passed as ‘team’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_DOMAIN_PRICEDEPRECATED: Use VERCEL_CHECK_DOMAIN_PRICE2 instead. Tool to check the price for a domain before purchase. Use when evaluating cost and availability prior to domain registration.

Input Parameters

integer
Number of years to get pricing for. If omitted, uses the minimum years for the TLD.
string
required
Fully qualified domain name to check price for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_DOMAIN_PRICE2Check pricing for a domain including purchase, renewal, and transfer costs. Use this to evaluate the cost of registering, renewing, or transferring a domain via Vercel. Returns pricing for the specified domain and time period.

Input Parameters

integer
The number of years to get the price for. If not provided, the minimum number of years for the TLD will be used (typically 1 year).
string
required
The domain name to check pricing for (e.g., ‘example.com’, ‘mysite.io’).
string
The Team identifier to perform the request on behalf of (e.g., ‘team_1a2b3c4d5e6f7g8h9i0j1k2l’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_REGISTRY_BLOBCheck if a blob exists. HEAD /v2/:teamSlug/:projectSlug/:repositoryName/blobs/:digest Check whether a blob exists. Used by the Docker client before pushing a layer to avoid re-uploading content that already exists.

Input Parameters

string
required
Content-addressable digest (algorithm:hex).
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_REGISTRY_MANIFESTCheck if a manifest exists. HEAD /v2/:teamSlug/:projectSlug/:repositoryName/manifests/:reference Check whether a manifest exists. Used by Docker client during push to determine if a manifest (or config blob referenced by digest) is already present.

Input Parameters

string
Accepted OCI or Docker manifest media types.
string
required
Manifest reference: a tag or digest.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CHECK_REGISTRY_VERSIONCheck registry API version support. GET /v2/ Docker Registry v2 version check. Returns a 401 challenge when no credentials are provided, prompting the Docker client to send auth. With valid credentials, returns 200 so the client can proceed.

Input Parameters

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CLAIM_DOMAIN_OWNERSHIPClaim Domain Ownership. Claim ownership of a domain for the authenticated team by verifying a TXT record. The caller must first add a TXT record to _vercel.{domain} (obtained from GET /domains/:domain/verification), then call this endpoint to complete the ownership transfer. If the TXT record is verified, the domain ownership will be transferred to the caller’s team, even if the domain is currently owned by another user or team.

Input Parameters

string
slug query value.
string
required
The domain name to claim ownership of
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CLEAR_REPOSITORY_PERMISSIONSClear all repository permissions. Revoke every team’s access to a VCR repository. Clearing an unshared repository is a no-op.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_COMPLETE_REGISTRY_BLOB_UPLOADComplete a blob upload. PUT /v2/:teamSlug/:projectSlug/:repositoryName/blobs/uploads/:uuid?digest=<digest> Complete the blob upload. This may include a final chunk of data in the request body (monolithic upload) or just finalize a previous chunked upload.

Input Parameters

string
required
Blob upload session identifier.
string
required
Content-addressable digest (algorithm:hex).
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
Inclusive byte range start-end for this chunk.
string
Base64-encoded raw application/octet-stream request content.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_COMPLETE_ROLLING_RELEASEComplete the rolling release for the project. Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Project ID or project name (URL-encoded)
string
required
The ID of the canary deployment to complete

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CONNECT_BLOB_STOREConnect a Blob store to a project, generate environment variables in the selected environments, and return the created connection.

Input Parameters

string
required
Blob store ID.
string
required
Project ID to connect.
string
Prefix for generated Blob environment variables.
array
Environments receiving generated Blob variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CONNECT_INTEGRATION_RESOURCE_TO_PROJECTConnect integration resource to project. Connects an integration resource to a Vercel project. This endpoint establishes a connection between a provisioned integration resource (from storage APIs like POST /v1/storage/stores/integration/direct) and a specific Vercel project.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId body value.
string
required
resourceId path value.
array
envVarEnvironments body value.
boolean
makeEnvVarsSensitive body value.
string
required
integrationConfigurationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_COUNT_EVENTSCounts custom events. Counts the number of custom events on a project (production only), since Web Analytics was enabled. Results can be filtered on supported dimensions.

Input Parameters

string
slug query value.
number \| string
Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
number \| string
Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
string
OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions filtered by key: flags/<name>, eventData/<property>, for example eventData/plan eq ‘pro’. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/‘my-flag’ eq ‘true’. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
string
teamId query value.
string
required
The project identifier or the project name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_COUNT_PAGEVIEWSCounts page views. Counts the number of page views on a project (production only), since Web Analytics was enabled. Results can be filtered on supported dimensions.

Input Parameters

string
slug query value.
number \| string
Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
number \| string
Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
string
OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm. JSON dimensions filtered by key: flags/<name>, for example flags/beta_banner eq ‘true’. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/‘my-flag’ eq ‘true’. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
string
teamId query value.
string
required
The project identifier or the project name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_ACCESS_GROUPCreates an access group. Allows to create an access group

Input Parameters

string
required
The name of the access group
string
slug query value.
string
teamId query value.
array
projects body value.
array
List of members to add to the access group.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_ACCESS_GROUP_PROJECTCreate an access group project. Allows creation of an access group project

Input Parameters

string ("ADMIN" \| "PROJECT_VIEWER" \| "PROJECT_DEVELOPER")
required
The project role that will be added to this Access Group.
string
slug query value.
string
teamId query value.
string
required
The ID of the project.
string
required
accessGroupIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_AI_GATEWAY_RULECreate rule. Create a routing rule

Input Parameters

string
slug query value.
string ("deny" \| "rewrite")
required
type body value.
object
match body value.
object
action body value.
string
teamId query value.
string
description body value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_AI_GATEWAY_VIRTUAL_MODEL_CONFIGCreate virtual model config. Create a virtual model config (VMC)

Input Parameters

array
Limit providers to those with these features.
string
VMC kind: alias, relay, or router.
string
slug query value.
string ("cost" \| "latency" \| "price" \| "throughput" \| "tps" \| "ttft")
Rank eligible providers by an attribute.
string ("fast")
Only use fastest providers with short timeouts.
array
For kind=router: ordered candidates, bare slugs/references or { slug, ...attributes }. For kind=alias: ordered fallback model slugs, optionally led by one conditional { model, when } entry, used when the primary model’s answers match when.
string
UI lifecycle status: draft, active, or archived.
string ("auto")
Use caching if available.
boolean (false \| true)
Whether this VMC is soft-deleted.
string
teamId query value.
string
For kind=relay: URL the gateway forwards requests to as a transparent proxy.
string
User or app id that last updated this VMC.
string
Visibility in listings: public, internal, or stealth.
string
Optional description for UI.
string
Human-readable name for UI.
string ("fast" \| "flex" \| "priority")
Service tier for providers that support it.
array
Restrict routing to only these providers.
array
Ordered list of providers to try as fallbacks on failure.
object
Region pinned on the VMC for system-credential routing (alias/router only).
string
Canonical model slug this VMC maps to (e.g. “creator/model”). Not used by kind=router.
object
Arbitrary per-provider AI SDK options, keyed by gateway provider slug.
object
Per-request provider timeouts in ms, keyed by provider slug for BYOK credentials.
array
Observability tags attached to requests through this VMC.
string
required
Client-facing alias used as the model slug in Gateway calls.
boolean (false \| true)
Only use providers with zero data retention.
boolean (false \| true)
Allow fallback from fast to standard providers on failure.
boolean (false \| true)
Only use providers that will not train on your prompts.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_AUTH_TOKENTool to create a new authentication token. Use when you need to programmatically generate a new auth token with optional expiration. Returns both token metadata and the bearer token value (only provided once).

Input Parameters

string
required
The human-readable name of the token.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
integer
Timestamp (in milliseconds) of when the token expires. Must be within 2 years from now. If not provided, the token will not expire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_BLOB_STORECreate a Vercel Blob store, optionally associated with a project.

Input Parameters

string
required
Name for the Blob store, up to 70 characters.
string ("public" | "private")
Whether URLs for blobs in the store are public or private.
string ("arn1" | "bom1" | "cdg1" | "cle1" | "cpt1" | "dub1" | "dxb1" | "fra1" | "gru1" | "hkg1" | "hnd1" | "iad1" | "icn1" | "kix1" | "lhr1" | "pdx1" | "sfo1" | "sin1" | "syd1" | "yul1")
Vercel region in which to create the store.
string
Project ID to associate with the store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_CONDITIONAL_BYPASSCreate conditional firewall bypass. Create a conditional firewall bypass rule for a project domain.

Input Parameters

string
note body value.
string
slug query value.
string
required
domain body value.
string
teamId query value.
string
required
projectId query value.
array
required
conditionGroup body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_CUSTOM_ENVIRONMENTCreate a custom environment for the current project.. Creates a custom environment for the current project. Cannot be named ‘Production’ or ‘Preview’.

Input Parameters

string
slug query value.
string
teamId query value.
string
The slug of the custom environment to create.
string
required
The unique project identifier or the project name
string
Description of the custom environment. This is optional.
object
How we want to determine a matching branch. This is optional.
string
Where to copy environment variables from. This is optional.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_DEPLOYMENTDEPRECATED: Use VERCEL_CREATE_NEW_DEPLOYMENT instead. Create a new deployment on Vercel. Deploys static files or connects to a Git repository. File-based deployments: Provide name and files array with file content (inline HTML/CSS/JS). Git-based deployments: Provide name and gitSource with repository details. IMPORTANT: Always provide either slug (team slug) or teamId (team ID starting with ‘team_’) to specify the team context. Use VERCEL_GET_TEAMS to find the correct team slug. Example minimal file deployment: { “name”: “my-project”, “slug”: “my-team”, “files”: [{“file”: “index.html”, “data”: “<html><body>Hello World</body></html>”}] }

Input Parameters

object
An object containing the deployment’s metadata. Multiple key-value pairs can be attached to a deployment
string
required
A string with the project name used in the deployment URL
string
The Team slug to perform the request on behalf of.
array
A list of objects with the files to be deployed. Required if not using gitSource.
string ("production" | "staging")
Either not defined, staging, production, or a custom environment identifier. If staging, a staging alias in the format <project>-<team>.vercel.app will be assigned. If production, any aliases defined in alias will be assigned. If omitted, the target will be preview.
string
The Team identifier to perform the request on behalf of.
string
The target project identifier in which the deployment will be created. When defined, this parameter overrides name
string ("0" | "1")
Forces a new deployment even if there is a previous similar deployment
object
Git source information for git-based deployments.
object
Git metadata for the deployment.
string
An deployment id for an existing deployment to redeploy
string
The monorepo manager that is being used for this deployment. When null is used no monorepo manager is selected
object
Project settings for the deployment.
boolean
When true and deploymentId is passed in, the sha from the previous deployment’s gitSource is removed forcing the latest commit to be used.
string
Deploy to a custom environment, which will override the default environment
string ("0" | "1")
Allows to skip framework detection so the API would not fail to ask for confirmation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_DEPLOYMENT_CHECK_RUNCreate a check run. Creates a new check run for a deployment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
checkId body value.
string
required
deploymentId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_DNS_RECORDTool to create a new DNS record for a domain. Use when you need to add DNS records such as A, AAAA, CNAME, MX, TXT, SRV, or other record types to a domain managed in Vercel.

Input Parameters

object
Configuration for SRV record type.
integer
The Time to live (TTL) value of the DNS record in seconds. Must be between 60 and 2147483647. If not specified, a default TTL will be used.
string
required
The name/subdomain for the DNS record. Use ’@’ for the root domain or provide a subdomain like ‘www’ or ‘api’.
string
The Team slug to perform the request on behalf of.
string ("A" | "AAAA" | "ALIAS" | "CAA" | "CNAME" | "HTTPS" | "MX" | "SRV" | "TXT" | "NS")
required
The type of DNS record to create
object
Configuration for HTTPS record type.
string
The value of the DNS record. Required for A, AAAA, ALIAS, CAA, CNAME, MX, TXT, and NS record types. Not used for SRV and HTTPS records which use their respective config objects.
string
required
The domain used to create the DNS record (e.g., ‘example.com’)
string
The Team identifier to perform the request on behalf of.
string
A comment to add context on what this DNS record is for. Maximum 500 characters.
integer
The MX priority value. Required when record type is MX.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_EDGE_CONFIGCreates a new Edge Config for storing key-value data at the edge. Edge Configs enable ultra-low latency data reads from Vercel’s edge network. Use this to store feature flags, A/B test configurations, or other data that needs to be read quickly from edge functions.

Input Parameters

string
required
Unique slug identifier for the Edge Config. Can only contain alphanumeric characters, underscores (_) and hyphens (-). Maximum 64 characters.
object
Optional initial key-value items to populate the Edge Config. Each key should be a string and values can be any JSON-serializable type.
string
The Team identifier to perform the request on behalf of. Required if the Edge Config belongs to a team.
string
The Team URL slug to perform the request on behalf of. Alternative to teamId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_EDGE_CONFIG_TOKENCreate a read access token for a specific Edge Config. The generated token is used to authenticate against the Edge Config’s endpoint for high-volume, low-latency read operations. Use this when you need to grant read access to an Edge Config from your application.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
A label for the token to help identify its purpose (max length 52 characters).
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier of the Edge Config for which the token is being created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_FLAGCreate a flag. Create a new feature flag for a project. The flag must have a unique slug within the project and specify its kind (boolean, string, number, or json).

Input Parameters

string ("boolean" \| "string" \| "number" \| "json")
required
The kind of flag
number
A random seed to prevent split points in different flags from having the same targets
string
slug query value.
array
Tags for categorizing the flag
string ("active" \| "archived")
state body value.
string
teamId query value.
array
The variants of the flag
boolean
Whether this flag is marked as permanent, indicating it should not be removed
string
required
A unique (per project) key for the flag, composed of letters, numbers, dashes, and underscores
string
A description of the flag
object
required
The configuration for the flag in different environments
array
The user ids of the maintainers of the flag
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_FLAG_SEGMENTCreate a segment. Create a new feature flag segment.

Input Parameters

object
required
The data of the segment
string
required
hint body value.
string
slug query value.
string
required
label body value.
string
teamId query value.
string
required
slug body value.
string
The entity who created the segment
string
description body value.
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_INTEGRATION_STORE_DIRECTCreate integration store (free and paid plans). Creates an integration store with automatic billing plan handling. For free resources, omit billingPlanId to auto-discover free plans. For paid resources, provide a billingPlanId from the billing plans endpoint.

Input Parameters

string
required
Human-readable name for the storage resource
string
slug query value.
string ("marketplace" \| "deploy-button" \| "external" \| "v0" \| "resource-claims" \| "cli" \| "oauth" \| "backoffice" \| "import-recommended-integrations" \| "organization")
Source of the store creation request
string
teamId query value.
object
Optional key-value pairs for resource metadata
string
Optional external identifier for tracking purposes
string
ID of the billing plan for paid resources. Get available plans from GET /integrations/integration/{id}/products/{productId}/plans. If not provided, automatically discovers free billing plans.
string
Payment method ID for paid resources. Optional - uses default payment method if not provided.
object
Protocol-specific configuration settings
number
Amount in cents for prepayment billing plans. Required only for prepayment plans with variable amounts.
string
required
ID of your integration configuration. Get this from GET /v1/integrations/configurations
string
required
ID or slug of the integration product. Get available products from GET /v1/integrations/configuration/{id}/products

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_MICROFRONTENDS_GROUP_WITH_APPLICATIONSCreate a microfrontends group with applications. Creates a microfrontends group and attaches multiple projects in a single request.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The name of the microfrontends group that will be used to identify the group
object
required
The default app for the new microfrontend group
array
required
The list of other applications that will be used in the new microfrontend group

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_NETWORKCreate a Secure Compute network. Allows to create a Secure Compute network.

Input Parameters

string
required
The CIDR block of the network
string
required
The name of the network
string
slug query value.
string
required
The region where the network will be created
string
teamId query value.
array
awsAvailabilityZoneIds body value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_NEW_DEPLOYMENTTool to create a new deployment. Use when you need to deploy files or a Git commit to a Vercel project. Example for file deployment: { “name”: “my-app”, “files”: [ {“file”: “index.html”, “data”: “<html><body>Hello World</body></html>”}, {“file”: “style.css”, “data”: “body { font-family: Arial; }”} ], “target”: “production” } Example for Git source deployment (deploy from GitHub branch - uses latest commit): { “name”: “my-app”, “gitSource”: { “type”: “github”, “repoId”: “668449998”, “ref”: “main” } } Example for Git source deployment (deploy specific commit): { “name”: “my-app”, “gitSource”: { “type”: “github”, “repoId”: “668449998”, “ref”: “main”, “sha”: “a1b2c3d4e5f6g7h8i9j0” } } Note: repoId must be the numeric GitHub repository ID (NOT ‘owner/repo’). Get it via: GET https://api.github.com/repos/&#123;owner&#125;/&#123;repo&#125; -> use the ‘id’ field. Example for redeployment: { “deploymentId”: “dpl_Br7FSrRXuUkSHj7t7GVVadyuGvFg”, “target”: “production” }

Input Parameters

object
User-defined metadata key/value pairs
string
required
Name for the deployment. Required by API - must be non-null.
string
The Team slug to perform the request on behalf of
array
List of files for non-git deployments. Required if no gitSource is provided (gitMetadata alone is insufficient).
string ("production" | "staging")
Deployment target environment
string
The Team identifier to perform the request on behalf of
string
Project ID or name to deploy to. Note: Providing a project ID alone is not sufficient - you must also provide deployment source (files, gitSource, or deploymentId).
string ("0" | "1")
Forces a new deployment even if there is a previous similar deployment
object
Git source information for git-based deployments
object
Git commit metadata for git-based deployments
string
Specify an existing deployment ID to redeploy the same version
object
Project-specific build settings (buildCommand, installCommand, devCommand, outputDirectory, rootDirectory, framework). If not provided or all fields are None, skipAutoDetectionConfirmation=1 is automatically enabled for framework auto-detection.
string ("0" | "1")
Allows skipping framework detection confirmation. Required for new projects if projectSettings is not provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_OBSERVABILITY_QUERYQuery Vercel observability metrics with aggregations, filters, and time bounds.

Input Parameters

number
Maximum number of results
object
required
Owner or project scope for the query
string
Filter to apply to the query. JSON dimensions support nested refs, for example event_data/checkout_step eq ‘payment’. Nested keys containing characters that OData cannot parse as an identifier, such as ’-’, spaces, quotes, or ’/’, must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/‘enable-comments-view’ eq true or event_data/‘some property”s/value’ eq true.
string
required
Metric id
string
End timestamp
array
Dimensions to group results by. JSON dimensions support nested refs, for example event_data/checkout_step. Nested keys containing characters that OData cannot parse as an identifier, such as ’-’, spaces, quotes, or ’/’, must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/‘enable-comments-view’ or event_data/‘some property”s/value’.
string
Rollup column to order grouped results by. Use the generated rollup key for the requested metric and aggregation. Defaults to the query engine count rollup.
string
Start timestamp
string
Aggregation function to apply. Some aggregations require a dimension: use <agg>/<dimension>, for example unique/visitor_id.
object
Time bucket size
string
IANA timezone (e.g. Europe/Paris) used only to align calendar buckets (1d/1mo) to that zone’s day/month boundaries. startTime/endTime and all output timestamps are always UTC. No effect on sub-day granularities.
string ("asc" \| "desc")
Direction to order grouped results by. Defaults to desc.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_OR_TRANSFER_DOMAINTool to add an existing domain to the Vercel platform. Use when you need to add a domain to Vercel for DNS management or transfer a domain. Supports two methods: ‘add’ for adding existing domains and ‘move-in’ for transferring domains (requires authorization token).

Input Parameters

string
required
The domain name to add or transfer (e.g., ‘example.com’)
string
Team slug to perform the request on behalf of
boolean
Whether to create a DNS zone for the domain. Only applicable when method is ‘add’.
string
Authorization token required when method is ‘move-in’ for domain transfer. Not used for ‘add’ method.
string
The domain operation to perform. Use ‘add’ to add an existing domain or ‘move-in’ to transfer a domain. When using ‘move-in’, the ‘token’ field is required. If not specified, defaults to ‘add’.
string
Team identifier to perform the request on behalf of
boolean
Whether to enable CDN for the domain. Only applicable when method is ‘add’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_PROJECTDEPRECATED: Use VERCEL_VERCEL_CREATE_PROJECT2 instead. Tool to create a new Vercel project. Use when automating project provisioning in CI/CD before deployment. Project names must be unique per team; duplicate names cause 409 conflicts — check for existing projects first.

Input Parameters

string
required
Project name. Must be lowercase, up to 100 characters, and can only contain alphanumeric characters (a-z, 0-9) and hyphens (-). Cannot contain ’---’ sequence. Spaces and uppercase letters will be automatically converted (spaces to hyphens, uppercase to lowercase), and other invalid characters will be removed.
string
Team slug to run the request on behalf of
string
Team identifier to run the request on behalf of
object
Git repository configuration for automatic deployments.
When true, skips the Git connect prompt during project linking in the CLI.
string
Message explaining any automatic transformations applied to user input

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_PROJECT2Tool to create a new Vercel project with comprehensive configuration options. Use when you need to create a project with specific settings like environment variables, framework selection, Git repository connection, resource configuration, or deployment policies.

Input Parameters

string
required
The desired name for the project. Must be lowercase and can only contain letters, digits, ’.’, ’_’, and ’-’. Cannot contain the sequence ’---’. Maximum 100 characters.
string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string ("blitzjs" | "nextjs" | "gatsby" | "remix" | "react-router" | "astro" | "hexo" | "eleventy" | "docusaurus-2" | "docusaurus" | "preact" | "solidstart-1" | "solidstart" | "dojo" | "ember" | "vue" | "scully" | "ionic-angular" | "angular" | "polymer" | "svelte" | "sveltekit" | "sveltekit-1" | "ionic-react" | "create-react-app" | "gridsome" | "umijs" | "sapper" | "saber" | "stencil" | "nuxtjs" | "redwoodjs" | "hugo" | "jekyll" | "brunch" | "middleman" | "zola" | "hydrogen" | "vite" | "tanstack-start" | "vitepress" | "vuepress" | "parcel" | "fastapi" | "flask" | "fasthtml" | "sanity-v3" | "sanity" | "storybook" | "nitro" | "hono" | "express" | "h3" | "nestjs" | "elysia" | "fastify" | "xmcp")
The framework being used for this project. When null, no framework is selected
string
The dev command for this project. When null is used, this value will be automatically detected
string
The build command for this project. When null is used, this value will be automatically detected
boolean
Specifies whether the source code and logs of the deployments for this project should be public or not
object
Git repository configuration for automatic deployments.
string
The name of a directory or relative path to the source code. When null, it will default to the project root
object
SSO protection configuration for the project.
string
The install command for this project. When null is used, this value will be automatically detected
object
Resource override configuration for the project.
object
OpenID Connect JSON Web Token generation configuration.
string
The output directory of the project. When null is used, this value will be automatically detected
array
Collection of environment variables the project will use
boolean
Opt-in to preview toolbar on the project level
string
Custom domain suffix for preview deployments. Must be a domain owned by the team
boolean
Opt-in to production toolbar on the project level
string
The region to deploy Serverless Functions in this project
Opts-out of the message prompting a CLI user to connect a Git repository in vercel link
boolean
Specifies whether preview deployments are disabled for this project
string
Command to determine whether to skip the build step
boolean
Opt-in to skip deployments when there are no changes to the root directory and its dependencies
boolean
Specifies whether Zero Config Failover is enabled for this project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_PROJECT_CHECKCreate a check. Creates a new check for a project.

Input Parameters

string
required
name body value.
string
slug query value.
string ("build-start" \| "deployment-start" \| "deployment-alias" \| "deployment-promotion" \| "none")
blocks body value.
object
source body value.
array
targets body value.
string
teamId query value.
number
timeout body value.
string ("build-ready" \| "deployment-url" \| "none")
required
requires body value.
boolean
isRerequestable body value.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_PROJECT_ENVDEPRECATED: Use VERCEL_ADD_ENVIRONMENT_VARIABLE instead. Tool to create environment variables in a Vercel project. Use when you need to configure secrets or configuration values across environments.

Input Parameters

string
required
Name of the environment variable
string
The Team slug to perform the request on behalf of.
string ("plain" | "encrypted" | "sensitive")
required
Type of the variable storage: ‘plain’ (non-sensitive values), ‘encrypted’ (standard encrypted values visible to project users), or ‘sensitive’ (values that are non-readable once created, only decrypted during builds). Note: ‘sensitive’ type can only target ‘production’ and ‘preview’ environments, NOT ‘development’.
string
required
Value of the environment variable
array
List of environments where this variable should be available. Valid values: ‘production’, ‘preview’, ‘development’. Note: When type is ‘sensitive’, ‘development’ is not allowed and will be automatically removed.
string
The Team identifier to perform the request on behalf of.
string
Set to ‘true’ to update an existing environment variable instead of failing with ENV_CONFLICT. When creating a variable that may already exist, use upsert=‘true’ to overwrite its value.
string
Optional comment for context
string
required
The unique project identifier or the project name
string
Git branch to scope this variable to
array
List of custom environment identifiers
boolean
Internal flag: True if ‘development’ was auto-removed from target for sensitive type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_PROJECT_TRANSFER_REQUESTTool to create a project transfer request. Use when you need to initiate a transfer of a Vercel project to another account or team.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The ID or name of the project to transfer.
string
The URL to send a webhook to when the transfer is accepted.
string
The secret to use to sign the webhook payload with HMAC-SHA256.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_REPOSITORYCreate a repository. Create a container registry repository for a project.

Input Parameters

string
required
Single Docker repository name component.
string
slug query value.
string
teamId query value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_SESSION_DIRECTORYCreate a directory. Creates a new directory in a session’s filesystem. By default, parent directories are created recursively if they don’t exist (similar to mkdir -p).

Input Parameters

string
The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.
string
required
The path of the directory to create. Can be absolute or relative to the working directory.
string
slug query value.
string
teamId query value.
boolean
If true, creates parent directories as needed (like mkdir -p). If false, fails if parent directories do not exist.
string
required
The unique identifier of the session to create the directory in.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_SESSION_SNAPSHOT_V2Create a snapshot. Creates a point-in-time snapshot of a running session’s filesystem. Snapshots can be used to quickly restore a session to a previous state or to create new sessions with pre-configured environments. The session must be running and able to accept commands for a snapshot to be created. The session will be terminated after the snapshot is created.

Input Parameters

string
slug query value.
string
teamId query value.
string \| number \| boolean \| array \| object
The number of milliseconds after which the snapshot will expire and be deleted. Use 0 for no expiration.
string
required
The unique identifier of the session to snapshot.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_SESSION_SNAPSHOT_V3Create a snapshot. Creates a point-in-time snapshot of a running session’s filesystem. Snapshots can be used to quickly restore a session to a previous state or to create new sessions with pre-configured environments. The session must be running and able to accept commands for a snapshot to be created. The session will be terminated after the snapshot is created. Unlike v2, snapshots expire after 7 days when neither the request nor the sandbox configuration specifies an expiration.

Input Parameters

string
slug query value.
string
teamId query value.
string \| number \| boolean \| array \| object
The number of milliseconds after which the snapshot will expire and be deleted. Defaults to 7 days when neither this field nor the sandbox configuration specifies an expiration. Use 0 for no expiration.
string
required
The unique identifier of the session to snapshot.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_SHARED_ENV_VARIABLETool to create one or more shared environment variables in Vercel. Use when you need to create environment variables that can be shared across multiple projects or applied to specific target environments. Supports creating 1-50 variables in a single request.

Input Parameters

array
required
Array of environment variables to create (minimum 1, maximum 50)
string
Team slug to perform the request on behalf of
string ("encrypted" | "sensitive")
Type of environment variable storage: ‘encrypted’ (standard encrypted values visible to users) or ‘sensitive’ (values that are non-readable once created). Defaults to ‘encrypted’ if not specified.
array
Target environments where the variable should be available. Required if applyToAllCustomEnvironments is not set. Valid values: ‘production’, ‘preview’, ‘development’
string
Team identifier to perform the request on behalf of
array
Associate the shared environment variable with specific projects by providing a list of project IDs
boolean
Apply the environment variable to all custom environments. Required if target is not set. Cannot be used together with target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_SPEED_INSIGHTS_TOGGLEEnable or disable Vercel Speed Insights for a project.

Input Parameters

boolean
required
value body value.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_TEAMCreate a Team. Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name.

Input Parameters

string
The desired name for the Team. It will be generated from the provided slug if nothing is provided
string
required
The desired slug for the Team
object
Attribution information for the session or current page

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_VERCEL_CI_TASK_ANALYSISStart an asynchronous Vercel CI task analysis. Create task analysis

Input Parameters

string
required
repo body value.
string
slug query value.
string
required
owner body value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_VERCEL_CI_TASK_CONFIGURATION_PULL_REQUESTCreate a GitHub pull request that adds Vercel CI tags for the completed analysis. Create task configuration pull request

Input Parameters

string
slug query value.
array
required
tasks body value.
string
teamId query value.
string
required
analysisId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_WEBHOOKTool to create a webhook for receiving notifications about Vercel events. Use when you need to set up automated responses to deployment, domain, project, or other Vercel events.

Input Parameters

string
required
The URL to call when the webhook is triggered. Must start with http:// or https://
string
The Team slug to perform the request on behalf of.
array
required
List of event types that should trigger this webhook. At least one event is required.
string
The Team identifier to perform the request on behalf of.
array
Optional list of project IDs to scope the webhook to specific projects. Minimum 1, maximum 50 project IDs. Each project ID must contain only alphanumeric characters and underscores.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_CREATE_WEB_INSIGHTS_TOGGLEEnable or disable Vercel Web Analytics for a project.

Input Parameters

boolean
required
value body value.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DANGEROUSLY_DELETE_BY_SRC_IMAGESTool to dangerously delete edge cache by source image URLs. Use when you need to invalidate cached images from the edge network for a specific project.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
array
required
List of source image URLs to delete from edge cache. Must contain 1-8 URLs, each up to 8192 characters.
string
required
The unique identifier or name of the project.
number
Optional deadline in seconds for revalidation. Must be non-negative.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DANGEROUSLY_DELETE_BY_TAGSTool to dangerously delete edge cache by tags. Use when you need to purge cached content for specific cache tags in a Vercel project. WARNING: This permanently deletes cached content and cannot be undone.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
Cache tags to purge. Can be a single tag string or a list of tag strings. All cached content matching these tags will be permanently deleted.
string ("production" | "preview")
Target environment to purge cache from. Either ‘production’ or ‘preview’.
string
The Team identifier to perform the request on behalf of.
string
required
The project ID or name to purge cache for. This is required and must be a valid project identifier.
number
Optional deadline in seconds for revalidation. Must be non-negative.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ACCESS_GROUPDeletes an access group. Allows to delete an access group

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ACCESS_GROUP_PROJECTDelete an access group project. Allows deletion of an access group project

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId path value.
string
required
accessGroupIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_AI_GATEWAY_RULEDelete rule. Delete a routing rule (soft delete)

Input Parameters

string
slug query value.
string
required
ruleId query value.
string
teamId query value.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_AI_GATEWAY_VIRTUAL_MODEL_CONFIGDelete virtual model config. Delete a virtual model config (soft delete)

Input Parameters

string
slug query value.
string
teamId query value.
string
ownerId query value.
string
actingIp query value.
string
updatedBy query value.
string
actingUserAgent query value.
string
required
virtualModelSlug query value.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_AI_GATEWAY_VIRTUAL_MODEL_CONFIG_BY_SLUGDelete virtual model config. Delete a virtual model config by path slug (soft delete)

Input Parameters

string
slug query value.
string
teamId query value.
string
ownerId query value.
string
required
vmcSlug path value.
string
actingIp query value.
string
updatedBy query value.
string
actingUserAgent query value.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ALIASTool to delete an alias from Vercel. Use when you need to remove a deployment alias or custom domain alias after confirming the alias ID.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The ID or alias that will be removed. This is the unique identifier of the alias to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ALL_ARTIFACTSDelete all cache artifacts. Targets an explicit team_id or the configured connection context, clearing the Remote Cache. Team slug inputs are not supported. Subsequent builds will re-populate the cache.

Input Parameters

string
Team ID to target instead of the configured connection’s team. Omit to use the configured connection context. Team slug inputs are not supported.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_AUTH_TOKENTool to delete an authentication token. Use when you need to revoke a token programmatically after confirming its validity. Example: “Delete auth token with id abc123”

Input Parameters

string
required
The identifier of the token to invalidate. Use ‘current’ to invalidate the token used for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_CONDITIONAL_BYPASSDelete conditional firewall bypass. Delete a conditional firewall bypass rule from a project domain.

Input Parameters

string
slug query value.
string
required
domain query value.
string
teamId query value.
string
required
projectId query value.

Output

string ("")
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_CONFIGURATIONDelete an integration configuration. Allows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.

Input Parameters

string
required
id path value.
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_CONNECTORDelete a connector. Delete a connector, its project connections, and its installation records.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_CONNECTOR_PROJECT_CONNECTIONDisconnect a connector from a project. Disconnect a connector from a project.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.
string
required
Vercel project ID.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DATA_CACHE_PURGE_ALLTool to purge all data cache entries for a specific project. Use when you need to clear the entire data cache for a project.

Input Parameters

string
Optional team identifier to perform the request on behalf of.
string
required
The project ID or name for which to purge all data cache entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DEPLOYMENTPermanently delete a Vercel deployment by its ID or URL. Use this action to remove a deployment from Vercel. The deployment can be identified either by its unique deployment ID (e.g., ‘dpl_xxx’) or by providing the deployment URL as a query parameter. Note: This action is destructive and cannot be undone. The deployment will be permanently removed. Do not target the latest production deployment. When filtering deployments by branch or status before deletion, use meta.githubCommitRef for branch and readyState for status — misreading these fields can cause unintended deletions.

Input Parameters

string
required
The unique deployment ID (starts with ‘dpl_’). Required but ignored if ‘url’ query parameter is provided.
string
A deployment URL or alias URL to identify the deployment to delete. When provided, this takes precedence over the ‘id’ parameter.
string
The Team slug (URL-friendly name) to perform the request on behalf of. Can be used instead of team_id.
string
The Team identifier to perform the request on behalf of. Required when the deployment belongs to a team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DNS_RECORDTool to delete a DNS record from a domain. Use when you need to remove an existing DNS record by its record ID and domain name.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The domain name that contains the DNS record to delete (e.g., ‘example.com’)
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier of the DNS record to delete. You can obtain this ID by listing DNS records for the domain using the VERCEL_GET_DNS_RECORDS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DOMAINTool to remove a domain by name from Vercel. Use when you need to delete a domain that is no longer needed.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The name of the domain to delete.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DRAINDelete a drain. Delete a specific Drain by passing the drain id in the URL.

Input Parameters

string
required
id path value.
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_DRIVEDelete a drive. Deletes a drive by project and name. Attached drives cannot be deleted. Stop or replace the session currently using the drive before retrying deletion.

Input Parameters

string
required
Name for the drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
string
slug query value.
string
teamId query value.
string
The project ID or name associated with the drive. Required unless using a Vercel OIDC token scoped to a project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_EDGE_CONFIGTool to delete an Edge Config by its unique identifier. Use when you need to permanently remove an Edge Config and all its associated data.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
Unique identifier of the Edge Config to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_EDGE_CONFIG_SCHEMADelete a Global Config’s schema. Deletes the schema of existing Global Config.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
edgeConfigId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_EDGE_CONFIG_TOKENSTool to delete one or more Edge Config tokens. Use when you need to revoke access tokens from an Edge Config. Note: The tokens array must contain the actual token values, not token IDs.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
array
required
List of token values (not token IDs) to delete. Each token is the actual token string that was generated when the token was created.
string
required
Unique identifier of the Edge Config from which to delete tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_FLAGDelete a flag. Permanently delete a feature flag from the project. This action cannot be undone. Consider archiving the flag instead if you may need it in the future.

Input Parameters

string
slug query value.
string
teamId query value.
string
Etag to match, can be used interchangeably with the if-match header
boolean
Whether to include metadata in the response
string
required
The flag id or name
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_FLAG_SEGMENTDelete a segment. Delete a feature flag segment.

Input Parameters

string
slug query value.
string
teamId query value.
boolean
Whether to include metadata
string
required
The project id or name
string
required
The segment slug

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_MICROFRONTENDS_GROUPDelete a microfrontends group. Deletes a microfrontends group from the team associated with the group ID.

Input Parameters

string
slug query value.
string
required
teamId path value.
string
required
The microfrontend group ID to delete.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_NETWORKDelete a Secure Compute network. Allows to delete a Secure Compute network.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The ID of the network to delete

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_PROJECTTool to delete a Vercel project by ID or name. Use after confirming the correct project identifier to permanently remove the project.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_PROJECT_AVATARDelete a project avatar. Remove the avatar of the project identified by idOrName. Deletes the chosen avatar field so the next production deploy can run auto-detection again. Does not delete the stored image.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique project identifier or the project name.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_PROJECT_CHECKDelete a check. Delete an existing check and all of its runs.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
checkId path value.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_PROJECT_ENVTool to remove an environment variable from a Vercel project. Use when you need to delete a specific environment variable by its ID.

Input Parameters

string
required
The unique environment variable identifier
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name
string
The unique custom environment identifier within the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_REDIRECTSDelete project-level redirects.. Deletes the provided redirects from the latest version of the projects’ bulk redirects. Stages a new change with the new redirects and returns the alias for the new version in the response.

Input Parameters

string
name body value.
string
slug query value.
string
teamId query value.
array
required
The redirects to delete. The source of the redirect is used to match the redirect to delete.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_REGISTRY_BLOBDelete a blob. DELETE /v2/:teamSlug/:projectSlug/:repositoryName/blobs/:digest Blob deletion is intentionally not supported. Matches the behaviour of most public registries.

Input Parameters

string
required
Content-addressable digest (algorithm:hex).
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_REGISTRY_MANIFESTDelete an image manifest. DELETE /v2/:teamSlug/:projectSlug/:repositoryName/manifests/:reference Reference must be a digest.

Input Parameters

string
required
Content-addressable digest (algorithm:hex).
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_REPOSITORYDelete a repository. Schedule a repository for deletion. The repository is marked so it disappears from list/get immediately; subscriber-vcr reclaims every image (manifests, blobs, tags and rows) and finally deletes the repository row asynchronously via the VcrRepositoryRemoved event.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_REPOSITORY_IMAGEDelete a repository image. Schedule an image for deletion. The image is marked so it disappears from list/get immediately; subscriber-vcr reclaims the manifest, blobs, tags and row asynchronously via the VcrManifestRemoved event.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
imageId path value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ROLLING_RELEASE_CONFIGTool to delete rolling release configuration for a project. Use when you need to remove or disable rolling release configuration from a Vercel project.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
Project ID or project name (URL-encoded). This identifies the project whose rolling release configuration should be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_ROUTESDelete routing rules. Delete one or more routing rules from a project by ID. Stages a new version with the routes removed.

Input Parameters

string
slug query value.
string
teamId query value.
array
required
The IDs of the routes to delete
string
required
projectId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_SANDBOXDelete a sandbox. Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first. This operation deletes all sandbox entities with the given name and the named sandbox metadata. When the config item is already missing, the returned sandbox uses stored metadata and defaults; config fields may be stale.

Input Parameters

string
required
The sandbox name to delete.
string
slug query value.
string
teamId query value.
string
The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context.
boolean
When true, snapshots of the deleted sandbox that are not referenced by any other sandbox are also deleted asynchronously. Defaults to false.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_SECURITY_FIREWALL_CONFIG_BY_CONFIG_VERSIONDelete a draft WAF configuration version for the specified project.

Input Parameters

string
Team slug for the project.
string
Team identifier for the project.
string
required
Project whose draft WAF configuration will be deleted.
string
required
configVersion path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_SESSION_SNAPSHOTDelete a snapshot. Permanently deletes a snapshot and frees its associated storage. This action cannot be undone. After deletion, the snapshot can no longer be used to create new sessions.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the snapshot to delete.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_SHARED_ENV_VARIABLETool to delete one or more shared environment variables. Use when you need to remove shared env vars by their IDs (up to 50 at a time).

Input Parameters

array
required
IDs of the Shared Environment Variables to delete. Minimum 1, maximum 50.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_STORAGE_STORES_BLOB_BY_IDDelete a Blob store.

Input Parameters

string
required
id path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DELETE_WEBHOOKDelete a webhook by its unique ID to stop receiving event notifications. This action permanently removes the webhook configuration. Use VERCEL_GET_WEBHOOKS to find webhook IDs if needed. The deletion is idempotent - deleting an already deleted webhook returns a 404 error.

Input Parameters

string
required
The unique identifier of the webhook to delete.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DOWNLOAD_ARTIFACTDownload a cache artifact from Vercel’s Remote Cache by its hash. Use this to retrieve previously cached build artifacts generated by Turborepo or other build systems. Remote Caching must be enabled for the team. Returns a tar.gz compressed file.

Input Parameters

string
required
The unique artifact hash identifier generated by the build system (e.g., Turborepo). This hash uniquely identifies the cached build artifact to download.
string
The Team URL slug to perform the request on behalf of. Can be used as an alternative to teamId.
string
The Team identifier to perform the request on behalf of. Required to access team-level cached artifacts.
string
The CI/CD environment where this artifact is being downloaded (e.g., ‘VERCEL’, ‘GITHUB_ACTIONS’, ‘CIRCLECI’). Max 50 characters.
integer
Indicates if the client is an interactive shell. Set to 1 for interactive, 0 for non-interactive (CI environments).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DOWNLOAD_REGISTRY_BLOBDownload a blob. GET /v2/:teamSlug/:projectSlug/:repositoryName/blobs/:digest Fetch a blob by digest.

Input Parameters

string
Optional HTTP byte range, for example bytes=0-1023.
string
required
Content-addressable digest (algorithm:hex).
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_DOWNLOAD_REGISTRY_MANIFESTPull an image manifest. GET /v2/:teamSlug/:projectSlug/:repositoryName/manifests/:reference Fetch a manifest by tag or digest.

Input Parameters

string
Accepted OCI or Docker manifest media types.
string
required
Manifest reference: a tag or digest.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EDIT_PROJECT_ENVTool to edit an environment variable in a Vercel project. Use when you need to update an existing environment variable’s value, type, target environments, or other properties. Requires both the project identifier and the environment variable ID.

Input Parameters

string
required
The unique environment variable identifier
string
The name of the environment variable
string
Team slug to perform the request on behalf of
string ("system" | "secret" | "encrypted" | "plain" | "sensitive")
The type of environment variable
string
The value of the environment variable
array
The target environment of the environment variable. Must be provided as a list even for a single environment
string
Team identifier to perform the request on behalf of
string
A comment to add context on what this env var is for
string
required
The unique project identifier or the project name
string
If defined, the git branch of the environment variable (must have target=preview)
array
The custom environments that the environment variable should be synced to. Must be provided as a list even for a single ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EDIT_REDIRECTEdit a project-level redirect.. Edits a single redirect identified by its source path. Stages a new change with the modified redirect and returns the alias for the new version in the response.

Input Parameters

string
name body value.
string
slug query value.
boolean
If true, restores the redirect from the latest production version to staging.
string
teamId query value.
object
required
The redirect object to edit. The source field is used to match the redirect to modify.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EDIT_ROUTEEdit a routing rule. Replace a routing rule identified by its ID, or restore it from the current production version. Stages a new version with the modified route.

Input Parameters

string
slug query value.
object
The full route object to replace the existing route with
boolean
If true, restores the staged route to the value in the production version.
string
teamId query value.
string
required
routeId path value.
string
required
projectId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EJECT_MANAGED_CONNECTOREject a managed connector. Disconnect a managed connector from its provider-side manager.

Input Parameters

string
slug query value.
string
Team identifier to perform the request on behalf of.
string
required
Stable connector ID or URL-encoded team-scoped UID.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EXECUTE_SANDBOX_COMMANDStart a command asynchronously in a running sandbox, or wait and stream status and logs as NDJSON.

Input Parameters

string
Working directory for the command. The sandbox home directory is used when omitted.
object
Environment variables to merge with the sandbox environment.
array
Arguments to pass to the command as separate array elements.
boolean
Whether to include real-time command logs in the NDJSON stream. Applies only when wait is true.
string
Team slug to perform the request on behalf of.
boolean
Whether to execute the command with root privileges. Defaults to false.
boolean
Whether to stream command state as NDJSON until execution finishes. Defaults to false.
string
required
Executable or shell command to run, without its arguments.
integer
Maximum command duration in milliseconds before SIGKILL (100-18000000).
string
required
Unique identifier of the running sandbox session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_EXTEND_SESSION_TIMEOUTExtend session timeout. Extends the maximum execution time of a running session. The session must be active and able to accept commands. The total timeout cannot exceed the maximum allowed limit for your account.

Input Parameters

string
slug query value.
string
teamId query value.
number
required
The amount of time in milliseconds to add to the current timeout. Must be at least 1000ms (1 second).
string
required
The unique identifier of the session to extend the timeout for.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_FILTER_PROJECT_ENVSTool to retrieve environment variables of a Vercel project by id or name. Use when you need to list and filter environment variables for a specific project.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The source that is calling the endpoint
string
The Team identifier to perform the request on behalf of
string
If true, the environment variable value will be decrypted
string
required
The unique project identifier or the project name
string
If defined, the git branch of the environment variable to filter the results (must have target=preview)
string
The unique custom environment identifier within the project
string
The custom environment slug (name) within the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_FORK_DRIVEFork a drive. Fork the provided drive into a new one with the provided name, inheriting the region and max size.

Input Parameters

string
required
Name of the source drive to fork.
string
slug query value.
string
teamId query value.
string
required
Name for the forked drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
string
The project ID or name associated with the drive. Required unless using a Vercel OIDC token scoped to a project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_FORK_SANDBOX_V2Fork a named sandbox. Forks a named sandbox, creating a new named sandbox from the source’s configuration. Resources, timeout, ports, tags, network policy, mounts, Connect network, image, persistence, snapshot settings and — unlike the SDK-side fork — environment variables are copied from the source automatically (interactive is not). When the source has a snapshot the fork starts from it; otherwise it starts from the source’s runtime/image. Any field provided in the request body overrides the value copied from the source.

Input Parameters

object
Default environment variables for the sandbox. These are inherited by all commands unless overridden.
string
required
Name of the source sandbox to fork.
string
slug query value.
object
Key-value tags to associate with the sandbox. Maximum 5 tags.
string
Image to use for the sandbox.
array
List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed.
object
List of drives to mount to the sandbox at the provided path.
string ("iad1" \| "sfo1" \| "cle1" \| "cdg1" \| "fra1" \| "arn1" \| "sin1" \| "pdx1" \| "lhr1" \| "icn1" \| "bom1" \| "cpt1" \| "dub1" \| "gru1" \| "hkg1" \| "syd1" \| "yul1" \| "hnd1" \| "kix1")
The Vercel region in which to create the sandbox.
string
teamId query value.
integer
Maximum duration in milliseconds that the sandbox can run before being automatically stopped.
string
Name for the forked sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). A random name is generated when omitted.
object
Resources to define the VM
string
The Connect network id for the target Secure Compute private network.
boolean
Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to the source sandbox setting.
string
The ID of the project the source sandbox belongs to. Required unless authenticating with an OIDC token.
object
networkPolicy body value.
array
The regions the sandbox falls back to when it cannot be created in region.
object
Protect the N most recent snapshots with different expiration/deletion behavior.
string \| number \| boolean \| array \| object
Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_FORK_SANDBOX_V3Fork a named sandbox. Forks a named sandbox, creating a new named sandbox from the source’s configuration. Resources, timeout, ports, tags, network policy, mounts, Connect network, image, persistence, snapshot settings and — unlike the SDK-side fork — environment variables are copied from the source automatically (interactive is not). When the source has a snapshot the fork starts from it; otherwise it starts from the source’s runtime/image. Any field provided in the request body overrides the value copied from the source. Unlike v2, when neither the body nor the source provides a value, snapshots expire after 7 days by default and persistent sandboxes keep only their most recent snapshot (keepLastSnapshots: null disables the limit).

Input Parameters

object
Default environment variables for the sandbox. These are inherited by all commands unless overridden.
string
required
Name of the source sandbox to fork.
string
slug query value.
object
Key-value tags to associate with the sandbox. Maximum 5 tags.
string
Image to use for the sandbox.
array
List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed.
object
List of drives to mount to the sandbox at the provided path.
string ("iad1" \| "sfo1" \| "cle1" \| "cdg1" \| "fra1" \| "arn1" \| "sin1" \| "pdx1" \| "lhr1" \| "icn1" \| "bom1" \| "cpt1" \| "dub1" \| "gru1" \| "hkg1" \| "syd1" \| "yul1" \| "hnd1" \| "kix1")
The Vercel region in which to create the sandbox.
string
teamId query value.
integer
Maximum duration in milliseconds that the sandbox can run before being automatically stopped.
string
Name for the forked sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). A random name is generated when omitted.
object
Resources to define the VM
string
The Connect network id for the target Secure Compute private network.
boolean
Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to the source sandbox setting.
string
The ID of the project the source sandbox belongs to. Required unless authenticating with an OIDC token.
object
networkPolicy body value.
array
The regions the sandbox falls back to when it cannot be created in region.
string \| object
Protect the N most recent snapshots with different expiration/deletion behavior. Persistent sandboxes default to keeping only the last snapshot (evicted snapshots are deleted). Set to null to disable the limit.
string \| number \| boolean \| array \| object
Default snapshot expiration time in milliseconds. Defaults to 7 days. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GENERATE_FIREWALL_RULEGenerate a firewall rule from natural language. Generate a firewall rule from a natural language description.

Input Parameters

string
slug query value.
string
required
Natural-language firewall rule to generate.
string
teamId query value.
string
projectId query value.
object
currentRule body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GENERATE_ROUTEGenerate a routing rule from natural language. Generate a routing rule configuration from a natural language description. Returns a suggested route configuration that can be reviewed and saved.

Input Parameters

string
slug query value.
string
required
prompt body value.
string
teamId query value.
string
required
projectId path value.
object
currentRoute body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ACTIVE_ATTACK_STATUSTool to read active attack data from Vercel Firewall for a specific project. Use when you need to check if a project is under attack or retrieve security anomaly information.

Input Parameters

string
The Team slug to perform the request on behalf of.
integer
Timestamp in milliseconds to retrieve attack data since this time.
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier of the project to check attack status for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_AI_GATEWAY_VIRTUAL_MODEL_CONFIGGet virtual model config. Get a virtual model config

Input Parameters

string
slug query value.
integer
limit query value.
string
cursor query value.
string
teamId query value.
string
ownerId query value.
string
virtualModelSlug query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_AI_GATEWAY_VIRTUAL_MODEL_CONFIG_BY_SLUGGet virtual model config. Get a virtual model config by path slug

Input Parameters

string
slug query value.
string
teamId query value.
string
ownerId query value.
string
required
vmcSlug path value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ALIASTool to retrieve information about a Vercel alias by ID or alias name. Use when you need to get details of a specific alias.

Input Parameters

integer
Get the alias only if it was created after the provided timestamp (milliseconds).
string
The Team slug to perform the request on behalf of.
integer
Get the alias only if it was created after this JavaScript timestamp (milliseconds).
integer
Get the alias only if it was created before this JavaScript timestamp (milliseconds).
string
The Team identifier to perform the request on behalf of.
string
required
The alias or alias ID to be retrieved.
string
Get the alias only if it is assigned to the provided project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ALL_LOG_DRAINSTool to retrieve a list of all log drains (deprecated). Use when you need to list all log drains configured for your account, team, or project.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string
Filter log drains by project ID
boolean
Include metadata in the response
string
Filter log drains by project ID or name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ARTIFACT_INFOTool to query information about artifacts by their hashes. Use when you need to retrieve metadata about one or more artifacts, including size, processing duration, and tags.

Input Parameters

string
The Team slug to perform the request on behalf of
array
required
List of artifact hashes to query information for
string
The Team identifier to perform the request on behalf of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_AUTH_TOKENTool to retrieve metadata for an authentication token. Use when you need to inspect details of a specific token or get information about the current token being used.

Input Parameters

string
required
The identifier of the token to retrieve. The special value ‘current’ may be supplied, which returns the metadata for the token that the current HTTP request is authenticated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_AUTH_USERTool to get the authenticated user’s profile. Use when you need to retrieve details about the currently authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_BILLING_PLANSList integration billing plans. Get a list of billing plans for an integration and product.

Input Parameters

string
slug query value.
string ("marketplace" \| "deploy-button" \| "external" \| "v0" \| "resource-claims" \| "cli" \| "oauth" \| "backoffice" \| "import-recommended-integrations" \| "organization")
source query value.
string
teamId query value.
string
metadata query value.
string
required
productIdOrSlug path value.
string
required
integrationIdOrSlug path value.
string
integrationConfigurationId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_BULK_AVAILABILITYTool to check availability for multiple domains at once. Use when you need to verify availability of multiple domain names efficiently in a single request. Supports checking up to 50 domains per request. Only domains with Vercel-supported TLDs can be checked.

Input Parameters

string
Optional team identifier to perform the request on behalf of.
array
required
An array of domain names to check for availability. Must contain at least 1 and at most 50 domain names. Each domain should be a valid domain name (e.g., ‘example.com’, ‘myapp.io’). IMPORTANT: Only domains with Vercel-supported TLDs can be checked. Common supported TLDs include: .com, .net, .org, .io, .co, .dev, .app, .ai, .xyz, .me, .info, .biz, .tech, .online, .site, .store, .shop, .cloud, .digital, .agency, .design, .studio, .solutions, .systems, .tools, .world, .today, .life, .plus, .one, .pro, .zone, .team, .works, .page, .email, .link, .global, .live, .network, .services, .software, .technology.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_BULK_PRICEGet price data for multiple domains. Get price data for multiple domains in a single request.

Input Parameters

number
The number of years to get the price for. If not provided, the minimum number of years for the TLD will be used.
array
required
an array of at most 50 item(s)
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_BYPASS_IPRead System Bypass. Retrieve the system bypass rules configured for the specified project

Input Parameters

string
slug query value.
number
limit query value.
string
Filter by domain
string
Used for pagination. Retrieves results after the provided id
string
teamId query value.
string
Filter by source IP
string
required
projectId query value.
boolean
Filter by project scoped rules

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CACHE_STATUSTool to get the status of Remote Caching for the principal. Use when you need to check if Remote Caching is enabled, disabled, over limit, or paused.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CERT_BY_IDGet cert by id. Get cert by id

Input Parameters

string
required
The cert id
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CERTSTool to retrieve SSL/TLS certificates for the authenticated user or team. Use after authentication to list active certificates.

Input Parameters

string
Team slug to perform the request on behalf of
integer
Maximum number of certificates to return (max 100)
integer
Timestamp in milliseconds; include certificates created since this time
integer
Timestamp in milliseconds; include certificates created until this time
string
Team identifier to perform the request on behalf of. Omit for personal account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONDITIONAL_BYPASSGet conditional firewall bypasses. Retrieve conditional firewall bypass rules for a project.

Input Parameters

string
slug query value.
string
domain query value.
string
teamId query value.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONFIGURATIONRetrieve an integration configuration. Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.

Input Parameters

string
required
ID of the configuration to check
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONFIGURATION_PRODUCTSList products for integration configuration. Returns products available for an integration configuration. Each product includes a metadataSchema field with the JSON Schema for required and optional metadata fields.

Input Parameters

string
required
ID of the integration configuration
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONFIGURATIONSTool to get configurations for the authenticated user or team. Use when you need to list integration configurations installed on an account or team.

Input Parameters

string
The Team slug to perform the request on behalf of. Only one of teamId or slug may be set.
string ("account" | "project")
required
View type for configurations. Use ‘account’ to list all configurations for the account/team, or ‘project’ to list configurations for specific projects.
string
The Team identifier to perform the request on behalf of. Omit for personal account.
string ("marketplace" | "external" | "provisioning")
Filter by installation type. ‘marketplace’ for integrations from Vercel marketplace, ‘external’ for custom integrations, ‘provisioning’ for provisioned integrations.
string
ID or slug of the integration to filter configurations by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONNECTORGet a connector. Get the connector by ID. Accepts a dashboard/team requester or a deployment’s project OIDC token; project requesters may only read connectors linked to their project and environment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded owner-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONNECTOR_PROJECT_CONNECTIONGet a connector project connection. Get the configuration that connects a connector to a project.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.
string
required
Vercel project ID.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CONTACT_INFO_SCHEMATool to retrieve the contact information schema for a domain’s top-level domain (TLD). Use when you need to understand what contact information fields are required for a specific domain registration or transfer. Some TLDs require additional contact information beyond standard fields.

Input Parameters

string
Optional Team slug to perform the request on behalf of
string
required
A valid domain name to retrieve the TLD-specific contact information schema for (e.g., ‘example.com’)
string
Optional Team ID to perform the request on behalf of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_CUSTOM_ENVIRONMENTRetrieve a custom environment. Retrieve a custom environment for the project. Must not be named ‘Production’ or ‘Preview’.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique project identifier or the project name
string
required
The unique custom environment identifier within the project

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENTTool to get a deployment by ID or URL. Use when you need to retrieve detailed information about a specific deployment.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier or hostname of the deployment.
string
Whether to add in gitRepo information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_CHECK_RUNGet a check run. Return a detailed response for a single check run.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The ID of the resource that will be updated.
string
required
deploymentId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_DETAILSDEPRECATED: Use VERCEL_VERCEL_GET_DEPLOYMENT instead. Retrieves detailed information about a specific deployment. Use after triggering a deployment to inspect status and configuration. Poll with exponential backoff (5–30s) since deployments may remain in QUEUED or BUILDING state for minutes; tight polling triggers HTTP 429. Deployment is live only when readyState=READY and errorCode is absent; other states (QUEUED, BUILDING, CANCELED, ERROR) mean no traffic is served. Build failures surface in readyState=ERROR with errorCode and errorMessage fields — successful creation does not guarantee a successful build. Example: { “idOrUrl”: “dpl_Br7FSrRXuUkSHj7t7GVVadyuGvFg” }

Input Parameters

string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
string
required
The unique identifier or hostname of the deployment
boolean
Whether to include Git repository information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_EVENTSDEPRECATED: Use VERCEL_VERCEL_GET_DEPLOYMENT_EVENTS2 instead. Tool to retrieve events related to a specific deployment. Use when monitoring or debugging deployment history or streaming real-time events. Example: “Get events for deployment dpl_xxx since 1540095775941.”

Input Parameters

string
Deployment build ID
string
Team slug to perform the request on behalf of
integer
Maximum number of events to return; use -1 for all available logs
integer
Timestamp (ms) for when events should be pulled from Must be UTC milliseconds; seconds or other units yield empty/partial results.
integer
Timestamp (ms) for when events should be pulled up until Must be UTC milliseconds; seconds or other units yield empty/partial results.
integer
Include build events; set to 1 to enable
integer
When enabled (1), this endpoint will stream live events as they happen
string
Team identifier to perform the request on behalf of
string
required
Unique identifier (e.g., dpl_xxx) or hostname (e.g., my-deployment.vercel.app) of an existing deployment. Use VERCEL_LIST_ALL_DEPLOYMENTS to find valid deployment IDs.
integer
Include delimiter events; set to 1 to enable
string ("forward" | "backward")
Order of the returned events based on the timestamp
string
HTTP status code range to filter events by (e.g., ‘5xx’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_EVENTS2Tool to get deployment events for a specific Vercel deployment by ID or URL. Use when you need to retrieve build logs, event streams, or monitor deployment progress.

Input Parameters

string
Deployment build ID
string
The Team slug to perform the request on behalf of
integer
Maximum number of events to return. Provide -1 to return all available logs
integer
Timestamp for when build logs should be pulled from
integer
Timestamp for when the build logs should be pulled up until
integer ("0" | "1")
Include build events. Set to 1 to enable
integer ("0" | "1")
When enabled (1), this endpoint will return live events as they happen
string
The Team identifier to perform the request on behalf of
string
required
The unique identifier or hostname of the deployment
integer ("0" | "1")
Include delimiter events. Set to 1 to enable
string ("backward" | "forward")
Order of the returned events based on the timestamp. Default is ‘forward’
string
HTTP status code range to filter events by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_FEATURE_FLAGSRetrieve the feature flags of a deployment. Retrieve the feature flags of a deployment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
deploymentId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_FILE_CONTENTSRetrieve the contents of a specific file from a Vercel deployment. Returns the file content as a base64-encoded string. First use ‘List Deployment Files’ to get the file_id (uid), then use this action to get the actual file contents.

Input Parameters

string
required
The unique deployment identifier (starts with ‘dpl_’). Obtain this from the List All Deployments action.
string
Path to the file to fetch (only for Git deployments)
string
The Team slug to perform the request on behalf of.
string
required
The unique file identifier (SHA hash). Obtain this from the ‘uid’ field returned by the List Deployment Files action.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_LOGSDEPRECATED: Use VERCEL_VERCEL_GET_DEPLOYMENT_EVENTS2 instead. Tool to retrieve logs for a specific Vercel deployment. Use when monitoring deployment execution, debugging issues, or analyzing deployment performance. Example: “Get logs for deployment dpl_xxx since 1540095775941.”

Input Parameters

string
Team slug to perform the request on behalf of
integer
Maximum number of log entries to return; use -1 for all available logs
integer
Timestamp (ms) for when logs should be pulled from Must be UTC. Wrong timezone or mismatched since/until window yields empty or partial results.
integer
Timestamp (ms) for when logs should be pulled up until
integer
Include build logs; set to 1 to enable
integer
When enabled (1), this endpoint will stream live logs as they happen
string
Team identifier to perform the request on behalf of
string
required
Full deployment ID starting with ‘dpl_’ prefix (e.g., ‘dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd’) or deployment hostname (e.g., ‘my-app-abc123.vercel.app’). Short IDs without the ‘dpl_’ prefix are NOT supported. If a full URL is provided, the hostname will be extracted. Can also be passed as ‘deploymentId’.
string ("forward" | "backward")
Order of the returned logs based on the timestamp
string
HTTP status code range to filter logs by (e.g., ‘5xx’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENT_LOGS2Tool to retrieve runtime logs for a specific Vercel deployment by project and deployment ID. Use when you need to debug or monitor deployment execution with detailed runtime information.

Input Parameters

string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
integer
Maximum number of log entries to return (default: 100). The endpoint streams logs, so this limits how many to collect.
string
required
The unique identifier of the project
string
required
The unique identifier of the deployment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DEPLOYMENTSTool to list deployments from Vercel. Use when you need to retrieve deployment information for a project or team.

Input Parameters

integer
Gets the deployment created before this Date timestamp. (default: current time)
string
Name of the deployment to filter by
string
Filter deployments based on the SHA
integer
Gets the deployment created after this Date timestamp. (default: current time)
string
The Team slug to perform the request on behalf of
integer
Maximum number of deployments to list from a request
integer
Get Deployments created after this JavaScript timestamp
string
Filter deployments based on their state (BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED)
integer
Get Deployments created before this JavaScript timestamp
string
Filter out deployments based on users who have created the deployment
string
Filter deployments based on the branch name
string
Filter deployments based on the environment
string
The Team identifier to perform the request on behalf of
string
Filter deployments from the given ID or name
array
Filter deployments from the given project IDs. Cannot be used when projectId is specified
boolean
Filter deployments based on their rollback candidacy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAINTool to retrieve complete information for a single domain. Use when you need to check domain details, ownership verification status, nameserver configuration, or domain service type.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The name of the domain (e.g., ‘example.com’).
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAIN_CONFIGTool to get a domain’s configuration details from Vercel. Use when you need to check how a domain is configured, what DNS records are recommended, or verify domain setup. Returns configuration status, accepted SSL challenges, and recommended DNS records (CNAME and IPv4).

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The name of the domain to get configuration for
string ("true" | "false")
When true, the response will only include the nameservers assigned directly to the specified domain. When false and there are no nameservers assigned directly to the specified domain, the response will include the nameservers of the domain’s parent zone.
string
The Team identifier to perform the request on behalf of.
string
The project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAIN_CONTACT_VERIFICATIONGet contact verification status for a domain. Get the registrant contact verification status for a domain. Use this after purchasing a domain to determine whether the contact has been verified. Note that a bought_too_recently error will be returned if the domain was bought less than 30 minutes before the request.

Input Parameters

string
required
domain path value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAIN_PROJECT_DOMAINSList Project Domains by Apex Domain. List all project domains associated with an apex domain owned by the authenticated account.

Input Parameters

string
slug query value.
number
Maximum number of project domains to list from a request.
number
Get project domains created after this JavaScript timestamp.
number
Get project domains created before this JavaScript timestamp.
string
required
The apex domain name.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAINS_RECORDS_BY_RECORD_IDRetrieve a single DNS record by its Vercel record ID.

Input Parameters

string
required
The unique ID of the DNS record

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAIN_TRANSFER_INFOTool to get information required to transfer a domain to Vercel. Use when you need to check transfer availability or current status before initiating a transfer.

Input Parameters

string
Optional Vercel Team slug to perform the request on behalf of.
string
required
The domain name to check transfer info for (e.g., ‘example.com’)
string
Optional Vercel Team ID to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DOMAIN_VERIFICATION_RECORDGet Domain Verification Record. Get the TXT verification record needed to claim ownership of a domain for the authenticated team. The caller must add this TXT record to _vercel.{domain} in their DNS configuration, then call POST /domains/:domain/claim to complete the ownership transfer.

Input Parameters

string
slug query value.
string
required
The domain name to get the verification record for
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DRAINFind a Drain by id. Get the information for a specific Drain by passing the drain id in the URL.

Input Parameters

string
required
id path value.
string
slug query value.
string
teamId query value.
boolean
Include deliveryStats with the delivery health of the drain over the last 24 hours.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DRAINSTool to retrieve a list of all drains. Use this to get all configured drains for an account or team, including their delivery configurations and sources.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string
Filter drains by project ID
boolean
Whether to include additional metadata in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_DRIVEGet a drive. Gets an existing drive by project and name or drive ID. Returns 404 if doesn’t exist.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The drive name or ID.
string
The project ID or name associated with the drive. Required unless using a Vercel OIDC token scoped to a project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_EDGE_CONFIGTool to retrieve detailed information about a specific Edge Config by ID. Use when you need to inspect edge config metadata including transfer status, sync information, and purpose details.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
Unique identifier of the Edge Config to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_EDGE_CONFIG_BACKUPTool to retrieve a specific backup version of an Edge Config. Use when you need to inspect or restore a previous version of edge config data.

Input Parameters

string
Optional Team slug to perform the request on behalf of
string
Optional Team ID to perform the request on behalf of
string
required
The backup ID or version to retrieve
string
required
Unique identifier of the Edge Config

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_EDGE_CONFIG_ITEMTool to retrieve a specific item within an Edge Config. Use after obtaining the Edge Config ID and when you need to inspect or validate a particular configuration item by its key.

Input Parameters

string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
string
required
Unique identifier of the Edge Config (must start with ecfg_ prefix)
string
required
Key of the Edge Config item to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_EDGE_CONFIG_SCHEMATool to retrieve the JSON schema of a specific Edge Config. Use when you need to inspect the schema definition of an edge config.

Input Parameters

string
Optional Team slug to perform the request on behalf of
string
Optional Team ID to perform the request on behalf of
string
required
Unique identifier of the Edge Config to retrieve the schema for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_EDGE_CONFIG_TOKENTool to retrieve details of a specific token associated with an Edge Config. Use when you need metadata for an existing Edge Config token.

Input Parameters

string
Team slug to perform the request on behalf of.
string
required
The token string (read access token) whose metadata is to be retrieved. This is the token value returned when creating a token, not the token ID.
string
Team identifier to perform the request on behalf of.
string
required
The unique identifier of the Edge Config.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_FIREWALL_CONFIGTool to retrieve firewall configuration for a Vercel project. Use when you need to inspect current firewall rules and settings.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string
required
The unique identifier of the project
string
required
The deployed configVersion for the firewall configuration. Use ‘active’ for the currently deployed configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_FLAGGet a flag. Retrieve a specific feature flag by its ID or slug.

Input Parameters

string
slug query value.
string
teamId query value.
string
Etag to match, can be used interchangeably with the if-match header
boolean
Whether to include metadata in the response
string
required
The flag id or name
string
required
The project id or name

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_FLAG_SEGMENTGet a segment. Retrieve a feature flag segment by ID or slug.

Input Parameters

string
slug query value.
string
teamId query value.
boolean
Whether to include metadata
string
required
The project id or name
string
required
The segment slug

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_FLAG_SETTINGSGet project flag settings. Retrieve feature flag settings for a project.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_GIT_NAMESPACESTool to list Git namespaces (organizations/users) by provider. Use this to discover available Git namespaces for integration with projects.

Input Parameters

string
The custom Git host URL. Required when provider is ‘github-custom-host’ for GitHub Enterprise Server. Not needed for other providers.
string ("github" | "github-limited" | "github-custom-host" | "gitlab" | "bitbucket")
required
The Git provider type to list namespaces for. Required. Use ‘github’ for standard GitHub, ‘github-limited’ for limited GitHub access, ‘github-custom-host’ for GitHub Enterprise Server, ‘gitlab’ for GitLab, or ‘bitbucket’ for Bitbucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_KMS_ISSUERGet an issuer. Retrieve a single KMS issuer by its ID. Accepts a team or organization bearer token, or an OIDC token authorized by one of the issuer’s policies (e.g. a connex-grant token). The OIDC path returns the issuer without policies, since a policy token only proves signing access, not management access.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The ID of the issuer.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_MICROFRONTENDS_CONFIGGet microfrontends config for a deployment. Get the microfrontends config for a deployment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique deployment identifier

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_MICROFRONTENDS_CONFIG_FOR_PROJECTGet microfrontends config for a project. Get the microfrontends config for a project by ID or name.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The name or ID of the project

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_MICROFRONTENDS_GROUPSList microfrontends groups. Get the microfrontends group IDs for a team.

Input Parameters

string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_MICROFRONTENDS_IN_GROUPList projects in a microfrontends group. Get the microfrontends for a given group ID.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
groupId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_NAMED_SANDBOXGet a named sandbox. Retrieves a named sandbox by name, including its current sandbox and routes. If the sandbox is stopped and resume is true, a new sandbox will be created from the most recent snapshot. Returns 404 if the named sandbox or its configuration no longer exists.

Input Parameters

string
required
Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
string
slug query value.
boolean
Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false.
string
teamId query value.
string
The project ID or name (required when not using OIDC token).

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_OBSERVABILITY_CONFIGURATION_PROJECTSLists disabled Observability Plus projects. Lists the projects that are currently configured as disabled for Observability Plus on a team.

Input Parameters

string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_OBSERVABILITY_SCHEMARetrieve the available Vercel observability metrics and their query schemas.

Input Parameters

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_OBSERVABILITY_SCHEMA_BY_METRIC_IDRetrieve the schema and supported dimensions for one observability metric.

Input Parameters

string
required
metricId path value.

Output

array
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_OR_CREATE_DRIVEGet or create a drive. Gets an existing drive by project and name, or creates it when it does not exist.

Input Parameters

string
required
Name for the drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
string
slug query value.
string ("iad1" \| "sfo1" \| "cle1" \| "cdg1" \| "fra1" \| "arn1" \| "sin1" \| "pdx1" \| "lhr1" \| "icn1" \| "bom1" \| "cpt1" \| "dub1" \| "gru1" \| "hkg1" \| "syd1" \| "yul1" \| "hnd1" \| "kix1")
Region where the drive is stored. Defaults to iad1.
string
teamId query value.
string
The project ID or name to associate the drive with. Required unless using a Vercel OIDC token scoped to a project.
integer
Maximum drive size in bytes. Must be a multiple of 4096 bytes. Defaults to 1 TiB when omitted (1 GiB for Hobby). The maximum quota is 16 TiB. Request a quota above 16 TiB at https://vercel.com/help.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ORDERGet a domain order. Get information about a domain order by its ID

Input Parameters

string
teamId query value.
string
required
orderId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECTDEPRECATED: Use VERCEL_VERCEL_GET_PROJECT2 instead. Tool to retrieve information about a Vercel project by ID or name. Use when you need project metadata after obtaining its identifier.

Input Parameters

string
Team identifier to perform the request on behalf of. Required for team projects, omit for personal account projects.
string
required
The unique project identifier (e.g., ‘prj_xxxx’) or project name (e.g., ‘my-app’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT2Tool to find a project by ID or name with comprehensive details. Use when you need complete project metadata including configuration, deployments, security settings, and analytics.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_BOXESGet project daemons. List the daemons of a project.

Input Parameters

string
slug query value.
string
Maximum daemons to return (default: 10, max: 100)
string
Pagination cursor
string
teamId query value.
string
required
The unique project identifier or the project name
string ("target" \| "branch" \| "customEnvironment")
Filter by scope type
string
Filter by scope value (requires scopeType)

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_CHECKGet a check. Return a detailed response for a single check.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The ID of the resource that will be updated.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_DOMAINTool to retrieve details about a specific domain attached to a Vercel project. Use when you need to check domain configuration, verification status, redirect settings, or git branch associations.

Input Parameters

string
Team slug to perform the request on behalf of
string
required
The project domain name to retrieve (e.g., ‘www.example.com’)
string
Team identifier to perform the request on behalf of
string
required
The unique project identifier or project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_DOMAINSTool to retrieve all domains attached to a Vercel project. Use when you need to verify domain configuration, check verification status, audit redirect/branch bindings, or before performing domain operations.

Input Parameters

string
Team URL slug to perform the request on behalf of.
integer
Maximum number of domains to return per request. Maximum value is 100.
string ("ASC" | "DESC")
Sort order by creation date. ‘ASC’ for ascending, ‘DESC’ for descending. Default is ‘DESC’.
integer
Returns domains created after this JavaScript timestamp in milliseconds.
integer
Returns domains created before this JavaScript timestamp in milliseconds.
string ("production" | "preview")
Filters by domain target. Use ‘production’ for production domains or ‘preview’ for preview domains. Cannot be combined with production; provide only one filter.
string
Team identifier to perform the request on behalf of. Omit for personal account.
string
required
The project’s unique identifier or project name.
string
Filters domains by their redirect target domain name.
boolean
Filters by verification status. Set to true for verified domains only, false for unverified.
string
Filters domains based on a specific git branch.
boolean
Controls redirect domain inclusion. Set to true to include redirect domains, false to exclude. Default is true.
boolean
Filters domains by production status. Set to true for production domains, false for non-production. Cannot be combined with target; provide only one filter.
string
The unique custom environment identifier within the project to filter domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_ENVTool to retrieve the decrypted value of an environment variable from a Vercel project. Use when you need to access the actual value of a specific environment variable by its ID.

Input Parameters

string
required
The unique ID for the environment variable to get the decrypted value.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECTSTool to retrieve a list of projects from Vercel. Use this to get project information with optional filtering by repository, team, or other criteria.

Input Parameters

string
Query only projects updated after the given timestamp or continuation token.
string
Filter results by repo. Also used for project count.
string
The Team slug to perform the request on behalf of.
string
Limit the number of projects returned.
string
Filter results by Repository ID.
Search projects by the name field.
string
The Team identifier to perform the request on behalf of.
string
Filter results by Repository URL.
boolean
Filter results by deprecated projects.
string
Filter results by connected Edge Config ID.
string
Filter results by excluding those projects that belong to a repo.
string ("0" | "1")
Filter results by projects with Static IPs enabled. Use ‘1’ for enabled, ‘0’ for disabled.
string
Filter results by build machine types. Accepts comma-separated values. Use ‘default’ for projects without a build machine type set.
string
Filter results by connected Edge Config Token ID.
string ("0" | "1")
Specifies whether PRs from Git forks should require a team member’s authorization before it can be deployed. Use ‘1’ for enabled, ‘0’ for disabled.
string ("0" | "1")
Filter results by projects with elastic concurrency enabled. Use ‘1’ for enabled, ‘0’ for disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROJECT_TRACEGet a project trace by request ID. Returns the OTEL trace for a given Vercel CLI request.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The project ID
string
required
The Vercel CLI request ID associated with the trace

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_PROMOTE_ALIASESTool to get a list of aliases with status for the current promote operation. Use when you need to check the status of aliases during a promotion process for a specific project.

Input Parameters

string
The Team slug to perform the request on behalf of.
integer
Maximum number of aliases to list from a request (max 100).
integer
Get aliases created after this epoch timestamp in milliseconds.
integer
Get aliases created before this epoch timestamp in milliseconds.
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier of the project.
boolean
Filter results down to aliases that failed to map to the requested deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_REDIRECTSGets project-level redirects.. Get the version history for a project’s bulk redirects

Input Parameters

string
q query value.
boolean \| string ("only")
diff query value.
integer
page query value.
string
slug query value.
string ("source" \| "destination" \| "statusCode")
sort_by query value.
string
teamId query value.
integer
per_page query value.
string
required
projectId query value.
string ("asc" \| "desc")
sort_order query value.
string
versionId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_REGISTRY_BLOB_UPLOADGet blob upload status. GET /v2/:teamSlug/:projectSlug/:repositoryName/blobs/uploads/:uuid Query the status of an in-progress blob upload. Used by clients to resume a partial upload after an interruption.

Input Parameters

string
required
Blob upload session identifier.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_REPOSITORYGet a repository. Fetch a container registry repository for a project by ID or name.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_REPOSITORY_IMAGEGet a repository image. Fetch an individual image from a repository, including its tags and Dockerfile history entries with discriminated layer details for UI rendering. The image may be addressed by its internal id (image_...) or by its manifest digest (sha256:...).

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.
string
required
The internal image id (image_...) or the image manifest digest (sha256:...).

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_REPOSITORY_TAGGet a repository tag. Fetch a single tag from a repository, including the backing image’s metadata and VHS-readiness status.

Input Parameters

string
required
tag path value.
string
slug query value.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ROLLING_RELEASETool to retrieve active rolling release information for a Vercel project. Use when you need to check the status of a gradual deployment rollout.

Input Parameters

string
The Team slug to perform the request on behalf of.
string ("ACTIVE" | "COMPLETE" | "ABORTED")
Filter by rolling release state.
string
The Team identifier to perform the request on behalf of.
string
required
Project ID or project name (URL-encoded).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ROLLING_RELEASE_BILLING_STATUSTool to retrieve the rolling release billing status for a Vercel project. Use when you need to check if rolling releases are available for a project based on the team’s plan.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
Project ID or project name (URL-encoded).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ROLLING_RELEASE_CONFIGTool to get rolling release configuration for a Vercel project. Use when you need to retrieve the project-level rolling release settings that define how deployments are gradually rolled out.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
Project ID or project name (URL-encoded)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ROUTESGet project routing rules. Get the routing rules for a project. Supports searching by name/ID/pattern, filtering by route type, and diffing staged changes against production.

Input Parameters

string
q query value.
boolean \| string ("only")
diff query value.
string
slug query value.
string ("rewrite" \| "redirect" \| "set_status" \| "transform")
filter query value.
string
teamId query value.
string
required
projectId path value.
string
versionId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_ROUTE_VERSIONSGet routing rule version history. Get the version history for a project’s routing rules. Returns the staging version (if one exists) followed by production versions, most recent first. The staging version has isStaging: true and the current production version has isLive: true.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_RUNTIME_LOGSDEPRECATED: Use VERCEL_GET_DEPLOYMENT_LOGS2 instead. Tool to retrieve runtime logs for a specific Vercel deployment. Use when monitoring deployment execution, debugging runtime issues, or analyzing deployment performance. Runtime logs show application behavior during execution, including errors and request information.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string
required
The unique identifier of the project
string
required
The unique identifier of the deployment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SANDBOX_COMMANDRetrieve a sandbox command, optionally waiting for it to complete.

Input Parameters

string
The Team slug to perform the request on behalf of.
boolean
Whether to wait for the command to finish before returning.
string
required
The identifier of the sandbox command to retrieve.
string
required
The identifier of the sandbox session that ran the command.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SECURITY_FIREWALL_EVENTS_SUMMARYRead Firewall Actions Summary by Project. Aggregate counts over the firewall actions matched by the same filters as GET /v1/security/firewall/events, without fetching any rows. Counts are of policies (mitigations), including ones that matched no requests.

Input Parameters

array
ip query value.
string
slug query value.
string
hosts query value.
array
action query value.
array
ruleId query value.
string
teamId query value.
boolean
isActive query value.
string ("system" \| "custom")
ruleKind query value.
string
required
projectId query value.
array
actionType query value.
number
endTimestamp query value.
number
startTimestamp query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SESSIONGet a session. Retrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the session to retrieve.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SESSION_COMMAND_LOGSStream command logs. Streams the output of a command in real-time using newline-delimited JSON (ND-JSON). Each entry includes the output data and stream type. Stream types include stdout, stderr, and error (for stream failures).

Input Parameters

string
slug query value.
string
required
The unique identifier of the command to stream logs for.
string
teamId query value.
string
required
The unique identifier of the session containing the command.
integer
Local limit on streamed JSON records to collect before closing the response. Defaults to 1000.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SESSION_SNAPSHOTGet a snapshot. Retrieves detailed information about a specific snapshot, including its creation time, size, expiration date, and the source session it was created from.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the snapshot to retrieve.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SHARED_ENV_VARTool to retrieve the decrypted value of a Shared Environment Variable by id. Use when you need to inspect a specific shared environment variable value.

Input Parameters

string
required
The unique ID for the Shared Environment Variable to get the decrypted value.
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_SHARED_ENV_VARIABLESTool to list all shared environment variables for a team. Use when you need to retrieve or inspect shared environment variables across projects.

Input Parameters

string
Filter shared environment variables based on comma-separated IDs.
string
The Team slug to perform the request on behalf of.
string
Search term to filter environment variables by key name.
string
The Team identifier to perform the request on behalf of.
string
Filter shared environment variables that belong to a specific project.
string
Exclude shared environment variables based on comma-separated IDs.
string
Exclude shared environment variables that belong to a specific project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_STORAGE_STORERetrieve a Vercel storage store, its project metadata, and optional guides.

Input Parameters

string
required
The unique identifier of the Vercel storage store to retrieve.
boolean
Whether to omit project metadata from the response.
boolean
Whether to include setup guides in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_TEAMRetrieves detailed information about a specific Vercel team by its ID or slug. Returns comprehensive team metadata including billing, membership, resource configuration, and settings. Use this to get team details before performing team-specific operations. The teamId parameter accepts either a team ID (e.g., ‘team_xxx’) or team slug (e.g., ‘my-team’).

Input Parameters

string
Optional team slug to scope the request. Used for authorization when accessing team-specific resources.
string
required
The Team identifier or slug to retrieve information for. Can be either a team ID (e.g., ‘team_RcupkAQdr25D0qQu2MmPu6Th’) or a team slug (e.g., ‘my-team’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_TEAM_ACCESS_REQUESTGet access request status. Check the status of a join request. It’ll respond with a 404 if the request has been declined. If no userId path segment was provided, this endpoint will instead return the status of the authenticated user.

Input Parameters

string
required
The unique team identifier
string
required
The unique user identifier

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_TEAMSTool to list all teams accessible to the authenticated user with detailed information. Use when you need comprehensive team data including membership, configuration, and settings.

Input Parameters

integer
Maximum number of Teams which may be returned.
integer
Timestamp (in milliseconds) to only include Teams created since then.
integer
Timestamp (in milliseconds) to only include Teams created until then.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_TLD_INFOTool to get information about a specific top-level domain (TLD). Use when you need to check supported language codes for domain registration.

Input Parameters

string
required
The top-level domain (TLD) to get information for. Examples include: ‘com’, ‘net’, ‘org’, ‘io’, ‘dev’, ‘app’, etc. Do not include the leading dot (use ‘com’ not ‘.com’).
string
Optional Vercel Team ID to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_TLD_PRICETool to get pricing information for a specific top-level domain (TLD). Use when you need to check domain registration, renewal, or transfer costs.

Input Parameters

string
required
The top-level domain (TLD) to get pricing for. Examples include: ‘com’, ‘net’, ‘org’, ‘io’, ‘dev’, ‘app’, etc. Do not include the leading dot (use ‘com’ not ‘.com’).
integer
The number of years to get the price for. If not provided, the minimum number of years for the TLD will be used.
string
Optional Vercel Team ID to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_USER_EVENTSTool to list user events. Use when you need to retrieve events generated by a user or team, such as logins, deployments, and team activities.

Input Parameters

string
The Team slug to perform the request on behalf of.
integer
Maximum number of items which may be returned.
string
Timestamp to only include items created since then.
string
Comma-delimited list of event “types” to filter the results by.
string
Timestamp to only include items created until then.
string
The Team identifier to perform the request on behalf of.
string
Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.
string
Comma-delimited list of project IDs to filter the results by.
string
When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.
string
When set to true, the response will include the payload field for each event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_INVOCATIONGet a specific invocation attempt. Get Invocation

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_INVOCATION_LOGSGet log lines for an invocation attempt. Get Invocation Logs

Input Parameters

string
slug query value.
array
Only return log lines with one of these levels.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_INVOCATION_TREEGet an invocation with its jobs and tasks. Returns an invocation attempt together with every job definition, its latest job run, and the task definitions and active task runs of that job run. Defaults to the latest attempt when attempt is omitted. With follow=1 the response is a newline-delimited JSON stream: a {"type":"tree", ...} event with the full tree is sent immediately and again whenever it changes, and a final {"type":"end","reason":...} event is sent when the attempt finishes (completed) or the stream reaches its maximum duration (timeout), after which clients should reconnect.

Input Parameters

string
slug query value.
integer (0 \| 1)
When 1, stream the tree as newline-delimited JSON until the attempt finishes.
string
Invocation attempt to return. Defaults to the latest attempt.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_JOB_DEFINITIONGet a specific job definition. Get Job Definition

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_JOB_RUNGet a specific job run attempt. Get Job Run

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
runAttempt path value.
string
required
invocationId path value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_JOB_RUN_LOGSGet log lines for a specific job run attempt. Get Job Run Logs

Input Parameters

string
slug query value.
array
Only return log lines with one of these levels.
number
since query value.
integer (0 \| 1)
follow query value.
string
required
attempt path value.
string
teamId query value.
string
required
runAttempt path value.
string
required
invocationId path value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_REPOSITORY_SETTINGSGet Vercel CI settings for a connected repository. Get Repository Settings

Input Parameters

string
slug query value.
string
teamId query value.
string ("bitbucket" \| "cursor-origin" \| "github" \| "gitlab" \| "vercel")
required
provider query value.
string
required
repository query value.
string
required
organizationId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_TASK_ANALYSISGet the current status of a Vercel CI task analysis. Get task analysis

Input Parameters

string
slug query value.
string
teamId query value.
string
required
analysisId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_TASK_LOGSGet log lines for the tasks of an invocation attempt. Returns log lines for the tasks of an invocation attempt in a single request, grouped by task. Tasks can be narrowed by name and by conclusion, for example conclusion=failed to fetch only the logs of failed tasks. With search, every matching task is searched at once and only tasks with matching lines are returned.

Input Parameters

string
slug query value.
array
Only return tasks with one of these names (e.g., \“web#test\”).
array
Only return log lines with one of these levels.
number
Maximum number of tasks to return (default: 10, max: 25).
string
Only return log lines containing this text, ignoring case. Tasks without matching lines are left out, limit is ignored, and at most 1000 lines are returned.
string
required
attempt path value.
string
teamId query value.
array
Only return completed tasks with one of these conclusions.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERCEL_CI_TASK_RUN_LOGSGet log lines for a specific task run attempt. Get Task Run Logs With follow=1 the response is a newline-delimited JSON stream of log lines that ends once the task run has finished and its logs are flushed, or when the stream reaches its maximum duration.

Input Parameters

string
slug query value.
array
Only return log lines with one of these levels.
number
since query value.
integer (0 \| 1)
When 1, stream log lines as newline-delimited JSON until the task run finishes.
string
required
attempt path value.
string
teamId query value.
string
required
runAttempt path value.
string
required
invocationId path value.
string
required
taskRunAttempt path value.
string
required
jobDefinitionId path value.
string
required
taskDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_VERSIONSGet the version history for a project’s redirects.. Get the version history for a project’s bulk redirects

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_GET_WEBHOOKTool to retrieve details of a specific webhook by ID. Use when you need to inspect webhook configuration, events, or metadata.

Input Parameters

string
required
The unique identifier of the webhook to retrieve (e.g., ‘account_hook_v3dYzpfkptKPBE483PIHvN0y’)
string
The Team slug to perform the request on behalf of. Alternative to team_id.
string
The Team identifier to perform the request on behalf of. Required when accessing team webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_INITIATE_REGISTRY_BLOB_UPLOADStart a blob upload. POST /v2/:teamSlug/:projectSlug/:repositoryName/blobs/uploads/[?mount=<digest>&from=<repo>] Initiate a blob upload. Returns a UUID in the Location header that the client uses for subsequent PATCH (chunk) and PUT (complete) requests.

Input Parameters

string
Digest of the blob to mount from another repository.
string
required
Single Docker repository team slug component.
string
Source repository to mount the blob from.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_INVALIDATE_CACHE_BY_SRC_IMAGESTool to invalidate edge cache by source image URLs. Use when you need to mark cached images as stale for specific source images. Invalidated images are revalidated in the background on the next request, ensuring zero latency impact for users.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
array
required
List of source image URLs to invalidate from edge cache. Must contain 1-8 URLs, each up to 8192 characters. Invalidated images will be revalidated in the background on next request.
string
required
The project ID or name to invalidate cache for. This is required and must be a valid project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_INVALIDATE_CACHE_BY_TAGSTool to invalidate edge cache by tags. Use when you need to mark cached content as stale for specific cache tags. Invalidated content is revalidated in the background on the next request, ensuring zero latency impact for users.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
Cache tags to invalidate. Can be a single tag string or a list of tag strings (1-16 elements, max 256 chars per tag). Invalidated content will be revalidated in the background on next request.
string ("production" | "preview")
Target environment to invalidate cache from. Either ‘production’ or ‘preview’.
string
The Team identifier to perform the request on behalf of.
string
required
The project ID or name to invalidate cache for. This is required and must be a valid project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_INVITE_USER_TO_TEAMInvite a user. Invite a user to join the team specified in the URL. The authenticated user needs to be an OWNER in order to successfully invoke this endpoint. The user to be invited must be specified by email.

Input Parameters

object
required
The single user to invite; email is required.
string
slug query value.
string
required
teamId path value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_ISSUE_CERTIssue a new cert. Issue a new cert

Input Parameters

array
The common names the cert should be issued for
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_KILL_SESSION_COMMANDKill a command. Sends a signal to terminate a running command in a session. The signal can be used to gracefully stop (SIGTERM) or forcefully kill (SIGKILL) the process. The command must still be running for this operation to succeed.

Input Parameters

string
slug query value.
string
required
The unique identifier of the command to terminate.
number
required
The POSIX signal number to send to the process. Common values: 15 (SIGTERM) for graceful termination, 9 (SIGKILL) for forced termination.
string
teamId query value.
string
required
The unique identifier of the session containing the command.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ACCESS_GROUP_MEMBERSList members of an access group. List members of an access group

Input Parameters

string
Continuation cursor to retrieve the next page of results.
string
slug query value.
integer
Limit how many access group members should be returned.
string
Search project members by their name, username, and email.
string
teamId query value.
string
required
The ID or name of the Access Group.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ACCESS_GROUP_PROJECTSList projects of an access group. List projects of an access group

Input Parameters

string
Continuation cursor to retrieve the next page of results.
string
slug query value.
integer
Limit how many access group projects should be returned.
string
teamId query value.
string
required
The ID or name of the Access Group.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ACCESS_GROUPSList access groups for a team, project or member. List access groups

Input Parameters

string
Continuation cursor to retrieve the next page of results.
string
slug query value.
integer
Limit how many access group should be returned.
string
Search for access groups by name.
string
teamId query value.
string
Filter access groups by project.
integer
Number of members to include in the response.
integer
Number of projects to include in the response.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AI_GATEWAY_BUDGET_DEFAULTSList AI Gateway budget defaults. List the team’s AI Gateway budget defaults as a flat per-scope list (one row per team/project/api-key/user scope with a default set). An empty list is a normal state for the dashboard.

Input Parameters

string
slug query value.
string
teamId query value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AI_GATEWAY_BUDGETSList AI Gateway budgets. List the team’s AI Gateway budgets (team/project/user scopes, plus default-covered api-key spend) as a flat list, optionally filtered by scope. Without limit or cursor, returns every budget. With either, returns one page ordered by quotaEntityId plus nextCursor (null on the last page) and defaultCoveredCounts. Paging still reads the full merge server-side: the gateway meter list it joins has no cursor.

Input Parameters

string
slug query value.
integer
Maximum number of budgets to return (capped at 200). Enables pagination.
string
Opaque cursor returned by a prior call as nextCursor.
string
teamId query value.
string ("team" \| "project" \| "user" \| "api-key")
Restrict the list to a single budget scope.
string ("true" \| "false")
Whether to include rows inherited from a budget default (source: "default"). Defaults to true.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AI_GATEWAY_ROUTERSList AI Gateway routers. List the authenticated team’s active and archived custom routers.

Input Parameters

string
slug query value.
string
teamId query value.
string
The owner (team) ID to list routers for. Only trusted-origin callers use this. Public callers select their team with teamId or slug, and a supplied ownerId never overrides the authenticated team.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AI_GATEWAY_RULESList rules. List the authenticated team’s routing rules, oldest first. Without limit or cursor, returns every rule. With either, returns one page and a nextCursor for the next page (null on the last page). Paging reads and sorts the team’s rules server-side, which is fine at current rule counts.

Input Parameters

string
slug query value.
integer
Maximum number of rules to return (capped at 200). Enables pagination.
string
Opaque cursor returned by a prior call as nextCursor.
string
teamId query value.
string ("true" \| "false")
includeDisabled query value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AI_GATEWAY_VIRTUAL_MODEL_CONFIGSList virtual model configs. List virtual model configs. For a team, returns all of its VMCs, or with limit or cursor one page ordered by virtualModelSlug. Across teams, pages newest-first. includeArchived=false omits archived VMCs.

Input Parameters

string
slug query value.
integer
limit query value.
string
cursor query value.
string
teamId query value.
string
ownerId query value.
string ("true" \| "false")
includeArchived query value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ALIASESTool to list aliases from Vercel API. Use when you need to retrieve aliases with optional filtering by domain, project, or time range. Results are paginated; use limit with since/until to iterate pages. Without filters, results span all projects and the personal account scope.

Input Parameters

integer
Get only aliases created after the provided timestamp (milliseconds).
string
The Team slug to perform the request on behalf of.
integer
Maximum number of aliases to list from a request.
integer
Get aliases created after this JavaScript timestamp (milliseconds).
integer
Get aliases created before this JavaScript timestamp (milliseconds).
string
Get only aliases of the given domain name.
string
The Team identifier to perform the request on behalf of.
string
Filter aliases from the given projectId.
string
Get aliases that would be rolled back for the given deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ALL_DEPLOYMENTSDEPRECATED: Use VERCEL_GET_DEPLOYMENTS instead. Lists deployments under your user or team context. Results are cursor-paginated; follow pagination.next until null to retrieve all pages. In team contexts, omitting teamId or slug will cause deployments to appear missing. Example: “List deployments for project QmX…”.

Input Parameters

string
Name of the deployment to filter by
string
Filter deployments based on the commit SHA
string
Team slug to perform the request on behalf of
integer
Maximum number of deployments to return
integer
Get deployments created after this JavaScript timestamp Value must be in milliseconds UTC.
string
Comma-separated list of states to filter by. Allowed: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED
integer
Get deployments created before this JavaScript timestamp
string
Comma-separated list of user IDs to filter by creator. Example: ‘kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY’
string
Filter deployments based on the branch name
string
Filter deployments based on the environment (e.g., ‘production’)
string
Team identifier to perform the request on behalf of
string
Filter deployments from the given project ID or name
boolean
Filter deployments based on rollback candidacy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_AUTH_TOKENSTool to list authentication tokens. Use when you need to retrieve all tokens for the current user or an optional team.

Input Parameters

string
Team ID to list tokens for. If omitted, lists tokens for the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_BILLING_CHARGESList FOCUS billing charges. Returns the billing charge data in FOCUS v1.3 JSONL format for a specified Vercel team, within a date range specified by from and to query parameters. Supports 1-day granularity with a maximum date range of 1 year. The response is streamed as newline-delimited JSON (JSONL) and can be optionally compressed with gzip if the Accept-Encoding: gzip header is provided. SkuId is the stable product ID. For unmapped items, it is derived from the item identifier. This is only available for Owner, Member, Developer, Security, Billing, and Enterprise Viewer roles for the supplied team.

Input Parameters

string
required
Exclusive end of the date range as an ISO 8601 date-time string in UTC.
string
slug query value.
string
teamId query value.
string
required
Inclusive start of the date range as an ISO 8601 date-time string in UTC.
integer
Local limit on streamed JSON records to collect before closing the response. Defaults to 1000.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_CHECK_RUNSList runs for a check. List all runs associated with a given check.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The ID of the resource that will be updated.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_CONNECTOR_PROJECT_CONNECTIONSList projects for a connector. List the projects connected to a connector and the environments where each connection is available.

Input Parameters

string
slug query value.
integer
Maximum number of project connections to return. Defaults to 50.
string
Cursor from pagination.next on the previous response.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_CONNECTORSList connectors. List connectors that belong to a team.

Input Parameters

string
slug query value.
string ("name" \| "createdAt" \| "updatedAt")
Sort by name in ascending order, or by creation or update time in descending order.
string
Comma-separated connector types: slack, discord, github, linear, linq, salesforce, sendblue, snowflake, snowflake-wif, microsoft-entra, api-key, photon, oauth, or custom.
integer
Maximum number of connectors to return. Defaults to 20.
string
Cursor from pagination.next on the previous response.
string
Search connector names, UIDs, and services.
string
Comma-separated provider or service identifiers.
string
teamId query value.
string
Return only connectors connected to this project.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_CONTRACT_COMMITMENTSList FOCUS contract commitments. Returns commitment allocations per contract period in FOCUS v1.3 JSONL format for a specified Vercel team. The response is streamed as newline-delimited JSON (JSONL). This endpoint is only applicable to Enterprise Vercel customers. An empty response is returned for non-Enterprise (Pro/Flex) customers.

Input Parameters

string
slug query value.
string
teamId query value.
integer
Local limit on streamed JSON records to collect before closing the response. Defaults to 1000.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DEPLOYMENT_ALIASESTool to list all aliases assigned to a specific deployment. Use when you need to retrieve the aliases (custom domains or URLs) that point to a particular deployment.

Input Parameters

string
required
The ID of the deployment the aliases should be listed for
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DEPLOYMENT_CHECK_RUNSList check runs for a deployment. List all check runs for a deployment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
deploymentId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DEPLOYMENT_CHECKSTool to retrieve a list of checks for a specific deployment. Use after a deployment to inspect check statuses and results.

Input Parameters

string
Team slug on whose behalf to perform the request.
string
Team ID on whose behalf to perform the request.
string
required
The ID of the deployment to retrieve checks for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DEPLOYMENT_FILESTool to list all files in a specific deployment. Use when you need to inspect the file tree structure of a deployed application.

Input Parameters

string
required
The unique deployment identifier
string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DNS_RECORDSTool to list existing DNS records for a domain. Use when you need to retrieve, audit, or verify DNS configuration for a domain managed in Vercel.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
Maximum number of records to list from a request. Default is 20, maximum is 100.
string
Get records created after this JavaScript timestamp in milliseconds.
string
Get records created before this JavaScript timestamp in milliseconds.
string
required
The domain name to retrieve DNS records for
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DOMAINSTool to list all domains from Vercel. Use this to retrieve domain information including verification status, nameservers, and ownership details.

Input Parameters

string
The Team slug to perform the request on behalf of.
integer
Maximum number of domains to list from a request.
integer
Get domains created after this JavaScript timestamp.
integer
Get domains created before this JavaScript timestamp.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_DRIVESList drives. Retrieves a paginated list of drives belonging to a specific project.

Input Parameters

string
slug query value.
number
Maximum number of drives to return in the response. Used for pagination.
string
Opaque pagination cursor from a previous response.
string ("createdAt" \| "updatedAt" \| "name")
Field to sort drives by.
string
teamId query value.
string
The project ID or name associated with the drives. Required unless using a Vercel OIDC token scoped to a project.
string ("asc" \| "desc")
Sort direction for results.
string
Filter drives whose name starts with this prefix. Only valid when sortBy=name.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_EDGE_CONFIG_BACKUPSTool to retrieve backups for a specific Edge Config. Use when you need to list or inspect available backups for recovery purposes.

Input Parameters

string
Pagination cursor for the next page of results
string
The Team slug to perform the request on behalf of
integer
Maximum number of backups to return (max 50)
string
The Team identifier to perform the request on behalf of
string
Metadata filter for backups
string
required
Unique identifier of the Edge Config to retrieve backups for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_EDGE_CONFIG_ITEMSTool to retrieve all items from a specific Edge Config. Use when you need to inspect all key-value pairs stored in an Edge Config.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
string
required
Unique identifier of the Edge Config to retrieve items from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_EDGE_CONFIGSTool to retrieve all Edge Configs for an account or team. Use when you need to list all Edge Config definitions.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_EDGE_CONFIG_TOKENSTool to get all tokens of an Edge Config. Use when you need to retrieve the complete list of tokens associated with a specific Edge Config.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique identifier of the Edge Config.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_ENV_VARIABLESDEPRECATED: Use FilterProjectEnvs instead. Tool to list environment variables for a specific project. Use when you need to inspect or page through the environment settings before deployment. Each returned env var has independent target scopes (production/preview/development); never assume a variable applies to all environments. Env var changes require a new deployment to take effect. Example: { “projectId”: “prj_nos3l9LxEmu8dYCFBaUVlox26eRJ”, “decrypt”: false, “limit”: 20 }

Input Parameters

integer
Maximum number of variables to return (1-100).
integer
Pagination cursor. Use the pagination.next timestamp from a prior response. Repeat requests with each new pagination.next value until no cursor is returned to avoid missing variables.
boolean
Whether to return decrypted values. Even with decrypt=true, values may still be redacted if the token lacks sufficient permissions; treat empty values as potentially redacted, not absent.
string
Filter variables for a specific git branch.
string
required
Unique identifier of the project. Must be the internal Vercel project ID (e.g., from VERCEL_LIST_PROJECTS), not the project name — using the name returns empty or misleading results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_EVENT_TYPESList Event Types. Returns the list of user-facing event types with descriptions.

Input Parameters

string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_FIREWALL_EVENTSRetrieve firewall events and security actions for a specific Vercel project. Use this tool when you need to: - Monitor security events and blocked requests for a project - Analyze firewall actions (blocks, challenges, rate limits) over a time period - Investigate suspicious activity or attack patterns - Review which firewall rules are being triggered Note: This endpoint requires appropriate permissions. Enterprise or Pro plans may be required.

Input Parameters

string
Comma-separated list of hostnames to filter firewall events by. Only events affecting these domains will be returned. Example: ‘example.com,www.example.com’.
string
The Team identifier to perform the request on behalf of. Required when accessing team resources.
string
required
The unique identifier of the Vercel project (e.g., ‘prj_abc123’). Required parameter to retrieve firewall events for that specific project.
integer
End timestamp in milliseconds (Unix epoch) to filter firewall events until. Events returned will be up to this time. If not provided, returns events up to the current time.
integer
Start timestamp in milliseconds (Unix epoch) to filter firewall events from. Events returned will be from this time onwards. If not provided, returns recent events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_FLAGSList flags. Retrieve feature flags for a project. The list can be filtered by state and supports pagination.

Input Parameters

string
slug query value.
array
Filter flags by tag. Repeat the parameter for multiple tags (all must match).
integer
Maximum number of flags to return. When not set, all flags are returned.
string ("active" \| "archived")
The state of the flags to retrieve. Defaults to active.
string
Pagination cursor to continue from.
string
Search flags by their slug or description. Case-insensitive.
string
teamId query value.
boolean
Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release. Use GET /v1/projects/:id/feature-flags/flags/:flagIdOrSlug?withMetadata=true for single-flag lookups that need creator metadata.
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_FLAG_SEGMENTSList segments. List all feature flag segments for a project.

Input Parameters

string
slug query value.
string
teamId query value.
boolean
Whether to include metadata
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_FLAGS_V2List flags. Retrieve feature flags for a project. Returns an opaque cursor for pagination.

Input Parameters

string
slug query value.
array
Filter flags by tag. Repeat the parameter for multiple tags (all must match).
integer
Maximum number of flags to return.
string ("active" \| "archived")
The state of the flags to retrieve. Defaults to active.
string
Pagination cursor to continue from.
string
Search flags by their slug or description. Case-insensitive.
string
teamId query value.
string
Filter flags by the id of the entity that created them (a user or team id).
array
Filter flags by maintainer user id. Repeat the parameter for multiple maintainers (any may match).
string
required
The project id or name
boolean
Whether to include Marketplace experimentation items in the paginated response. Defaults to false.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_FLAG_VERSIONSList flag versions. Lists flag versions for a given flag.

Input Parameters

string
slug query value.
number
limit query value.
string
Pagination cursor
string
teamId query value.
string
Environment to filter by
boolean
Whether to include metadata
string
required
flagIdOrSlug path value.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_INTEGRATION_LOG_DRAINSRetrieves a list of Integration log drains for a team or account. Log drains forward logs from deployments to external endpoints. When using an OAuth2 token, results are limited to log drains created by the authenticated integration.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_KMS_ISSUERSList issuers. Retrieve the paginated KMS issuers that belong to the authenticated team or organization (orgId).

Input Parameters

string
Continuation cursor to retrieve the next page of results.
string
slug query value.
integer
Maximum number of issuers to return.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_NETWORKSList Secure Compute networks. Allows to list Secure Compute networks.

Input Parameters

string
slug query value.
string
The query to use as a filter for returned networks
string
teamId query value.
boolean
Whether to include projects in the response
boolean
Whether to include Hosted Zones in the response
boolean
Whether to include VPC Peering connections in the response

Output

array
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_PROJECT_CHECKSList all checks for a project. List all checks for a project, optionally filtered by target.

Input Parameters

string
slug query value.
string ("build-start" \| "deployment-start" \| "deployment-alias" \| "deployment-promotion" \| "none")
blocks query value.
string
teamId query value.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_PROJECT_CONNECTOR_CONNECTIONSList connectors for a project. List the connectors connected to a project and the environments where each connection is available.

Input Parameters

string
slug query value.
integer
Maximum number of connector connections to return. Defaults to 50.
string
Cursor from pagination.next on the previous response.
string
teamId query value.
string
required
Vercel project ID.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_PROJECT_CUSTOM_ENVIRONMENTSTool to retrieve custom environments for a Vercel project. Use when you need to list all custom environments or filter by git branch.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name
string
Fetch custom environments for a specific git branch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_PROJECT_MEMBERSTool to list all members of a Vercel project. Use when you need to retrieve member information, check access permissions, or audit project membership.

Input Parameters

string
Team slug to perform the request on behalf of.
integer
Maximum number of project members to return per request (1-100, default 20).
integer
Timestamp in milliseconds to only include members added since then.
integer
Timestamp in milliseconds to only include members added until then.
string
Search project members by their name, username, and email.
string
Team identifier to perform the request on behalf of. Omit for personal account.
string
required
The project’s unique identifier or project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_PROJECTSDEPRECATED: Use GetProjects instead. Tool to list all projects accessible to the authenticated user or team. Use this to retrieve project IDs and metadata for further operations. Results are paginated (max 100 per page); iterate using the pagination.next cursor to retrieve all pages — pagination.count reflects only the current page, not the total.

Input Parameters

integer
Maximum number of projects to return (max 100)
integer
Timestamp in milliseconds; include projects created since this time Must be UTC milliseconds; passing seconds or non-UTC values silently excludes expected projects.
integer
Timestamp in milliseconds; include projects created until this time
string
Search query to filter projects by name
string
Team identifier to perform the request on behalf of. Omit for personal account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_REGISTRY_TAGSList image tags. GET /v2/:teamSlug/:projectSlug/:repositoryName/tags/list List the tags in a repository. The last parameter accepts the opaque cursor from a previous response’s Link header. Unparseable cursors return HTTP 400 with code invalid_cursor.

Input Parameters

integer
n query value.
string
Opaque pagination cursor returned by a previous list response.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_REPOSITORIESList repositories. List container registry repositories for a project.

Input Parameters

string
slug query value.
integer
limit query value.
string
Opaque pagination cursor returned by a previous list response.
string
teamId query value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_REPOSITORY_IMAGESList repository images. List images for a container registry repository, including their tags.

Input Parameters

string
slug query value.
integer
limit query value.
string
Opaque pagination cursor returned by a previous list response.
string
teamId query value.
boolean
untagged query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_REPOSITORY_PERMISSIONSList repository permissions. List the teams a VCR repository is shared with.

Input Parameters

string
slug query value.
integer
limit query value.
string
Opaque pagination cursor returned by a previous list response.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_REPOSITORY_TAGSList repository tags. List a repository’s tags.

Input Parameters

string
slug query value.
integer
limit query value.
string
cursor query value.
string ("updatedAt" \| "tag")
Field to sort the non-pinned tags by.
string
teamId query value.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.
string ("asc" \| "desc")
Sort direction. Defaults to desc.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_SANDBOXESList named sandboxes for a Vercel project with filters and cursor pagination.

Input Parameters

string
Team slug to perform the request on behalf of.
string
One tag filter formatted as “key:value”. The API also accepts a one-item list.
number
Maximum number of sandboxes to return (1-50).
string
Opaque pagination cursor from pagination.next in a previous response.
string ("createdAt" | "name" | "statusUpdatedAt" | "currentSnapshotId")
Field used to sort the sandboxes. The provider defaults to createdAt.
string ("running" | "stopping" | "stopped")
Sandbox status filter. Valid only when sortBy is createdAt.
string
Project ID or name whose named sandboxes should be returned.
string ("asc" | "desc")
Sort direction. The provider defaults to desc.
string
Return sandbox names beginning with this prefix. Valid only when sortBy is name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_SANDBOX_SNAPSHOTSList a project’s sandbox snapshots and continue with pagination.next.

Input Parameters

string
Filter by a URL-safe sandbox name.
string
Team slug to perform the request on behalf of.
number
Maximum snapshots to return (1-50). Vercel defaults to 20.
string
Opaque cursor from pagination.next in a previous response.
string
Project ID or name whose sandbox snapshots should be listed.
string ("asc" | "desc")
Sort direction by creation time. Vercel defaults to desc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_SESSION_COMMANDSList commands. Retrieves a list of all commands that have been executed in a session, including their current status, exit codes, and execution times, ordered from the most recent to the oldest.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the session to list commands for.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_SESSIONSList sessions. Retrieves a paginated list of sessions belonging to a specific sandbox. Results are sorted by creation time and paginated using an opaque cursor.

Input Parameters

string
Filter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned.
string
slug query value.
number
Maximum number of sessions to return in the response. Used for pagination.
string
Opaque pagination cursor from a previous response.
string
The unique identifier or name of the project to list sessions for.
string
teamId query value.
string ("asc" \| "desc")
Sort direction for results by creation time.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_SUPPORTED_TLDSTool to retrieve all TLDs (top-level domains) supported by Vercel for domain registration. Use when you need to verify if a specific TLD is supported or to display available domain extensions.

Input Parameters

string
Optional team identifier to perform the request on behalf of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_TEAM_FLAGSList all flags for a team. Retrieve all feature flags for a team across all projects. The list can be filtered by state and supports pagination.

Input Parameters

string ("boolean" \| "string" \| "number" \| "json")
The kind of flags to retrieve.
string
slug query value.
array
Filter flags by tag. Repeat the parameter for multiple tags (all must match).
integer
Maximum number of flags to return.
string ("active" \| "archived")
The state of the flags to retrieve. Defaults to active.
string
Pagination cursor to continue from.
string
Search flags by their slug or description. Case-insensitive.
string
required
teamId path value.
boolean
Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_TEAM_FLAG_SETTINGSList team project flag settings. Retrieve feature flag settings for projects in a team.

Input Parameters

string
slug query value.
integer
Maximum number of settings to return.
string
Pagination cursor to continue from.
string
required
teamId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_TEAM_FLAGS_V2List all flags for a team. Retrieve all feature flags for a team across all projects. Returns an opaque cursor for pagination.

Input Parameters

string ("boolean" \| "string" \| "number" \| "json")
The kind of flags to retrieve.
string
slug query value.
array
Filter flags by tag. Repeat the parameter for multiple tags (all must match).
integer
Maximum number of flags to return.
string ("active" \| "archived")
The state of the flags to retrieve. Defaults to active.
string
Pagination cursor to continue from.
string
Search flags by their slug or description. Case-insensitive.
string
required
teamId path value.
string
Filter flags by the id of the entity that created them (a user or team id).
array
Filter flags by maintainer user id. Repeat the parameter for multiple maintainers (any may match).
boolean
Whether to include Marketplace experimentation items in the paginated response. Defaults to false.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_TEAM_MEMBERSTool to list all members of a Vercel team. Use when you need to retrieve team member information, check team access permissions, or audit team membership.

Input Parameters

string ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "VIEWER_FOR_PLUS" | "CONTRIBUTOR")
Only return members with the specified team role.
integer
Maximum number of team members to return per request.
integer
Timestamp in milliseconds to only include members added since then.
integer
Timestamp in milliseconds to only include members added until then.
string
Search team members by their name, username, and email.
string
required
The team’s unique identifier. Required to specify which team’s members to list.
string
Exclude members who belong to the specified project.
string
Include team members who are eligible to be members of the specified project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_TEAMSDEPRECATED: Use VERCEL_VERCEL_GET_TEAMS instead. Tool to list all teams accessible to the authenticated user. Use after authentication to retrieve team IDs and slugs; resolve the correct teamId or slug here before passing it to other Vercel tools (e.g., VERCEL_GET_PROJECT, deployment queries) — an incorrect or missing teamId causes 404 or scoping errors.

Input Parameters

integer
Maximum number of teams to return (max 100)
integer
Timestamp in milliseconds; include teams created since this time
integer
Timestamp in milliseconds; include teams created until this time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_BRANCHESList Vercel CI branch suggestions for a team. List branches

Input Parameters

string
slug query value.
number
limit query value.
string
query query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_INVOCATION_ATTEMPTSList all attempts for an invocation. List Invocation Attempts

Input Parameters

string
slug query value.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_INVOCATIONSList invocations for a team, optionally filtered by repository and invocation metadata. List Invocations

Input Parameters

string
slug query value.
number
Number of results per page (default: 20, max: 100).
string
GitHub author login.
string
Pagination cursor from a previous response.
array
source query value.
array
status query value.
string
teamId query value.
string ("github" \| "gitlab" \| "bitbucket" \| "vercel")
Repository provider (e.g., \“github\”).
string
Snapshot/commit hash.
array
conclusion query value.
string
Repository slug (e.g., \“vercel/next.js\”).
string
Branch name (e.g., \“main\”).
number
createdAfter query value.
number
createdBefore query value.
string
authorGitHubId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_JOB_DEFINITIONSList job definitions for an invocation attempt. List Job Definitions

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_JOB_RUNSList all runs for a job definition. List Job Runs

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_TASK_ANALYSIS_TASKSList discovered tasks for a completed Vercel CI task analysis. List task analysis tasks

Input Parameters

string
slug query value.
string
limit query value.
string
cursor query value.
string
teamId query value.
string
required
analysisId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_TASK_DEFINITIONSList all task definitions for a job run. List Task Definitions

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
runAttempt path value.
string
required
invocationId path value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_VERCEL_CI_TASK_RUNSList task runs for a job run. List Task Runs

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
runAttempt path value.
string
required
invocationId path value.
string
taskRunAttempt query value.
string
required
jobDefinitionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_LIST_WEBHOOKSTool to retrieve a list of all webhooks for the authenticated account or team. Use this to discover configured webhooks and their event subscriptions.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
Filter webhooks by project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_MANAGE_ROUTE_VERSIONPromote, restore, or discard an existing routing-rule version; never create one.

Input Parameters

string
required
Identifier of the existing routing-rule version to promote, restore, or discard.
string
Team slug to perform the request on behalf of.
string ("promote" | "restore" | "discard")
required
Operation to apply to the existing version: promote publishes a staged version, restore rolls back to a previous production version, and discard removes a staged version without publishing it.
string
required
Identifier of the project that owns the existing routing-rule version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_MOVE_PROJECT_DOMAINTool to move a domain from one Vercel project to another. Use when you need to transfer domain ownership between projects.

Input Parameters

string
Team slug to perform the request on behalf of
string
required
The project domain name to move (e.g., ‘www.example.com’)
string
Team identifier to perform the request on behalf of
string
required
The unique project identifier or project name of the source project
string
Target destination domain for redirection. When set, requests to this domain will redirect to the specified target domain.
string
Git branch to associate with this domain in the target project. When set, deployments from this branch will be accessible via this domain. Maximum 250 characters.
string
required
The unique identifier of the target project to move the domain to
integer ("301" | "302" | "307" | "308")
HTTP status code for redirect. 301: Permanent redirect (cached by browsers), 302: Temporary redirect, 307: Temporary redirect (preserves method), 308: Permanent redirect (preserves method).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_PATCH_EDGE_CONFIG_SCHEMA_V1Update Global Config schema. Update a Global Config’s schema.

Input Parameters

string
slug query value.
string
dryRun query value.
string
teamId query value.
string \| number \| boolean \| null \| array \| object
required
definition body value.
string
required
edgeConfigId path value.

Output

object \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_PAUSE_PROJECTTool to pause a Vercel project. Use when you need to temporarily disable a project to prevent new deployments and stop serving traffic.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier. Must be the project ID (e.g., ‘prj_xxxx’), not the project name. You can get project IDs from the list projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_POST_TEAM_DSYNC_ROLESUpdate Team Directory Sync Role Mappings. Update the Directory Sync role mappings for a Team. This endpoint allows updating the mapping between directory groups and team roles or access groups.

Input Parameters

string
slug query value.
object
required
Directory groups to role or access group mappings.
string
required
teamId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_PULL_ENVIRONMENT_VARIABLESPull effective runtime and build environment maps for a project or deployment.

Input Parameters

string
Team slug to perform the request on behalf of
string
Project environment target: production, preview, development, or a custom environment identifier or name. Ignored for deployment IDs.
string
Git branch whose effective project environment to resolve. Requires target and is ignored for deployment IDs.
string
required
Vercel project ID or name, or a deployment ID beginning with ‘dpl_‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_PUT_PROJECT_DAEMON_INSTANCESOverride a project daemon’s instance counts. Override the instance counts of a daemon in the given regions, without changing its configuration or the overrides of other regions.

Input Parameters

object
Instance count overrides for the given regions, for example { \“iad1\”: 1 }. Overrides of regions not in the map are kept. A null count removes the region’s override. An empty map removes all overrides.
string
slug query value.
string ("production" \| "preview")
The deployment target for the daemon configuration.
string
teamId query value.
string
required
The unique project identifier or the project name
string
required
The name of the daemon to scale

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_READ_ACCESS_GROUPReads an access group. Allows to read an access group

Input Parameters

string
slug query value.
string
teamId query value.
string
required
idOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_READ_ACCESS_GROUP_PROJECTReads an access group project. Allows reading an access group project

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId path value.
string
required
accessGroupIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_READ_FIREWALL_CONFIGTool to read firewall configuration for a Vercel project. Use when you need to inspect current firewall settings, IP rules, or custom security rules for a project.

Input Parameters

string
Team identifier to perform the request on behalf of. Omit for personal account.
string
required
The ID of the project to retrieve firewall configuration for. This is a required parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_READ_NETWORKRead a Secure Compute network. Allows to read a Secure Compute network.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the Secure Compute network

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_READ_SANDBOX_FILERead and download a file from an existing Vercel Sandbox session.

Input Parameters

string
Optional working directory used to resolve a relative file path.
string
required
The file path to read, resolved relative to cwd when cwd is provided.
string
The team URL slug to perform the request on behalf of.
string
required
The ID of the existing Sandbox session that contains the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RECORD_EVENTSTool to record artifacts cache usage events. Use when tracking cache hits and misses for artifact hashes to monitor remote caching performance.

Input Parameters

string
The Team slug to perform the request on behalf of.
array
required
Array of cache usage events to record. Each event tracks a cache hit or miss for an artifact.
string
The Team identifier to perform the request on behalf of.
string
The continuous integration or delivery environment where this artifact is downloaded.
integer ("0" | "1")
1 if the client is an interactive shell, otherwise 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_BYPASS_IPRemove System Bypass Rule. Remove system bypass rules

Input Parameters

string
note body value.
string
slug query value.
string
domain body value.
string
teamId query value.
string
sourceIp body value.
string
required
projectId query value.
boolean
allSources body value.
boolean
projectScope body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_CERTRemove cert. Remove cert

Input Parameters

string
required
The cert id to remove
string
slug query value.
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_CUSTOM_ENVIRONMENTRemove a custom environment. Remove a custom environment for the project. Must not be named ‘Production’ or ‘Preview’.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique project identifier or the project name
string
required
The unique custom environment identifier within the project
boolean
Delete Environment Variables that are not assigned to any environments.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_PROJECT_DOMAINTool to remove a domain from a Vercel project. Use when you need to detach a domain from a project or clean up domain associations.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The project domain name to remove (e.g., ‘www.example.com’)
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier or the project name
boolean
Whether to remove all domains from this project that redirect to the domain being removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_PROJECT_MEMBERRemove a Project Member. Remove a member from a specific project

Input Parameters

string
required
The user ID of the member.
string
slug query value.
string
teamId query value.
string
required
The ID or name of the Project.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_REPOSITORY_PERMISSIONRemove a repository permission. Revoke a team’s access to a VCR repository.

Input Parameters

string
slug query value.
string
teamId query value.
string
Slug of a team that is granted access to a repository.
string
required
idOrName path value.
string
required
Project ID or name (slug) within the authenticated team. IDs take precedence over names. Missing or empty values return HTTP 400.
string
ID of a team that is granted access to a repository.

Output

any \| null
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REMOVE_TEAM_MEMBERRemove a Team Member. Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. Directory Sync members can be removed when their directory email is absent or does not match the user’s primary or verified secondary emails.

Input Parameters

string
required
The user ID of the member.
string
required
The unique team identifier
string
The ID of the team to set as the new default team for the Northstar user.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RENEW_DOMAINRenew a domain. Renew a domain

Input Parameters

number
required
The number of years to renew the domain for.
string
required
domain path value.
string
teamId query value.
number
required
expectedPrice body value.
object
contactInformation body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REPLACE_CONNECTOR_TRIGGER_DESTINATIONSUpdate connector trigger destinations. Replace the full set of destinations that receive trigger requests for a connector.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.
array
required
Complete replacement set of trigger destinations. An empty array removes all destinations. Connector get and list responses expose the saved set as triggerDestinations.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REPLACE_DOMAINS_BY_DOMAIN_RECORDSCall Vercel’s unversioned domain-record replacement operation. Operation semantics are undocumented. Matches the official SDK’s exact PUT /domains/{domain}/records invocation, which accepts only a domain and sends no request body. This does not expose the CLI’s versioned zone-file import operation; equivalence with that route is unverified.

Input Parameters

string
required
The domain name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REPLACE_FIREWALL_CONFIGTool to update firewall configuration for a Vercel project. Use when you need to enable/disable firewall, configure CRS rules, or manage custom firewall rules and IP restrictions.

Input Parameters

object
Common Request Security (CRS) configuration.
array
IP-based firewall rules
string
The Team slug to perform the request on behalf of
array
Custom firewall rules
string
The Team identifier to perform the request on behalf of
string
required
The unique project identifier
boolean
Whether bot identification is enabled
object
Managed rules configuration
boolean
required
Whether the firewall is enabled for this project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REQUEST_ACCESS_TO_TEAMRequest access to a team. Request access to a team as a member. An owner has to approve the request. Only 100 users can request access to a team at the same time.

Input Parameters

string
required
The unique team identifier
object
required
joinedFrom body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REQUEST_DELETE_USERTool to initiate user account deletion on Vercel. Use when a user wants to delete their account. This triggers a verification email to confirm the deletion request.

Input Parameters

array
Optional array of objects that describe the reason why the User account is being deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REQUEST_PROMOTETool to promote a deployment to production by pointing all production domains for a project to the given deployment. Use this when you need to make a specific deployment live without rebuilding. The deployment must be in ‘STAGED’ state (never served production traffic) and the project must have auto-assignment of custom production domains disabled. For deployments that have already been promoted (seen production traffic), use instant rollback instead.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier. Use VERCEL_LIST_PROJECTS to find available projects.
string
required
The deployment identifier to promote to production. The deployment must be in ‘STAGED’ state (readySubstate=‘STAGED’). Use VERCEL_LIST_ALL_DEPLOYMENTS to find eligible deployments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_REQUEST_ROLLBACKPoint production traffic to a previous production deployment by ID. Allows users to rollback to a deployment.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
projectId path value.
string
The reason for the rollback
string
required
The ID of the deployment to rollback to

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RESTART_PROJECT_DAEMON_INSTANCEForce restart a project daemon instance. Force restart a running production daemon instance. The new container starts asynchronously after the restart is accepted.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique project identifier or the project name
string
required
The name of the daemon that owns the instance
string
required
The ID of the daemon instance to restart

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RESTORE_EDGE_CONFIG_BACKUPRestore Global Config backup. Restores a Global Config backup.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
edgeConfigId path value.
string
required
edgeConfigBackupVersionId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RESTORE_REDIRECTSRestore staged project-level redirects to their production version.. Restores the provided redirects in the staging version to the value in the production version. If no production version exists, removes the redirects from staging.

Input Parameters

string
name body value.
string
slug query value.
string
teamId query value.
array
required
The redirects to restore. The source of the redirect is used to match the redirect to restore.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_RETRY_VERCEL_CI_INVOCATIONRetry a terminal Vercel CI invocation attempt. Retry Invocation

Input Parameters

string
slug query value.
string
required
attempt path value.
string
teamId query value.
string
required
invocationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_SEARCH_DOMAINSGet Domain Availability and Pricing. Start domain research here. Get registration availability and pricing for 1–200 exact domain names. Returns results in input order, with registration and renewal prices in USD for available domains. No authentication required.

Input Parameters

array
required
an array of at most 200 item(s)
string
teamId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_SEARCH_REPOTool to search and list Git repositories linked to a namespace by provider. Use this to discover available repositories for integration with Vercel projects.

Input Parameters

string
The custom Git host if using a custom Git provider, like GitHub Enterprise Server
string
The Team slug to perform the request on behalf of
string
Search query to filter repositories by name
string
The Team identifier to perform the request on behalf of
string ("github" | "github-limited" | "github-custom-host" | "gitlab" | "bitbucket")
Filter by Git provider type (github, github-limited, github-custom-host, gitlab, or bitbucket)
string
The ID of the namespace to search repositories in
string
The ID of the Git integration installation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_SEARCH_REQUEST_LOGSSearch historical request logs for a Vercel project and time window.

Input Parameters

integer
Zero-based result page.
array
Log levels to include.
string
Git branch to filter deployments by.
string
Full-text search across request log messages.
array
Request sources to include.
integer
required
Inclusive end time in Unix milliseconds.
string
required
User or team ID that owns the project.
string
required
Project ID.
string
Specific request ID to match.
integer
required
Inclusive start time in Unix milliseconds.
string
Exact HTTP status code or wildcard class such as 4xx or 5xx.
string ("production" | "preview")
Deployment environment to filter by.
string
Exact request path to match.
string
Deployment ID to filter request logs by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_SEARCH_VERCEL_CI_LOGSSearch the task logs of several invocation attempts. Searches the task logs of up to 50 invocation attempts at once, for example the most recent runs of a branch from GET /v2/vercel-ci/invocations. Only invocations and tasks with matching lines are returned. When more than 1000 lines match, the newest are kept.

Input Parameters

string
slug query value.
array
Only return log lines with one of these levels.
string
required
Only return log lines containing this text, ignoring case.
string
teamId query value.
array
required
Invocation attempts to search, as \“<invocationId>:<attempt>\” (at most 50).

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_STAGE_REDIRECTSStages new redirects for a project.. Stages new redirects for a project and returns the new version.

Input Parameters

string
name body value.
string
slug query value.
string
teamId query value.
boolean
overwrite body value.
array
redirects body value.
string
required
projectId body value.
string
required
teamId body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_STAGE_ROUTESStage routing rules. Stage routing rules for a project. Set overwrite to true to replace all existing rules, or omit it to merge with existing rules by ID. Returns the new staged version.

Input Parameters

string
slug query value.
array
routes body value.
string
teamId query value.
boolean
overwrite body value.
string
required
projectId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_START_ROLLING_RELEASEStart a rolling release for the project. Start a rolling release for a deployment. If a rolling release is already active for the same canary deployment, returns the current state without side effects.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Project ID or project name (URL-encoded)
string
required
The ID of the canary deployment to start the rolling release for

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_STOP_SESSIONStop a session. Stops a running session and releases its allocated resources. All running processes within the session will be terminated. This action cannot be undone. A stopped session cannot be restarted.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique identifier of the session to stop.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_TEST_DRAINTool to validate a drain delivery configuration by sending a test request. Use when you need to verify that a drain endpoint is properly configured and can receive events before creating the actual drain.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
object
required
Schema definitions for the drain events. Can be an empty object {} if no specific schemas are required
object
required
Delivery configuration specifying where and how to send drain events

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_TRANSFER_IN_DOMAINTool to transfer a domain to Vercel from another registrar. Use when you need to migrate domain registration to Vercel. Before transferring, obtain the authorization code from the current registrar and verify the domain is unlocked and eligible for transfer.

Input Parameters

integer
required
Number of years to renew the domain for after transfer. Must be valid for the TLD.
string
required
The domain name to transfer in (e.g., ‘example.com’)
string
Team ID to perform the transfer on behalf of
string
required
Authorization code for the domain transfer. Obtain this code from the current (losing) registrar.
boolean
required
Whether the domain should automatically renew before expiration. Can be changed later via the Vercel Dashboard or API.
number
required
Expected transfer price in USD. Use this to prevent unexpected charges if the price changes between checking and transferring.
object
required
Contact information for domain registration. All fields except address2, company_name, and fax are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UNPAUSE_PROJECTTool to unpause a specific project by its ID. Use after identifying a paused project to enable auto assigning custom production domains and unblock the active Production Deployment.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_ACCESS_GROUPUpdate an access group. Allows to update an access group metadata

Input Parameters

string
The name of the access group
string
slug query value.
string
teamId query value.
array
projects body value.
string
required
idOrName path value.
array
List of members to add to the access group.
array
List of members to remove from the access group.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_ACCESS_GROUP_PROJECTUpdate an access group project. Allows update of an access group project

Input Parameters

string ("ADMIN" \| "PROJECT_VIEWER" \| "PROJECT_DEVELOPER") \| null
required
The project role that will be added to this Access Group.
string
slug query value.
string
teamId query value.
string
required
projectId path value.
string
required
accessGroupIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_AI_GATEWAY_RULEUpdate rule. Update a routing rule (enabled, action, or description)

Input Parameters

string
slug query value.
object
action body value.
boolean (false \| true)
enabled body value.
string
required
ruleId body value.
string
teamId query value.
string
description body value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_AI_GATEWAY_VIRTUAL_MODEL_CONFIGUpdate a virtual model config by its body slug and supplied update fields.

Input Parameters

array
Limit providers to those with these features.
string
The Team slug to perform the request on behalf of.
string ("cost" \| "latency" \| "price" \| "throughput" \| "tps" \| "ttft")
Rank eligible providers by an attribute.
string ("fast")
Only use fastest providers with short timeouts.
array
Ordered model candidates or fallbacks, optionally with intelligence attributes or a conditional model/when entry.
string
UI lifecycle status: draft, active, or archived.
string ("auto")
Use caching if available.
boolean (false \| true)
Whether this VMC is soft-deleted.
string
The Team identifier to perform the request on behalf of.
string
For kind=relay: URL the gateway forwards requests to as a transparent proxy.
string
User or app id that last updated this VMC.
string
Visibility in listings: public, internal, or stealth.
string
Optional description for UI.
string
Human-readable name for UI.
string ("fast" \| "flex" \| "priority")
Service tier for providers that support it.
array
Restrict routing to only these providers.
array
Ordered list of providers to try as fallbacks on failure.
object
Region pinned on the VMC for system-credential routing (alias/router only).
string
Canonical model slug this VMC maps to (e.g. “creator/model”). Not used by kind=router.
object
Arbitrary per-provider AI SDK options, keyed by gateway provider slug.
object
Per-request provider timeouts in ms, keyed by provider slug for BYOK credentials.
array
Observability tags attached to requests through this VMC.
string
required
Client-facing virtual model slug of the config to update.
boolean (false \| true)
Only use providers with zero data retention.
boolean (false \| true)
Allow fallback from fast to standard providers on failure.
boolean (false \| true)
Only use providers that will not train on your prompts.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_AI_GATEWAY_VIRTUAL_MODEL_CONFIG_BY_SLUGUpdate virtual model config. Update a virtual model config by path slug

Input Parameters

array
Limit providers to those with these features.
string
slug query value.
string ("cost" \| "latency" \| "price" \| "throughput" \| "tps" \| "ttft")
Rank eligible providers by an attribute.
string ("fast")
Only use fastest providers with short timeouts.
array
For kind=router: ordered candidates, bare slugs/references or { slug, ...attributes }. For kind=alias: ordered fallback model slugs, optionally led by one conditional { model, when } entry, used when the primary model’s answers match when.
string
UI lifecycle status: draft, active, or archived.
string ("auto")
Use caching if available.
boolean (false \| true)
Whether this VMC is soft-deleted.
string
teamId query value.
string
For kind=relay: URL the gateway forwards requests to as a transparent proxy.
string
required
vmcSlug path value.
string
User or app id that last updated this VMC.
string
Visibility in listings: public, internal, or stealth.
string
Optional description for UI.
string
Human-readable name for UI.
string ("fast" \| "flex" \| "priority")
Service tier for providers that support it.
array
Restrict routing to only these providers.
array
Ordered list of providers to try as fallbacks on failure.
object
Region pinned on the VMC for system-credential routing (alias/router only).
string
Canonical model slug this VMC maps to (e.g. “creator/model”). Not used by kind=router.
object
Arbitrary per-provider AI SDK options, keyed by gateway provider slug.
object
Per-request provider timeouts in ms, keyed by provider slug for BYOK credentials.
array
Observability tags attached to requests through this VMC.
boolean (false \| true)
Only use providers with zero data retention.
boolean (false \| true)
Allow fallback from fast to standard providers on failure.
boolean (false \| true)
Only use providers that will not train on your prompts.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_ATTACK_CHALLENGE_MODETool to update Attack Challenge mode for a Vercel project. Use when you need to enable or disable enhanced security protection against potential attacks. Attack Challenge mode adds an extra verification layer to protect deployments.

Input Parameters

string
The Team slug to perform the request on behalf of. Alternative to teamId.
string
The Team identifier to perform the request on behalf of. Omit for personal account.
string
required
The unique identifier of the project to update Attack Challenge mode for
boolean
required
Whether to enable or disable Attack Challenge mode for the project
integer
required
Required timestamp in milliseconds specifying when Attack Challenge mode should automatically be disabled. Must be a future date within 24 hours from now. The API will reject timestamps in the past or more than 24 hours into the future.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_CUSTOM_ENVIRONMENTUpdate a custom environment. Update a custom environment for the project. Must not be named ‘Production’ or ‘Preview’.

Input Parameters

string
slug query value.
string
teamId query value.
string
The slug of the custom environment.
string
required
The unique project identifier or the project name
string
Description of the custom environment. This is optional.
object
How we want to determine a matching branch. This is optional.
string
required
The unique custom environment identifier within the project

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_DEPLOYMENT_CHECK_RUNUpdate a check run. Update an existing check run for a deployment.

Input Parameters

string
slug query value.
object
output body value.
string ("queued" \| "running" \| "completed")
status body value.
string
teamId query value.
string ("canceled" \| "skipped" \| "timeout" \| "failed" \| "neutral" \| "succeeded")
conclusion body value.
string
externalId body value.
string
required
checkRunId path value.
number
completedAt body value.
string
externalUrl body value.
string
required
deploymentId path value.
string
conclusionText body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_DNS_RECORDTool to update an existing DNS record. Use when you need to modify DNS record properties such as value, name, type, TTL, or comment. Ensure you have the record ID before calling this action.

Input Parameters

object
Configuration for SRV record type.
integer
The Time to live (TTL) value of the DNS record in seconds. Must be between 60 and 2147483647.
string
The name of the DNS record. Provide to update the record name.
string
The Team slug to perform the request on behalf of.
string ("A" | "AAAA" | "ALIAS" | "CAA" | "CNAME" | "HTTPS" | "MX" | "SRV" | "TXT" | "NS")
The type of the DNS record. Provide to change the record type.
object
Configuration for HTTPS record type.
string
The value of the DNS record. Provide to update the record value.
string
The Team identifier to perform the request on behalf of.
string
A comment to add context on what this DNS record is for. Maximum 500 characters.
string
required
The unique identifier of the DNS record to update
integer
The MX priority value of the DNS record. Required when record type is MX.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_DOMAINTool to update or move an apex domain on Vercel. Use when you need to modify domain configuration (zone settings) or transfer a domain to another team. For ‘update’ operation, you can modify the zone configuration. For ‘move-out’ operation, provide a destination team ID.

Input Parameters

string
required
The operation to perform. Use ‘update’ to modify domain configuration (zone, renew, customNameservers), or ‘move-out’ to transfer the domain to another team/account.
string
The Team slug to perform the request on behalf of.
boolean
Whether to enable Vercel DNS zone configuration for the domain (uses Vercel’s nameservers). Only applicable when op=‘update’. For ‘update’ operation, at least one of zone, renew, or customNameservers must be provided.
boolean
Whether to renew the domain. Only applicable when op=‘update’. Note: This field is deprecated.
string
required
The domain name to update or move (e.g., ‘example.com’)
string
The Team identifier to perform the request on behalf of.
string
The destination team ID to transfer the domain to. Required when op=‘move-out’.
array
List of custom nameservers for the domain. Only applicable when op=‘update’. Note: This field is deprecated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_DOMAIN_AUTO_RENEWUpdate auto-renew for a domain. Update the auto-renew setting for a domain

Input Parameters

string
required
domain path value.
string
teamId query value.
boolean
required
autoRenew body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_DOMAIN_NAMESERVERSUpdate nameservers for a domain. Update the nameservers for a domain. Pass an empty array to use Vercel’s default nameservers.

Input Parameters

string
required
domain path value.
string
teamId query value.
array
required
nameservers body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_EDGE_CONFIGTool to update an Edge Config by changing its slug. Use when you need to rename an Edge Config to reflect a new purpose or organizational structure.

Input Parameters

string
required
The new slug name for the Edge Config. Must contain only alphanumeric characters, underscores, and hyphens, with a maximum length of 64 characters
string
The Team identifier to perform the request on behalf of
string
The Team slug to perform the request on behalf of
string
required
The unique identifier of the Edge Config to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_EDGE_CONFIG_ITEMSTool to update items within a specific Edge Config. Use when you need to batch modify, add, or remove key-value pairs in an existing Edge Config.

Input Parameters

string
Team slug to perform the request on behalf of.
array
required
List of operations to perform on Edge Config items.
boolean
If true, validates the request without applying changes.
string
Team ID to perform the request on behalf of.
string
required
The unique identifier of the Edge Config to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_EDGE_CONFIG_SCHEMATool to update the JSON Schema for an Edge Config. Use when you need to define or modify validation rules for Edge Config items.

Input Parameters

string
The Team slug to perform the request on behalf of
string
Optional parameter to perform a dry run without applying changes
string
The Team identifier to perform the request on behalf of
object
required
Body object containing the schema definition to update
string
required
Unique identifier of the Edge Config to update the schema for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_FIREWALL_CONFIGTool to incrementally update Vercel Firewall configuration for a project using PATCH. Use when you need to: enable/disable the firewall (‘firewallEnabled’), add/remove IP blocking rules (‘ip.insert’/‘ip.remove’), manage custom rules (‘rules.insert’/‘rules.update’/‘rules.remove’), or configure OWASP CRS rules (‘crs.update’/‘crs.disable’). Each call modifies a single aspect of the configuration. For full replacement of firewall config, use VERCEL_PUT_FIREWALL_CONFIG instead.

Input Parameters

string
Identifier for the specific firewall rule or configuration being modified. Required for update/remove actions: ‘ip.remove’ (ip_xxx), ‘rules.update’/‘rules.remove’ (rule_xxx), ‘crs.update’/‘crs.disable’ (CRS rule name like ‘sqli’, ‘xss’, ‘lfi’, ‘rfi’, ‘rce’, ‘php’, ‘gen’, ‘sd’, ‘ma’, ‘sf’, ‘java’). Not required for ‘firewallEnabled’ or insert actions.
string
The Team slug to perform the request on behalf of.
string
The value for the firewall action. Type depends on action: boolean for ‘firewallEnabled’ (true/false), object for ‘ip.insert’ (e.g., {hostname: ’*’, ip: ‘192.168.1.1’, action: ‘deny’, notes: ‘Block IP’}), object for ‘crs.update’/‘crs.disable’ (e.g., {active: true, action: ‘log’}), object for ‘rules.insert’/‘rules.update’ containing name, active, conditionGroup, and action fields. Not required for remove actions when id is provided.
string
required
The firewall configuration action to perform. Supported actions: ‘firewallEnabled’ (enable/disable the firewall with boolean value), ‘ip.insert’ (add IP blocking rule with value containing hostname, ip, action, notes), ‘ip.remove’ (remove IP rule by id), ‘rules.insert’ (add custom firewall rule), ‘rules.update’ (modify existing rule by id), ‘rules.remove’ (delete rule by id), ‘crs.update’ (enable CRS rule by id like ‘sqli’, ‘xss’, ‘lfi’), ‘crs.disable’ (disable CRS rule by id), ‘managedRules.update’ (configure managed rulesets).
string
The Team identifier to perform the request on behalf of.
string
required
Project identifier to update firewall configuration for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_FLAGUpdate a flag. Update an existing feature flag. This endpoint supports partial updates, allowing you to modify specific properties like variants, environments, or state without providing the full flag configuration.

Input Parameters

number
A random seed to prevent split points in different flags from having the same targets
string
slug query value.
array
Tags for categorizing the flag
string ("active" \| "archived")
state body value.
string
Additional message for this version
string
teamId query value.
string
Etag to match, can be used interchangeably with the if-match header
array
The variants of the flag
boolean
Whether this flag is marked as permanent, indicating it should not be removed
string
The user who created this patch
string
A description of the flag
object
The configuration for the flag in different environments
boolean
Whether to include metadata in the response
array
The user ids of the maintainers of the flag
string
required
The flag id or name
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_FLAG_SEGMENTUpdate a segment. Update an existing feature flag segment.

Input Parameters

object
The data of the segment
string
hint body value.
string
slug query value.
string
label body value.
string
teamId query value.
array
operations body value.
string
description body value.
boolean
Whether to include metadata
string
required
The project id or name
string
required
The segment slug

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_FLAG_SETTINGSUpdate project flag settings. Update feature flag settings for a project.

Input Parameters

string
slug query value.
boolean
enabled body value.
string
teamId query value.
array
entities body value.
array
The environments to sync
string
required
The project id or name

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_INTEGRATION_DEPLOYMENT_ACTIONUpdate deployment integration action. Updates the deployment integration action for the specified integration installation

Input Parameters

string
required
action path value.
string ("running" \| "succeeded" \| "failed")
status body value.
array
outcomes body value.
string
statusUrl body value.
string
required
resourceId path value.
string
statusText body value.
string
required
deploymentId path value.
string
required
integrationConfigurationId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_MICROFRONTENDSUpdate the microfrontends settings. Update the microfrontends settings for a project.

Input Parameters

string
slug query value.
boolean
Enable or disable microfrontends for the project
string
teamId query value.
string
required
The unique project identifier
string
The default route used for screenshots and preview links for the project
boolean
Whether the application is the default application for the microfrontends group
string
The unique group identifier to add this microfrontend to
boolean
Whether observability data should be routed to this project or a root project. Can only be set for child applications.
boolean
Whether domains in this project should route as a microfrontend. Can only be set for child applications.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_MICROFRONTENDS_GROUPUpdate a microfrontends group. Updates a microfrontends group’s settings.

Input Parameters

string
The new name for the existing microfrontends group.
string
slug query value.
string
required
teamId path value.
string
required
groupId path value.
string
The new fallback environment for the microfrontends group. Must be “SAME_ENV”, “PRODUCTION”, or a valid custom environment slug from the default app.
boolean
Whether Preview Deployments can link to branches with the same name in other Git repositories.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_NETWORKUpdate a Secure Compute network. Allows to update a Secure Compute network.

Input Parameters

string
required
The name of the Secure Compute network
string
slug query value.
string
teamId query value.
string
required
The unique identifier of the Secure Compute network

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_OBSERVABILITY_CONFIGURATION_PROJECTUpdates a disabled Observability Plus project setting. Updates whether Observability Plus is disabled for a single project.

Input Parameters

string
slug query value.
string
teamId query value.
boolean
required
Whether Observability Plus should be disabled for the project
string
required
The ID or name of the project to update

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECTDEPRECATED: Use VERCEL_VERCEL_UPDATE_PROJECT2 instead. Tool to update an existing project. Partial-update: omitted fields are preserved, but nullable fields explicitly set to null will be cleared. Changes (including rootDirectory, buildCommand) only take effect on subsequent deployments — trigger a new deployment with VERCEL_CREATE_NEW_DEPLOYMENT after updating. Use after confirming the project ID or name.

Input Parameters

string
New name for the project (max 100 characters)
string
Team slug to perform the request on behalf of
boolean
Enable Git Large File Storage (LFS) for the project
string
Team identifier to perform the request on behalf of
string
required
The unique project identifier (e.g., prj_xxxx) or project name to update
string
The framework preset for the project. Common values: nextjs, react, vue, svelte, nuxtjs, gatsby, angular, astro, remix. Set to null for no framework
string
The dev command for local development (max 256 chars). Set to null to use framework default
string ("24.x" | "22.x" | "20.x" | "18.x" | "16.x")
Node.js version for builds and serverless functions
string
The build command for the project (max 256 chars). Set to null to use framework default
boolean
Make deployment source code and build logs publicly visible
string
Directory or relative path to project source code (max 256 chars). Set to null for project root
object
SSO protection configuration requiring team authentication to access deployments
string
The install command for dependencies (max 256 chars). Set to null to use auto-detected package manager
object
OpenID Connect JSON Web Token generation settings for serverless functions
string
The directory where build output is located (max 256 chars). Set to null for framework default
boolean
Show directory listing for folders without an index file
boolean
Require team member approval before deploying PRs from forked repositories
object
Password protection configuration for restricting access to deployments
boolean
Automatically expose Vercel system environment variables (VERCEL, VERCEL_ENV, etc.) to builds
boolean
Automatically assign custom domains to new production deployments
string
Default region for Serverless Functions (e.g., iad1=Washington DC, sfo1=San Francisco, cdg1=Paris)
boolean
Disable automatic preview deployments for pull requests/branches
string
Custom command to determine if build should be skipped (exit 0 to skip, exit 1 to build)
boolean
Allow Vercel customer support to view git source for debugging
boolean
Enable if source files exist outside the configured root directory (for monorepos)
string
User ID or email who last updated auto-assign custom domains setting
boolean
Skip deployments when no changes detected in root directory and its dependencies

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECT2Tool to update an existing Vercel project configuration. Use when you need to modify project settings such as framework, build commands, environment configuration, or deployment protection settings.

Input Parameters

string
The desired name for the project
string
The Team slug to perform the request on behalf of
boolean
Specifies whether Git LFS is enabled for this project
string
The Team identifier to perform the request on behalf of
string
required
The unique project identifier or the project name
string ("blitzjs" | "nextjs" | "gatsby" | "remix" | "react-router" | "astro" | "hexo" | "eleventy" | "docusaurus-2" | "docusaurus" | "preact" | "solidstart-1" | "solidstart" | "dojo" | "ember" | "vue" | "scully" | "ionic-angular" | "angular" | "polymer" | "svelte" | "sveltekit" | "sveltekit-1" | "ionic-react" | "create-react-app" | "gridsome" | "umijs" | "sapper" | "saber" | "stencil" | "nuxtjs" | "redwoodjs" | "hugo" | "jekyll" | "brunch" | "middleman" | "zola" | "hydrogen" | "vite" | "tanstack-start" | "vitepress" | "vuepress" | "parcel" | "fastapi" | "flask" | "fasthtml" | "sanity-v3" | "sanity" | "storybook" | "nitro" | "hono" | "express" | "h3" | "nestjs" | "elysia" | "fastify" | "xmcp")
The framework that is being used for this project. When null is used no framework is selected
object
Static IPs configuration.
string
The dev command for this project. When null is used this value will be automatically detected
string ("24.x" | "22.x" | "20.x" | "18.x" | "16.x" | "14.x" | "12.x" | "10.x")
Node.js version for the project
string
The build command for this project. When null is used this value will be automatically detected
boolean
Specifies whether the source code and logs of the deployments for this project should be public or not
string
The name of a directory or relative path to the source code of your project. When null is used it will default to the project root
object
SSO protection configuration.
string
The install command for this project. When null is used this value will be automatically detected
object
Resource configuration for the project.
object
OIDC token configuration.
string
The output directory of the project. When null is used this value will be automatically detected
boolean
Whether directory listing is enabled
boolean
Specifies whether PRs from Git forks should require a team member’s authorization before it can be deployed
object
Password protection configuration.
boolean
Whether to automatically expose system environment variables
boolean
Opt-in to preview toolbar on the project level
boolean
Whether to automatically assign custom domains
string
Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team
boolean
Opt-in to production toolbar on the project level
string
The region to deploy Serverless Functions in this project
Opts-out of the message prompting a CLI user to connect a Git repository in vercel link
boolean
Specifies whether preview deployments are disabled for this project
string
Command to determine if build step should be ignored
boolean
Specifies whether customer support can see git source for a deployment
boolean
Indicates if there are source files outside of the root directory
string
User who updated auto-assign custom domains setting
boolean
Opt-in to skip deployments when there are no changes to the root directory and its dependencies
boolean
Specifies whether Zero Config Failover is enabled for this project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECT_CHECKUpdate a check. Update an existing check.

Input Parameters

string
name body value.
string
slug query value.
string ("build-start" \| "deployment-start" \| "deployment-alias" \| "deployment-promotion" \| "none")
blocks body value.
array
targets body value.
string
teamId query value.
number
timeout body value.
string
required
checkId path value.
string ("build-ready" \| "deployment-url" \| "none")
requires body value.
boolean
isRerequestable body value.
string
required
projectIdOrName path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECT_DATA_CACHETool to update the data cache feature for a Vercel project. Use when you need to enable or disable data caching for a project’s deployments.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
boolean
Enable or disable data cache for the project. Set to true to disable, false to enable. Default is false (enabled).
string
required
The unique project identifier (e.g., ‘prj_xxxx’). Note: Project names are not accepted, only project IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECT_DOMAINTool to update a project domain in Vercel. Use when you need to modify domain settings such as git branch association, redirects, or redirect status codes for an existing project domain.

Input Parameters

string
Team slug to perform the request on behalf of
string
required
The project domain name to update (e.g., ‘www.example.com’, ‘api.mytest-domain.io’)
string
Team identifier to perform the request on behalf of
string
required
The unique project identifier or project name
string
Target destination domain for redirect. When set, requests to this domain will redirect to the specified target domain. Set to null to remove redirect.
string
Git branch to link the project domain. When set, deployments from this branch will be accessible via this domain. Set to null to unlink the branch. Maximum 250 characters.
integer ("301" | "302" | "307" | "308")
HTTP status code for redirect. Required when ‘redirect’ is set. 301: Permanent redirect (cached by browsers), 302: Temporary redirect, 307: Temporary redirect (preserves method), 308: Permanent redirect (preserves method). Set to null to remove redirect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_PROJECT_PROTECTION_BYPASSTool to update protection bypass for automation on a Vercel project. Use when you need to generate, revoke, or update automation bypass secrets for deployment protection.

Input Parameters

string
The Team slug to perform the request on behalf of.
object
Instructions for revoking and regenerating an automation bypass.
string
The Team identifier to perform the request on behalf of.
object
Instructions for updating an existing automation bypass.
object
Instructions for generating a new automation bypass secret.
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_ROLLBACK_DESCRIPTIONUpdates the description for a rollback. Updates the reason for a rollback, without changing the rollback status itself.

Input Parameters

string
required
projectId path value.
string
The reason for the rollback
string
required
deploymentId path value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_ROLLING_RELEASE_CONFIGUpdate the rolling release settings for the project. Update (or disable) Rolling Releases for a project. When disabling with the resolve-on-disable feature flag enabled, any active rolling release document is resolved using the disableRolloutAction parameter: “abort” to roll back (default), or “complete” to promote the canary to production. When enabling or updating config, changes only affect the next production deployment and do not alter a rollout that’s already in-flight. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn’t configured already.

Input Parameters

string
slug query value.
array
stages body value.
boolean
required
enabled body value.
string
teamId query value.
string
required
Project ID or project name (URL-encoded)
string ("automatic" \| "manual-approval")
advancementType body value.
string ("abort" \| "complete")
disableRolloutAction body value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_SANDBOXUpdate a sandbox. Updates the configuration of a sandbox. Only the provided fields will be modified; omitted fields remain unchanged.

Input Parameters

object
Default environment variables for the sandbox. Set to empty object to clear.
string
required
The sandbox to update.
string
slug query value.
object
Key-value tags to associate with the sandbox. Replaces existing tags. Set to empty object to clear. Maximum 5 tags.
array
List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed.
object
Drives to mount to the sandbox at the provided path. Replaces the current mounts; an empty object removes them all. Changes take effect when the next session starts.
string ("iad1" \| "sfo1" \| "cle1" \| "cdg1" \| "fra1" \| "arn1" \| "sin1" \| "pdx1" \| "lhr1" \| "icn1" \| "bom1" \| "cpt1" \| "dub1" \| "gru1" \| "hkg1" \| "syd1" \| "yul1" \| "hnd1" \| "kix1")
The Vercel region in which to create the sandbox.
boolean
Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false.
string ("node22" \| "node24" \| "node26" \| "python3.13")
The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available.
string
teamId query value.
integer
Maximum duration in milliseconds that the sandbox can run before being automatically stopped.
object
Resources to define the VM
string
The Connect network id for the target Secure Compute private network. Set to null to remove the sandbox from Secure Compute.
boolean
Whether the sandbox persists its state across restarts via automatic snapshots.
string
The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context.
object
networkPolicy body value.
array
The regions the sandbox falls back to when it cannot be created in region.
string
The snapshot ID to set as the current snapshot. Must be active and belong to the same project.
string \| object
Protect the N most recent snapshots with different expiration/deletion behavior. Set to null to clear.
string \| number \| boolean \| array \| object
Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_SESSION_NETWORK_POLICYUpdate network policy. Replaces the network access policy of a running session. Use this to control which external hosts the session can communicate with. This is a full replacement. Any previously configured network rules will be overwritten.

Input Parameters

object
body body value.
string
slug query value.
string
teamId query value.
string
required
The unique identifier of the session to update the network policy for.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_SHARED_ENV_VARIABLETool to update one or more shared environment variables. Use when you need to modify shared env var properties like value, target environments, or project linkages using their IDs.

Input Parameters

string
The Team slug to perform the request on behalf of
string
The Team identifier to perform the request on behalf of
object
required
Object where each key is an environment variable ID (not the key name) and the value contains the updates to apply. The ID format is typically ‘env_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_STATIC_IPSTool to configure Static IPs for a Vercel project. Use when you need to enable or configure Static IPs for builds or specific regions. Requires either ‘builds’ or ‘regions’ parameter to be provided.

Input Parameters

string
The Team slug to perform the request on behalf of.
boolean
Whether to use Static IPs for builds. Must provide either ‘builds’ or ‘regions’ parameter.
string
The Team identifier to perform the request on behalf of.
array
List of regions in which to enable Static IPs. Must provide either ‘builds’ or ‘regions’ parameter. Minimum 0 items, maximum 3 items. Each region code should be max 4 characters (e.g., ‘iad1’).
string
required
The unique project identifier or the project name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_TEAMTool to update a Vercel team’s configuration. Use when you need to modify team settings like name, description, security policies, or deployment settings.

Input Parameters

string
The name of the team.
object
SAML configuration for the team.
string
The Team slug to perform the request on behalf of.
string
The hash value of an uploaded image.
string
required
The Team identifier to perform the request on behalf of.
string
A new slug for the team.
string
A short text that describes the team.
string
Email domain for the team.
object
Whether or not remote caching is enabled for the team
boolean
Display or hide IP addresses in Monitoring queries.
boolean
Create a new invite code and replace the current one.
string
Enable preview toolbar: one of on, off or default.
string
Suffix that will be used for all preview deployments.
string
Enable production toolbar: one of on, off or default.
object
Default deployment expiration settings for new projects.
boolean
Display or hide IP addresses in Log Drains.
object
Default deployment protection settings for new projects.
string
Sensitive environment variable policy: one of on, off or default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_TEAM_MEMBERUpdate a Team Member. Update the membership of a Team Member on the Team specified by teamId, such as changing the role of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an OWNER of the Team.

Input Parameters

string
required
The ID of the member.
string
The role in the team of the member.
string
required
The unique team identifier
array
projects body value.
boolean (true)
Accept a user who requested access to the team.
object
joinedFrom body value.
array
The team permissions to set for the member. Permissions must be compatible with the team roles assigned to the member.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_URL_PROTECTION_BYPASSTool to update the protection bypass for a URL. Use when you need to configure shareable links with TTL, revoke/regenerate links, set user-scoped access permissions, or manage alias protection overrides.

Input Parameters

string
required
The alias or deployment ID to update protection bypass for
integer
Optional time the shareable link is valid for in seconds. If not provided, the shareable link will never expire. Maximum: 63,072,000 seconds.
string
Team slug to perform the request on behalf of
object
Configuration for user-scoped protection bypass.
object
Configuration for revoking/regenerating shareable links.
string
Team identifier to perform the request on behalf of
object
Configuration for alias protection override.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_VERCEL_CI_REPOSITORY_SETTINGSEnable or disable Vercel CI for a connected repository. Update Repository Settings

Input Parameters

string
slug query value.
string
teamId query value.
string ("bitbucket" \| "cursor-origin" \| "github" \| "gitlab" \| "vercel")
required
provider query value.
boolean
required
ciEnabled body value.
string
required
repository query value.
string
required
organizationId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPDATE_VERSIONPromote a staging version to production or restore a previous production version.. Update a version by promoting staging to production or restoring a previous production version

Input Parameters

string
required
id body value.
string
name body value.
string
slug query value.
string ("promote" \| "restore" \| "discard")
required
action body value.
string
teamId query value.
string
required
projectId query value.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPLOAD_ARTIFACTTool to upload a cache artifact to Vercel. Use when you need to store build artifacts in Vercel’s remote cache.

Input Parameters

string
required
The artifact hash identifier
string
Team slug to perform the request on behalf of
string
Team identifier to perform the request on behalf of
object
required
The artifact file to upload.
string
The base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header ‘x-artifact-tag’
integer
The time taken to generate the uploaded artifact in milliseconds
string
The continuous integration or delivery environment where this artifact was generated
integer
1 if the client is an interactive shell, otherwise 0

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPLOAD_FILETool to upload deployment files to Vercel. Use when preparing files for a Vercel deployment. The uploaded file is stored and returns CDN URLs for use in deployment creation.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
The Team identifier to perform the request on behalf of.
integer
The file size as an alternative to Content-Length.
string
Alternative to x-vercel-digest. The file SHA1 used to check integrity.
integer
The file size in bytes. If not provided, it will be calculated automatically.
string
The file SHA1 hash used to check integrity. If not provided, the SHA1 hash will be automatically computed from the file content.
object
required
File to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPLOAD_PROJECT_AVATARUpload a project avatar. Upload an image as the avatar of the project identified by idOrName. The request body is the raw bytes of a JPG, PNG, or SVG image; the Content-Type header must declare which. SVG payloads are sanitized and optimized server-side before storage. The final SHA-1 of the stored bytes becomes the project’s avatar value. The actual upload pipeline (validation, sanitization, S3 write, conditional updateProject, and event emission) lives in the shared @api/project-avatar-upload helper so it can be reused by background workers.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
The unique project identifier or the project name.
string ("image/png" \| "image/jpeg" \| "image/svg+xml")
required
Content-Type header matching the uploaded PNG, JPG, or SVG image.
string
Base64-encoded raw application/octet-stream request content.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPLOAD_REGISTRY_BLOB_CHUNKUpload a blob chunk. PATCH /v2/:teamSlug/:projectSlug/:repositoryName/blobs/uploads/:uuid Upload a chunk of blob data. The request body is streamed directly to S3 as a multipart upload part while hashing incrementally. The client may call this multiple times for chunked uploads.

Input Parameters

string
required
Blob upload session identifier.
string
required
Single Docker repository team slug component.
string
required
Single Docker repository project slug component.
string
Inclusive byte range start-end for this chunk.
string
required
Base64-encoded raw application/octet-stream request content.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPLOAD_REGISTRY_MANIFESTPush an image manifest. PUT /v2/:teamSlug/:projectSlug/:repositoryName/manifests/:reference Upload an image manifest. The digest is computed from the body and returned in the Docker-Content-Digest header.

Input Parameters

string
required
Manifest reference: a tag or digest.
string
required
Single Docker repository team slug component.
string ("application/vnd.oci.image.manifest.v1+json" \| "application/vnd.oci.image.index.v1+json" \| "application/vnd.docker.distribution.manifest.v2+json" \| "application/vnd.docker.distribution.manifest.list.v2+json")
required
Content-Type header value.
string
required
Single Docker repository project slug component.
string
required
Base64-encoded raw application/octet-stream request content.
string
required
Single Docker repository name component.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPSERT_AI_GATEWAY_BUDGETUpsert AI Gateway budget. Create or update a team-, project-, or user-scope AI Gateway budget.

Input Parameters

string
slug query value.
string
teamId query value.
string
Required when scopeType is “user”.
string
Required when scopeType is “project”.
string ("team" \| "project" \| "user")
required
scopeType body value.
number
required
Budget limit in dollars.
string ("daily" \| "weekly" \| "monthly" \| "none")
refreshPeriod body value.
array
alertThresholds body value.
boolean
Whether BYOK usage counts toward this budget.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPSERT_AI_GATEWAY_BUDGET_DEFAULTUpsert AI Gateway budget default. Create or update an AI Gateway budget default for one scope. Team-level authority only (owners/admins).

Input Parameters

string
slug query value.
string
teamId query value.
string ("team" \| "project" \| "api-key" \| "user")
required
scopeType body value.
number
required
Default budget limit in dollars.
string ("daily" \| "weekly" \| "monthly" \| "none")
refreshPeriod body value.
array
alertThresholds body value.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_UPSERT_CONNECTOR_PROJECT_CONNECTIONCreate or update a connector project connection. Connect a connector to a project, or replace the environments on an existing project connection.

Input Parameters

string
slug query value.
string
teamId query value.
string
required
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.
string
required
Vercel project ID.
array
required
One or more built-in environment names or stable custom environment IDs that belong to the project. Duplicate values are accepted and removed.

Output

any
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_VERIFY_PROJECT_DOMAINAttempts to verify a project domain by checking if DNS challenges are correctly configured. Call this after adding a domain to a project and setting up the required DNS TXT records. Returns verified=true if DNS is correctly configured, or an error with the required DNS records if verification fails.

Input Parameters

string
The Team slug to perform the request on behalf of.
string
required
The domain name to verify. This domain must have been previously added to the project and have the required DNS TXT records configured. Use VERCEL_GET_PROJECT_DOMAINS to see pending verifications.
string
The Team identifier to perform the request on behalf of.
string
required
The unique project identifier (e.g., ‘prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB’) or the project name (e.g., ‘my-project’). The domain must already be added to this project before verification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_WHO_AM_IReturn the identity (email, username) of the connected Vercel account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_WRITE_SESSION_COMMAND_STDINWrite to command stdin. Writes data to the stdin of a running command, and optionally closes it. The command must have been started with attachStdin set to true. Writes are applied in the order they are received. Send them one at a time to keep the data in order. A write returns once the command has accepted the data, and fails with a 504 after 30 seconds if the command is not reading stdin. Each write counts against the sandbox control plane rate limit, so batch small writes where possible. Set offset to the position in stdin where data starts to make a request safe to resend, for example after a 502 or 504: bytes the command has already received are skipped, and an offset past them fails with a 409. The response returns bytesWritten, the total written so far, and a 504 includes it in the error when the sandbox reports it. A request with no data and no close writes nothing and returns it.

Input Parameters

string
Base64-encoded bytes to write to the command stdin. The request body is limited to 1 MB, so send at most about 700 KB of data per request.
string
slug query value.
boolean
If true, closes the command stdin after writing data. Use this for commands that wait for end of input.
string
required
The unique identifier of the command to write to.
integer
The position in the command stdin where data starts. Bytes before the total already written are skipped, so a resent request does not write them twice. Fails with 409 if it is past the bytes written so far. Without it, data is appended.
string
teamId query value.
string
required
The unique identifier of the session containing the command.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VERCEL_WRITE_SESSION_FILESWrite files. Uploads and extracts files to a session’s filesystem. Files must be uploaded as a gzipped tarball (.tar.gz) with the Content-Type header set to application/gzip. The tarball contents are extracted to the session’s working directory, or to a custom directory specified via the x-cwd header.

Input Parameters

string
slug query value.
string
The target directory where the tarball contents will be extracted. If not specified, files are extracted to the sandbox home directory.
string
teamId query value.
string
required
The unique identifier of the session to write files to.
string
required
Base64-encoded raw application/gzip request content.

Output

object
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not