For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.vpc_nat_gateways.post(body: Vpc_nat_gateway_create, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Vpc_nat_gatewaysPostResponse>

Description

To create a new VPC NAT gateway, send a POST request to /v2/vpc_nat_gateways setting the required attributes.

The response body will contain a JSON object with a key called vpc_nat_gateway containing the standard attributes for the new VPC NAT gateway.

Parameters

name string required

Example: my-vpc-nat-gateway

The human-readable name of the VPC NAT gateway.

type string required

Example: PUBLIC

The type of the VPC NAT gateway.

region string required

The region in which the VPC NAT gateway is created.

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

size integer required

Example: 1

The size of the VPC NAT gateway.

vpcs array of objects required

An array of VPCs associated with the VPC NAT gateway.

Show child properties

vpcUuid string required

Example: 0d3db13e-a604-4944-9827-7ec2642d32ac

The unique identifier of the VPC to which the NAT gateway is attached.

subnetUuid string optional

Example: cbd79771-23eb-49be-b5ea-59cc56222622

The unique identifier of the VPC subnet to which the NAT gateway is attached.

defaultGateway boolean optional

Example: true

The classification of the NAT gateway as the default egress route for the VPC traffic.

udpTimeoutSeconds integer optional

Example: 30

The UDP timeout in seconds for the VPC NAT gateway.

icmpTimeoutSeconds integer optional

Example: 30

The ICMP timeout in seconds for the VPC NAT gateway.

tcpTimeoutSeconds integer optional

Example: 30

The TCP timeout in seconds for the VPC NAT gateway.

egresses object optional

An optional object specifying the public egress IP address to assign to the VPC NAT gateway. Provide this only to use a specific address. If omitted, DigitalOcean allocates a public IP address automatically.

Show child properties

publicGateways array of objects optional

An array containing a single public gateway object that sets the gateway's public egress IP address.

Additional nested properties are not shown.

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_nat_gateways.post({
    name: "test-vpc-nat-gateways",
    type: "PUBLIC",
    region: "tor1",
    size: 1,
    vpcs: [
        {
            vpcUuid: "0eb1752f-807b-4562-a077-8018e13ab1fb",
            subnetUuid: "cbd79771-23eb-49be-b5ea-59cc56222622",
            defaultGateway: true,
        },
    ],
    udpTimeoutSeconds: 30,
    icmpTimeoutSeconds: 30,
    tcpTimeoutSeconds: 30,
});

Response Example

{
  "vpc_nat_gateway": {
    "id": "70e1b58d-cdec-4e95-b3ee-2d4d95feff51",
    "name": "test-vpc-nat-gateways",
    "type": "PUBLIC",
    "state": "ACTIVE",
    "region": "tor1",
    "size": 1,
    "vpcs": [
      {
        "vpc_uuid": "0eb1752f-807b-4562-a077-8018e13ab1fb",
        "subnet_uuid": "cbd79771-23eb-49be-b5ea-59cc56222622",
        "default_gateway": true
      }
    ],
    "egresses": {},
    "udp_timeout_seconds": 30,
    "icmp_timeout_seconds": 30,
    "tcp_timeout_seconds": 30,
    "created_at": "2025-08-12T18:43:14Z",
    "updated_at": "2025-08-12T18:43:14Z"
  }
}

More Information

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