Skip to main content
GET
/
v1
/
connect
/
networks
listNetworks
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.connect.listNetworks({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
[
  {
    "awsAccountId": "<string>",
    "awsRegion": "<string>",
    "cidr": "<string>",
    "createdAt": 123,
    "id": "<string>",
    "name": "<string>",
    "status": "create_in_progress",
    "teamId": "<string>",
    "awsAvailabilityZoneIds": [
      "<string>"
    ],
    "egressIpAddresses": [
      "<string>"
    ],
    "hostedZones": {
      "count": 123
    },
    "peeringConnections": {
      "count": 123
    },
    "projects": {
      "count": 123,
      "ids": [
        "<string>"
      ]
    },
    "region": "<string>",
    "vpcId": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

includeHostedZones
boolean
default:true

Whether to include Hosted Zones in the response

includePeeringConnections
boolean
default:true

Whether to include VPC Peering connections in the response

includeProjects
boolean
default:true

Whether to include projects in the response

The query to use as a filter for returned networks

Maximum string length: 255
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

awsAccountId
string
required

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

awsRegion
string
required

The AWS Region in which the network exists.

cidr
string
required

The CIDR range of the Network.

createdAt
number
required

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

id
string
required

The unique identifier of the Network.

name
string
required

The name of the network.

status
enum<string>
required

The status of the Network.

Available options:
create_in_progress,
delete_in_progress,
error,
ready
teamId
string
required

The unique identifier of the Team that owns the Network.

awsAvailabilityZoneIds
string[]

The IDs of the AWS Availability Zones in which the network exists, if specified during creation.

egressIpAddresses
string[]
hostedZones
object

Metadata about any AWS Route53 Hosted Zones associated with the Network.

peeringConnections
object

Metadata about any AWS Route53 Hosted Zones associated with the Network.

projects
object

Metadata about any projects associated with the Network.

region
string

The Vercel region in which the Network exists.

vpcId
string

The ID of the VPC which hosts the network.