Give Feedback

byoip_prefix

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

Synopsis

Create or delete Bring Your Own IP (BYOIP) prefixes. 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.
`description` str		A description for the BYOIP prefix.
`id` str		The unique identifier of the BYOIP prefix. Used for lookup when deleting or updating.
`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.
`prefix` str / required		The IP prefix in CIDR notation (e.g., 192.0.2.0/24).
`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: Create BYOIP prefix
  digitalocean.cloud.byoip_prefix:
    token: "{{ token }}"
    state: present
    prefix: 192.0.2.0/24
    description: My custom IP range

- name: Delete BYOIP prefix
  digitalocean.cloud.byoip_prefix:
    token: "{{ token }}"
    state: absent
    prefix: 192.0.2.0/24

Return Values

Key Returned Description

Key	Returned	Description
`byoip_prefix` dict	always	BYOIP prefix information. 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 prefix result information. Sample: `[ "Created BYOIP prefix 192.0.2.0/24", "Deleted BYOIP prefix 192.0.2.0/24", "BYOIP prefix 192.0.2.0/24 would be created", "BYOIP prefix 192.0.2.0/24 exists", "BYOIP prefix 192.0.2.0/24 does not exist" ]`

byoip_prefix
dict

always

BYOIP prefix information.
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