v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_BYOIP Prefixes

List BYOIP Prefix Resources

To list resources associated with BYOIP prefixes, send a GET request to /v2/byoip_prefixes/{byoip_prefix_uuid}/ips.

A successful response will return a list of resources associated with the specified BYOIP prefix.

get/v2/byoip_prefixes/{byoip_prefix_uuid}/ips

Path parameters

byoip_prefix_uuidstring uuid required

The unique identifier for the BYOIP Prefix.

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

Response

List of IP addresses assigned to resources (such as Droplets) in a BYOIP prefix

Example response

{
  "ips": [
    {
      "id": 10001,
      "byoip": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "region": "nyc3",
      "resource": "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479",
      "assigned_at": "2025-06-25T12: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
  }
}