Give Feedback

byoip_prefixes_info

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

List all Bring Your Own IP (BYOIP) prefixes on your account. BYOIP allows you to use your own IP address ranges with DigitalOcean infrastructure. You can announce your own IP prefixes and assign them to your Droplets. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/BYOIP-Prefixes.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get BYOIP prefixes
  digitalocean.cloud.byoip_prefixes_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`byoip_prefixes` list	always	BYOIP prefixes. Sample: `[ { "created_at": "2020-03-13T19:20:47.442049222Z", "description": "My custom IP range", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "prefix": "192.0.2.0/24", "status": "active" } ]`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	BYOIP prefixes result information. Sample: `[ "Current BYOIP prefixes", "No BYOIP prefixes" ]`

byoip_prefixes
list

always

BYOIP prefixes.
Sample:

[
  {
    "created_at": "2020-03-13T19:20:47.442049222Z",
    "description": "My custom IP range",
    "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "prefix": "192.0.2.0/24",
    "status": "active"
  }
]

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str