Give Feedback

pydo.vpc_subnets.list_members()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.vpc_subnets.list_members(
    vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d",
    subnet_uuid="4de7ac8b-495b-4884-9a69-1050c6793cd6",
    resource_type=None,
    per_page=20,
    page=1,
)

Returns JSONRaises HttpResponseError

Description

To list all resources that are members of a VPC subnet, send a GET request to /v2/vpcs/{vpc_uuid}/subnets/{subnet_uuid}/members.

To list only members of a specific type, include the resource_type query parameter. Only resources that you are authorized to view are returned. For example, viewing Droplets requires the droplet:read scope.

Parameters

vpc_uuid string required

The unique identifier of the VPC to which the subnet belongs.

subnet_uuid string required

The unique identifier of a VPC subnet.

resource_type string optional

Used to filter VPC subnet members by resource type.

One of: droplet, loadbalancer, kubernetes, dbaas, nat_gateway, app, nfs_share

per_page integer optional

Number of items returned per page

Min: 1

Max: 200

Default: 20

page integer optional

Which 'page' of paginated results to return.

Min: 1

Default: 1

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 parameter:

from urllib.parse import urlparse, parse_qs

resp = client.vpc_subnets.list_members(vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d", subnet_uuid="4de7ac8b-495b-4884-9a69-1050c6793cd6", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.vpc_subnets.list_members(vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d", subnet_uuid="4de7ac8b-495b-4884-9a69-1050c6793cd6", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example

{
  "members": [
    {
      "urn": "do:droplet:4126873",
      "name": "ubuntu-s-1vcpu-1gb-nyc3-01",
      "created_at": "2026-01-14T10:00:00Z"
    },
    {
      "urn": "do:loadbalancer:fb294d78-d193-4cb2-8737-ea620993591b",
      "name": "nyc3-load-balancer-01",
      "created_at": "2026-01-14T10:05:00Z"
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}

More Information

See /v2/vpcs/{vpc_uuid}/subnets/{subnet_uuid}/members in the API reference for additional detail on responses, headers, parameters, and more.