Give Feedback

dots.v2.vpc_peerings.get()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.vpc_peerings.get(requestConfiguration?: RequestConfiguration<Vpc_peeringsRequestBuilderGetQueryParameters>): Promise<undefined | Vpc_peeringsGetResponse>

Description

To list all of the VPC peerings on your account, send a GET request to /v2/vpc_peerings.

Parameters

perPage integer optional

Example: 2

Number of items returned per page

Default: 20

Min: 1

Max: 200

page integer optional

Example: 1

Which 'page' of paginated results to return.

Default: 1

Min: 1

region string optional

The slug identifier for the region where the resource is available.

One of: ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sfo3, sgp1, tor1, syd1

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.vpc_peerings.get();

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page query parameter:

let response = await client.v2.vpc_peerings.get();
let pages = response?.links?.pages;

while (pages && "next" in pages && typeof pages.next === "string") {
    const page = Number(new URL(pages.next).searchParams.get("page"));
    response = await client.v2.vpc_peerings.get({
        queryParameters: {
            page,
        },
    });
    pages = response?.links?.pages;
}

Response Example

Show Response Example

{
  "vpc_peerings": [
    {
      "id": "6b5c619c-359c-44ca-87e2-47e98170c01d",
      "name": "example-vpc-peering",
      "vpc_ids": [
        "997615ce-132d-4bae-9270-9ee21b395e5d",
        "e51aed59-3bb1-4a6a-8de0-9d1329e9c997"
      ],
      "created_at": "2024-01-09T20:44:32Z",
      "status": "ACTIVE"
    },
    {
      "id": "c212b274-911c-44cc-a117-23b7da4a2922",
      "name": "another-vpc-peering",
      "vpc_ids": [
        "5a100736-b085-4f69-81fd-feee325784bb",
        "c140286f-e6ce-4131-8b7b-df4590ce8d6a"
      ],
      "created_at": "2024-01-10T13:29:58Z",
      "status": "ACTIVE"
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}

More Information

See /v2/vpc_peerings in the API reference for additional detail on responses, headers, parameters, and more.