1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getByoIpPrefix
Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.getByoIpPrefix

cloudflare logo
Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleByoIpPrefix = cloudflare.getByoIpPrefix({
    accountId: "258def64c72dae45f3e4c8516e2111f2",
    prefixId: "2af39739cc4e3b5910c918468bb89828",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_byo_ip_prefix = cloudflare.get_byo_ip_prefix(account_id="258def64c72dae45f3e4c8516e2111f2",
    prefix_id="2af39739cc4e3b5910c918468bb89828")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupByoIpPrefix(ctx, &cloudflare.LookupByoIpPrefixArgs{
			AccountId: "258def64c72dae45f3e4c8516e2111f2",
			PrefixId:  "2af39739cc4e3b5910c918468bb89828",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleByoIpPrefix = Cloudflare.GetByoIpPrefix.Invoke(new()
    {
        AccountId = "258def64c72dae45f3e4c8516e2111f2",
        PrefixId = "2af39739cc4e3b5910c918468bb89828",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetByoIpPrefixArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleByoIpPrefix = CloudflareFunctions.getByoIpPrefix(GetByoIpPrefixArgs.builder()
            .accountId("258def64c72dae45f3e4c8516e2111f2")
            .prefixId("2af39739cc4e3b5910c918468bb89828")
            .build());

    }
}

    variables:
  exampleByoIpPrefix:
    fn::invoke:
      function: cloudflare:getByoIpPrefix
      arguments:
        accountId: 258def64c72dae45f3e4c8516e2111f2
        prefixId: 2af39739cc4e3b5910c918468bb89828

    Using getByoIpPrefix

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getByoIpPrefix(args: GetByoIpPrefixArgs, opts?: InvokeOptions): Promise<GetByoIpPrefixResult>
function getByoIpPrefixOutput(args: GetByoIpPrefixOutputArgs, opts?: InvokeOptions): Output<GetByoIpPrefixResult>
    def get_byo_ip_prefix(account_id: Optional[str] = None,
                      prefix_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetByoIpPrefixResult
def get_byo_ip_prefix_output(account_id: Optional[pulumi.Input[str]] = None,
                      prefix_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetByoIpPrefixResult]
    func LookupByoIpPrefix(ctx *Context, args *LookupByoIpPrefixArgs, opts ...InvokeOption) (*LookupByoIpPrefixResult, error)
func LookupByoIpPrefixOutput(ctx *Context, args *LookupByoIpPrefixOutputArgs, opts ...InvokeOption) LookupByoIpPrefixResultOutput

    > Note: This function is named LookupByoIpPrefix in the Go SDK.

    public static class GetByoIpPrefix 
{
    public static Task<GetByoIpPrefixResult> InvokeAsync(GetByoIpPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetByoIpPrefixResult> Invoke(GetByoIpPrefixInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetByoIpPrefixResult> getByoIpPrefix(GetByoIpPrefixArgs args, InvokeOptions options)
public static Output<GetByoIpPrefixResult> getByoIpPrefix(GetByoIpPrefixArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getByoIpPrefix:getByoIpPrefix
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier of a Cloudflare account.
    PrefixId string
    Identifier of an IP Prefix.
    AccountId string
    Identifier of a Cloudflare account.
    PrefixId string
    Identifier of an IP Prefix.
    accountId String
    Identifier of a Cloudflare account.
    prefixId String
    Identifier of an IP Prefix.
    accountId string
    Identifier of a Cloudflare account.
    prefixId string
    Identifier of an IP Prefix.
    account_id str
    Identifier of a Cloudflare account.
    prefix_id str
    Identifier of an IP Prefix.
    accountId String
    Identifier of a Cloudflare account.
    prefixId String
    Identifier of an IP Prefix.

    getByoIpPrefix Result

    The following output properties are available:

    AccountId string
    Identifier of a Cloudflare account.
    Advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    AdvertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    Approved string
    Approval state of the prefix (P = pending, V = active).
    Asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    Cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    CreatedAt string
    DelegateLoaCreation bool
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    Description string
    Description of the prefix.
    Id string
    Identifier of an IP Prefix.
    IrrValidationState string
    State of one kind of validation for an IP prefix.
    LoaDocumentId string
    Identifier for the uploaded LOA document.
    ModifiedAt string
    OnDemandEnabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    OnDemandLocked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    OwnershipValidationState string
    State of one kind of validation for an IP prefix.
    OwnershipValidationToken string
    Token provided to demonstrate ownership of the prefix.
    PrefixId string
    Identifier of an IP Prefix.
    RpkiValidationState string
    State of one kind of validation for an IP prefix.
    AccountId string
    Identifier of a Cloudflare account.
    Advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    AdvertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    Approved string
    Approval state of the prefix (P = pending, V = active).
    Asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    Cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    CreatedAt string
    DelegateLoaCreation bool
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    Description string
    Description of the prefix.
    Id string
    Identifier of an IP Prefix.
    IrrValidationState string
    State of one kind of validation for an IP prefix.
    LoaDocumentId string
    Identifier for the uploaded LOA document.
    ModifiedAt string
    OnDemandEnabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    OnDemandLocked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    OwnershipValidationState string
    State of one kind of validation for an IP prefix.
    OwnershipValidationToken string
    Token provided to demonstrate ownership of the prefix.
    PrefixId string
    Identifier of an IP Prefix.
    RpkiValidationState string
    State of one kind of validation for an IP prefix.
    accountId String
    Identifier of a Cloudflare account.
    advertised Boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    advertisedModifiedAt String
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    approved String
    Approval state of the prefix (P = pending, V = active).
    asn Integer
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr String
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt String
    delegateLoaCreation Boolean
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    description String
    Description of the prefix.
    id String
    Identifier of an IP Prefix.
    irrValidationState String
    State of one kind of validation for an IP prefix.
    loaDocumentId String
    Identifier for the uploaded LOA document.
    modifiedAt String
    onDemandEnabled Boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    onDemandLocked Boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    ownershipValidationState String
    State of one kind of validation for an IP prefix.
    ownershipValidationToken String
    Token provided to demonstrate ownership of the prefix.
    prefixId String
    Identifier of an IP Prefix.
    rpkiValidationState String
    State of one kind of validation for an IP prefix.
    accountId string
    Identifier of a Cloudflare account.
    advertised boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    advertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    approved string
    Approval state of the prefix (P = pending, V = active).
    asn number
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt string
    delegateLoaCreation boolean
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    description string
    Description of the prefix.
    id string
    Identifier of an IP Prefix.
    irrValidationState string
    State of one kind of validation for an IP prefix.
    loaDocumentId string
    Identifier for the uploaded LOA document.
    modifiedAt string
    onDemandEnabled boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    onDemandLocked boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    ownershipValidationState string
    State of one kind of validation for an IP prefix.
    ownershipValidationToken string
    Token provided to demonstrate ownership of the prefix.
    prefixId string
    Identifier of an IP Prefix.
    rpkiValidationState string
    State of one kind of validation for an IP prefix.
    account_id str
    Identifier of a Cloudflare account.
    advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    advertised_modified_at str
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    approved str
    Approval state of the prefix (P = pending, V = active).
    asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr str
    IP Prefix in Classless Inter-Domain Routing format.
    created_at str
    delegate_loa_creation bool
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    description str
    Description of the prefix.
    id str
    Identifier of an IP Prefix.
    irr_validation_state str
    State of one kind of validation for an IP prefix.
    loa_document_id str
    Identifier for the uploaded LOA document.
    modified_at str
    on_demand_enabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    on_demand_locked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    ownership_validation_state str
    State of one kind of validation for an IP prefix.
    ownership_validation_token str
    Token provided to demonstrate ownership of the prefix.
    prefix_id str
    Identifier of an IP Prefix.
    rpki_validation_state str
    State of one kind of validation for an IP prefix.
    accountId String
    Identifier of a Cloudflare account.
    advertised Boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    advertisedModifiedAt String
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    approved String
    Approval state of the prefix (P = pending, V = active).
    asn Number
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr String
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt String
    delegateLoaCreation Boolean
    Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
    description String
    Description of the prefix.
    id String
    Identifier of an IP Prefix.
    irrValidationState String
    State of one kind of validation for an IP prefix.
    loaDocumentId String
    Identifier for the uploaded LOA document.
    modifiedAt String
    onDemandEnabled Boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    onDemandLocked Boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Deprecated: Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

    ownershipValidationState String
    State of one kind of validation for an IP prefix.
    ownershipValidationToken String
    Token provided to demonstrate ownership of the prefix.
    prefixId String
    Identifier of an IP Prefix.
    rpkiValidationState String
    State of one kind of validation for an IP prefix.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.13.0
    published on Wednesday, Jan 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare
      Try Pulumi Cloud free. Your team will thank you.