---
title: "List BYOIP Prefixes"
method: GET
path: "/v2/byoip_prefixes"
tags: ["DigitalOcean-public.v2-new_BYOIP Prefixes"]
---

# List BYOIP Prefixes

`GET /v2/byoip_prefixes`

To list all BYOIP prefixes, send a GET request to `/v2/byoip_prefixes`.
A successful response will return a list of all BYOIP prefixes associated with the account.

## Query parameters

- `per_page` integer
- `page` integer

## Response `200`

List of BYOIP prefixes as an array of BYOIP prefix JSON objects

- object
  - `byoip_prefixes` ByoipPrefix[]
    - `uuid` string — Unique identifier for the BYOIP prefix
    - `name` string — Name of the BYOIP prefix
    - `prefix` string — The IP prefix in CIDR notation
    - `status` string — Status of the BYOIP prefix
    - `region` string — Region where the BYOIP prefix is located
    - `validations` object[] — List of validation statuses for the BYOIP prefix
      - `name` string — Name of the validation
      - `status` string — Status of the validation
      - `note` string — Additional notes or details about the validation
    - `failure_reason` string — Reason for failure, if applicable
    - `locked` boolean — Whether the BYOIP prefix is locked
    - `advertised` boolean — Whether the BYOIP prefix is being advertised
    - `project_id` string — The ID of the project associated with the BYOIP prefix
  - `links` PageLinks
    - `pages` union
      - ForwardLinks
        - `last` string — URI of the last page of the results.
        - `next` string — URI of the next page of the results.
      - BackwardLinks
        - `first` string — URI of the first page of the results.
        - `prev` string — URI of the previous page of the results.
      - unknown
  - `meta` object, required — Information about the response itself.
    - `total` integer, required — Number of objects returned by the request.

## Other responses

- `401` — Authentication failed due to invalid credentials.
- `429` — The API rate limit has been exceeded.
- `500` — There was a server error.
- `default` — There was an unexpected error.

---

[API](https://skmtc.net/digitalocean/apis/digitalocean-api.md) · [All operations](https://skmtc.net/digitalocean/apis/digitalocean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalocean/digitalocean-api/revisions/cb3bf9b21459/schema)
