/vercel-networking | Type: Application | PCID required: Yes
Tools
vercel_networking_add_route
Add a routing rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
position | object | No | — | Controls where the route is inserted. Defaults to “end” if omitted. |
route | object | Yes | — | The route value |
vercel_networking_assign_alias
Assign an Alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the deployment the aliases should be listed for |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
alias | string | No | — | The alias we want to assign to the deployment defined in the URL |
redirect | string | No | — | 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 |
vercel_networking_create_microfrontends_group_with_applications
Create a microfrontends group with applications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
defaultApp | object | Yes | — | The default app for the new microfrontend group |
groupName | string | Yes | — | The name of the microfrontends group that will be used to identify the group |
otherApplications | any[] | Yes | — | The list of other applications that will be used in the new microfrontend group |
vercel_networking_create_network
Create a Secure Compute network Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
awsAvailabilityZoneIds | any[] | No | — | Aws Availability Zone Ids |
cidr | string | Yes | — | The CIDR block of the network |
name | string | Yes | — | The name of the network |
region | string | Yes | — | The region where the network will be created |
vercel_networking_delete_alias
Delete an Alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
aliasId | string | Yes | — | The ID or alias that will be removed |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_delete_network
Delete a Secure Compute network Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
networkId | string | Yes | — | The ID of the network to delete |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_delete_routes
Delete routing rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
routeIds | any[] | Yes | — | The IDs of the routes to delete |
vercel_networking_edit_route
Edit a routing rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
routeId | string | Yes | — | Route Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
restore | boolean | No | — | If true, restores the staged route to the value in the production version. |
route | object | No | — | The full route object to replace the existing route with |
vercel_networking_generate_route
Generate a routing rule from natural language Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
currentRoute | object | No | — | Current Route |
prompt | string | Yes | — | The prompt value |
vercel_networking_get_alias
Get an Alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | number | No | — | Get the alias only if it was created after the provided timestamp |
idOrAlias | string | Yes | — | The alias or alias ID to be retrieved |
projectId | string | No | — | Get the alias only if it is assigned to the provided project ID |
since | number | No | — | Get the alias only if it was created after this JavaScript timestamp |
until | number | No | — | Get the alias only if it was created before this JavaScript timestamp |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_microfrontends_config
Get microfrontends config for a deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The unique deployment identifier |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_microfrontends_config_for_project
Get microfrontends config for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The name or ID of the project |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_microfrontends_groups
List microfrontends groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_microfrontends_in_group
List projects in a microfrontends group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_route_versions
Get routing rule version history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_get_routes
Get project routing rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
versionId | string | No | — | Version Id |
q | string | No | — | The q value |
filter | string | No | — | The filter value |
diff | object | No | — | The diff value |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_list_aliases
List aliases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain | any[] | No | — | Get only aliases of the given domain name |
from | number | No | — | Get only aliases created after the provided timestamp |
limit | number | No | — | Maximum number of aliases to list from a request |
projectId | string | No | — | Filter aliases from the given projectId |
since | number | No | — | Get aliases created after this JavaScript timestamp |
until | number | No | — | Get aliases created before this JavaScript timestamp |
rollbackDeploymentId | string | No | — | Get aliases that would be rolled back for the given deployment |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_list_deployment_aliases
List Deployment Aliases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the deployment the aliases should be listed for |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_list_networks
List Secure Compute networks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeHostedZones | boolean | No | — | Whether to include Hosted Zones in the response |
includePeeringConnections | boolean | No | — | Whether to include VPC Peering connections in the response |
includeProjects | boolean | No | — | Whether to include projects in the response |
search | string | No | — | The query to use as a filter for returned networks |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_patch_url_protection_bypass
Update the protection bypass for a URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The alias or deployment ID |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
body | object | No | — | Request body |
vercel_networking_read_network
Read a Secure Compute network Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
networkId | string | Yes | — | The unique identifier of the Secure Compute network |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_networking_stage_routes
Stage routing rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
overwrite | boolean | No | — | The overwrite value |
routes | any[] | No | — | The routes value |
vercel_networking_update_network
Update a Secure Compute network Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
networkId | string | Yes | — | The unique identifier of the Secure Compute network |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
name | string | Yes | — | The name of the Secure Compute network |
vercel_networking_update_route_versions
Promote, restore, or discard a routing rule version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
action | string | Yes | — | The action value |
id | string | Yes | — | The id value |
vercel_networking_update_static_ips
Configures Static IPs for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
builds | boolean | No | — | Whether to use Static IPs for builds. |
regions | any[] | No | — | The regions value |

