byoip_prefix_resources

Creates, updates, deletes, gets or lists a byoip_prefix_resources resource.

Overview

Name	byoip_prefix_resources
Type	Resource
Id	digitalocean.network.byoip_prefix_resources

Fields

The following fields are returned by SELECT queries:

byoip_prefixes_list_resources

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

Name	Datatype	Description
id	integer (int64)	Unique identifier for the allocation
assigned_at	string (date-time)	Time when the allocation was assigned (example: 2025-06-25T12:00:00Z)
byoip	string	The BYOIP prefix UUID (example: f47ac10b-58cc-4372-a567-0e02b2c3d479)
region	string	Region where the allocation is made (example: nyc3)
resource	string	The resource associated with the allocation (example: do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
byoip_prefixes_list_resources	select	byoip_prefix_uuid	per_page, page	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
byoip_prefix_uuid	string (uuid)	The unique identifier for the BYOIP Prefix. (example: f47ac10b-58cc-4372-a567-0e02b2c3d479)
page	integer	Which 'page' of paginated results to return. (example: 1)
per_page	integer	Number of items returned per page (example: 2)

SELECT examples

byoip_prefixes_list_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.

SELECT
id,
assigned_at,
byoip,
region,
resource
FROM digitalocean.network.byoip_prefix_resources
WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}';