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.vpcs.create(
    body={
        "name": "env.prod-vpc",
        "description": "VPC for production environment",
        "region": "nyc1",
        ...,
    },
)

Description

To create a VPC, send a POST request to /v2/vpcs specifying the attributes in the table below in the JSON body.

Note: If you do not currently have a VPC network in a specific datacenter region, the first one that you create will be set as the default for that region. The default VPC for a region cannot be changed or deleted.

Parameters

name string required

Example: env.prod-vpc

The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.

description string optional

Example: VPC for production environment

A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters.

Max length: 255

region string required

Example: nyc1

The slug identifier for the region where the VPC will be created.

ip_range string optional

Example: 10.10.10.0/24

The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than /28 nor larger than /16. If no IP range is specified, a /20 network range is generated that won't conflict with other VPC networks in your account.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "name": "env.prod-vpc",
  "description": "VPC for production environment",
  "region": "nyc1",
  "ip_range": "10.10.10.0/24"
}

resp = client.vpcs.create(body=req)

Response Example

{
  "vpc": {
    "name": "env.prod-vpc",
    "description": "VPC for production environment",
    "region": "nyc1",
    "ip_range": "10.10.10.0/24",
    "default": true,
    "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "urn": "do:vpc:5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "created_at": "2020-03-13T19:20:47.442049222Z"
  }
}

More Information

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