dots.v2.byoip_prefixes.byByoip_prefix_uuid().get()

Generated on 5 Nov 2026 from DoTs version v1.23.0

Usage

client.v2.byoip_prefixes.byByoip_prefix_uuid(byoip_prefix_uuid).get(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | WithByoip_prefix_uuGetResponse>

Description

To get a BYOIP prefix, send a GET request to /v2/byoip_prefixes/{byoip_prefix_uuid}.

A successful response will return the details of the specified BYOIP prefix.

Parameters

byoip_prefix_uuid string required

Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

The unique identifier for the BYOIP Prefix.

Min: 1

Request Sample

Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.byoip_prefixes
    .byByoip_prefix_uuid("f47ac10b-58cc-4372-a567-0e02b2c3d479").get();

Response Example

Show Response Example
{
  "byoip_prefix": {
    "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "status": "active",
    "region": "nyc3",
    "prefix": "203.0.113.0/24",
    "validations": [],
    "failure_reason": "",
    "advertised": true,
    "locked": false,
    "project_id": "12345678-1234-1234-1234-123456789012"
  }
}

More Information

See /v2/byoip_prefixes/{byoip_prefix_uuid} in the API reference for additional detail on responses, headers, parameters, and more.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.