Sign in

v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_[Public Preview] VPC NAT Gateways

List All VPC NAT Gateways

To list all VPC NAT gateways in your team, send a GET request to /v2/vpc_nat_gateways. The response body will be a JSON object with a key of vpc_nat_gateways containing an array of VPC NAT gateway objects. These each contain the standard VPC NAT gateway attributes.

get/v2/vpc_nat_gateways

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

state'new' | 'provisioning' | 'active' | 'deleting' | 'error' | 'invalid'

The current state of the VPC NAT gateway.

region'nyc1' | 'nyc2' | 'nyc3' | 'ams2' | 'ams3' | 'sfo1' | 'sfo2' | 'sfo3' | 'sgp1' | 'lon1' | 'fra1' | 'tor1' | 'blr1' | 'syd1' | 'atl1'

The region where the VPC NAT gateway is located.

type'public'

The type of the VPC NAT gateway.

namestring

The name of the VPC NAT gateway.

Response

A JSON object with a key of vpc_nat_gateways.

Example response

{
  "vpc_nat_gateways": [
    {
      "id": "70e1b58d-cdec-4e95-b3ee-2d4d95feff51",
      "name": "my-vpc-nat-gateway",
      "type": "PUBLIC",
      "state": "ACTIVE",
      "region": "tor1",
      "size": 1,
      "vpcs": [
        {
          "vpc_uuid": "0d3db13e-a604-4944-9827-7ec2642d32ac",
          "gateway_ip": "10.118.0.35"
        }
      ],
      "egresses": {
        "public_gateways": [
          {
            "ipv4": "174.138.113.197"
          }
        ]
      },
      "udp_timeout_seconds": 30,
      "icmp_timeout_seconds": 30,
      "tcp_timeout_seconds": 30,
      "created_at": "2020-07-28T18:00:00Z",
      "updated_at": "2020-07-28T18:00:00Z"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "meta": {
    "total": 1
  }
}