Skip to content
Cloudflare API
Start here
API Reference
Addressing
Prefixes

BGP Prefixes

List BGP Prefixes
addressing.prefixes.bgp_prefixes.list(strprefix_id, BGPPrefixListParams**kwargs) -> SyncSinglePage[BGPPrefix]
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Fetch BGP Prefix
addressing.prefixes.bgp_prefixes.get(strbgp_prefix_id, BGPPrefixGetParams**kwargs) -> BGPPrefix
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
Create BGP Prefix
addressing.prefixes.bgp_prefixes.create(strprefix_id, BGPPrefixCreateParams**kwargs) -> BGPPrefix
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Update BGP Prefix
addressing.prefixes.bgp_prefixes.edit(strbgp_prefix_id, BGPPrefixEditParams**kwargs) -> BGPPrefix
PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
ModelsExpand Collapse
class BGPPrefix: …
id: Optional[str]

Identifier of BGP Prefix.

maxLength32
asn: Optional[int]

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

asn_prepend_count: Optional[int]

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

maximum3
minimum0
auto_advertise_withdraw: Optional[bool]

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.

bgp_signal_opts: Optional[BGPSignalOpts]
enabled: Optional[bool]

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

modified_at: Optional[datetime]

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

formatdate-time
cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

created_at: Optional[datetime]
formatdate-time
modified_at: Optional[datetime]
formatdate-time
on_demand: Optional[OnDemand]
advertised: Optional[bool]

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

advertised_modified_at: Optional[datetime]

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

formatdate-time
on_demand_enabled: Optional[bool]

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

on_demand_locked: Optional[bool]

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