Skip to content
Cloudflare API
Start here
API Reference
Addressing
Prefixes

BGP Prefixes

List BGP Prefixes
client.addressing.prefixes.bgpPrefixes.list(stringprefixId, BGPPrefixListParams { account_id } params, RequestOptionsoptions?): SinglePage<BGPPrefix { id, asn, asn_prepend_count, 6 more } >
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Fetch BGP Prefix
client.addressing.prefixes.bgpPrefixes.get(stringprefixId, stringbgpPrefixId, BGPPrefixGetParams { account_id } params, RequestOptionsoptions?): BGPPrefix { id, asn, asn_prepend_count, 6 more }
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
Create BGP Prefix
client.addressing.prefixes.bgpPrefixes.create(stringprefixId, BGPPrefixCreateParams { account_id, cidr } params, RequestOptionsoptions?): BGPPrefix { id, asn, asn_prepend_count, 6 more }
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Update BGP Prefix
client.addressing.prefixes.bgpPrefixes.edit(stringprefixId, stringbgpPrefixId, BGPPrefixEditParams { account_id, asn_prepend_count, auto_advertise_withdraw, on_demand } params, RequestOptionsoptions?): BGPPrefix { id, asn, asn_prepend_count, 6 more }
PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
ModelsExpand Collapse
BGPPrefix { id, asn, asn_prepend_count, 6 more }
id?: string

Identifier of BGP Prefix.

maxLength32
asn?: number | null

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

asn_prepend_count?: number

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

maximum3
minimum0
auto_advertise_withdraw?: boolean

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?: BGPSignalOpts { enabled, modified_at }
enabled?: boolean

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

modified_at?: string | null

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

formatdate-time
cidr?: string

IP Prefix in Classless Inter-Domain Routing format.

created_at?: string
formatdate-time
modified_at?: string
formatdate-time
on_demand?: OnDemand { advertised, advertised_modified_at, on_demand_enabled, on_demand_locked }
advertised?: boolean | null

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

advertised_modified_at?: string | null

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

formatdate-time
on_demand_enabled?: boolean

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

on_demand_locked?: boolean

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