networking

List Secure Compute networks

Changed on

Allows to list Secure Compute networks.

get/v1/connect/networks

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/connect/networks
  • Auth: HTTP bearer

Query parameters

includeHostedZonesboolean

Whether to include Hosted Zones in the response

includePeeringConnectionsboolean

Whether to include VPC Peering connections in the response

includeProjectsboolean

Whether to include projects in the response

searchstring

The query to use as a filter for returned networks

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

awsAccountIdstring required

The ID of the AWS Account in which the network exists.

awsAvailabilityZoneIdsstring[]

The IDs of the AWS Availability Zones in which the network exists.

awsRegionstring required

The AWS Region in which the network exists.

cidrstring required

The CIDR range of the Network.

createdAtnumber required

The date at which the Network was created, represented as a UNIX timestamp since EPOCH.

egressIpAddressesstring[]
idstring required

The unique identifier of the Network.

namestring required

The name of the network.

regionstring

The Vercel region in which the Network exists.

status'create_in_progress' | 'delete_in_progress' | 'error' | 'ready' required

The status of the Network.

teamIdstring required

The unique identifier of the Team that owns the Network.

vpcIdstring

The ID of the VPC which hosts the network.

Changes

  • 099fbe1f521cRevision changes
    • info

      added the non-success response with the status

  • e31ea8d3c1e7Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status