Skip to content
Cloudflare API
Start here
API Reference
Addressing
Prefixes

BGP Prefixes

List BGP Prefixes
client.Addressing.Prefixes.BGPPrefixes.List(ctx, prefixID, query) (*SinglePage[BGPPrefix], error)
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Fetch BGP Prefix
client.Addressing.Prefixes.BGPPrefixes.Get(ctx, prefixID, bgpPrefixID, query) (*BGPPrefix, error)
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
Create BGP Prefix
client.Addressing.Prefixes.BGPPrefixes.New(ctx, prefixID, params) (*BGPPrefix, error)
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Update BGP Prefix
client.Addressing.Prefixes.BGPPrefixes.Edit(ctx, prefixID, bgpPrefixID, params) (*BGPPrefix, error)
PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
ModelsExpand Collapse
type BGPPrefix struct{…}
ID stringOptional

Identifier of BGP Prefix.

maxLength32
ASN int64Optional

Autonomous System Number (ASN) the prefix will be advertised under.

ASNPrependCount int64Optional

Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute

maximum3
minimum0
AutoAdvertiseWithdraw boolOptional

Determines if Cloudflare advertises a BYOIP BGP prefix even when there is no matching BGP prefix in the Magic routing table. When true, Cloudflare will automatically withdraw the BGP prefix when there are no matching BGP routes, and will resume advertising when there is at least one matching BGP route.

BGPSignalOpts BGPPrefixBGPSignalOptsOptional
Enabled boolOptional

Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal

ModifiedAt TimeOptional

Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.

formatdate-time
CIDR stringOptional

IP Prefix in Classless Inter-Domain Routing format.

CreatedAt TimeOptional
formatdate-time
ModifiedAt TimeOptional
formatdate-time
OnDemand BGPPrefixOnDemandOptional
Advertised boolOptional

Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled.

AdvertisedModifiedAt TimeOptional

Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled.

formatdate-time
OnDemandEnabled boolOptional

Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

OnDemandLocked boolOptional

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