v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_BYOIP Prefixes

Update a BYOIP Prefix

To update a BYOIP prefix, send a PATCH request to /v2/byoip_prefixes/$byoip_prefix_uuid.

Currently, you can update the advertisement status of the prefix. The response will include the updated details of the prefix.

patch/v2/byoip_prefixes/{byoip_prefix_uuid}

Path parameters

byoip_prefix_uuidstring uuid required

A unique identifier for a BYOIP prefix.

Request body

advertiseboolean

Whether the BYOIP prefix should be advertised

Example request

{
  "advertise": true
}

Response

Details of the updated BYOIP prefix

Example response

{
  "byoip_prefix": {
    "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "prefix": "203.0.113.0/24",
    "status": "active",
    "region": "nyc3",
    "validations": [
      {
        "name": "SIGNATURE HASH",
        "status": "FAILED"
      }
    ],
    "advertised": true,
    "project_id": "12345678-1234-1234-1234-123456789012"
  }
}