List Secure Compute networks

APIs & SDKs

GEThttps://api.vercel.com/v1/connect/networks

Allows to list Secure Compute networks.

Request

import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

Response

[
  {
    "awsAccountId": "example_id",
    "awsAvailabilityZoneIds": [],
    "awsRegion": "string",
    "cidr": "example_id",
    "createdAt": "123",
    "egressIpAddresses": [],
    "hostedZones": {
      "count": "123"
    },
    "id": "icfg_1234567890",
    "name": "Example Name",
    "peeringConnections": {
      "count": "123"
    },
    "projects": {
      "count": "123",
      "ids": []
    },
    "region": "string",
    "status": "create_in_progress",
    "teamId": "example_id",
    "vpcId": "example_id"
  }
]

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

includeHostedZonesbooleanOptional

Whether to include Hosted Zones in the response

includePeeringConnectionsbooleanOptional

Whether to include VPC Peering connections in the response

includeProjectsbooleanOptional

Whether to include projects in the response

searchstringOptional

The query to use as a filter for returned networks

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Request

import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

Response

[
  {
    "awsAccountId": "example_id",
    "awsAvailabilityZoneIds": [],
    "awsRegion": "string",
    "cidr": "example_id",
    "createdAt": "123",
    "egressIpAddresses": [],
    "hostedZones": {
      "count": "123"
    },
    "id": "icfg_1234567890",
    "name": "Example Name",
    "peeringConnections": {
      "count": "123"
    },
    "projects": {
      "count": "123",
      "ids": []
    },
    "region": "string",
    "status": "create_in_progress",
    "teamId": "example_id",
    "vpcId": "example_id"
  }
]

OpenAPI Specification