--- title: Prefixes --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Addressing](https://developers.cloudflare.com/api/python/resources/addressing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Prefixes ##### [List Prefixes](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/list) addressing.prefixes.list(PrefixListParams\*\*kwargs) -> SyncSinglePage\[[Prefix]()] GET/accounts/{account\_id}/addressing/prefixes ##### [Prefix Details](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/get) addressing.prefixes.get(strprefix\_id, PrefixGetParams\*\*kwargs) -> [Prefix]() GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Add Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/create) addressing.prefixes.create(PrefixCreateParams\*\*kwargs) -> [Prefix]() POST/accounts/{account\_id}/addressing/prefixes ##### [Update Prefix Description](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/edit) addressing.prefixes.edit(strprefix\_id, PrefixEditParams\*\*kwargs) -> [Prefix]() PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Delete Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/delete) addressing.prefixes.delete(strprefix\_id, PrefixDeleteParams\*\*kwargs) -> [PrefixDeleteResponse]() DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Validate Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/methods/validate) addressing.prefixes.validate(strprefix\_id, PrefixValidateParams\*\*kwargs) -> [Prefix]() POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/validate ##### ModelsExpand Collapse
class Prefix: … id: Optional\[str] Identifier of an IP Prefix. maxLength32 Link to this property account\_id: Optional\[str] Identifier of a Cloudflare account. maxLength32 Link to this property Deprecatedadvertised: Optional\[bool] Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled. Link to this property Deprecatedadvertised\_modified\_at: Optional\[datetime] Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled. formatdate-time Link to this property approved: Optional\[str] Approval state of the prefix (P = pending, V = active). Link to this property asn: Optional\[int] Autonomous System Number (ASN) the prefix will be advertised under. Link to this property cidr: Optional\[str] IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property delegate\_loa\_creation: Optional\[bool] Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner. Link to this property description: Optional\[str] Description of the prefix. maxLength1000 Link to this property irr\_validation\_state: Optional\[str] State of one kind of validation for an IP prefix. Link to this property loa\_document\_id: Optional\[str] Identifier for the uploaded LOA document. maxLength32 Link to this property modified\_at: Optional\[datetime] formatdate-time Link to this property Deprecatedon\_demand\_enabled: Optional\[bool] Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property Deprecatedon\_demand\_locked: Optional\[bool] Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Whether advertisement status of the prefix is locked, meaning it cannot be changed. Link to this property ownership\_validation\_state: Optional\[str] State of one kind of validation for an IP prefix. Link to this property ownership\_validation\_token: Optional\[str] Token provided to demonstrate ownership of the prefix. Link to this property rpki\_validation\_state: Optional\[str] State of one kind of validation for an IP prefix. Link to this property
[Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(model)%20prefix%20%3E%20(schema)>)
class PrefixDeleteResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(model)%20prefix_delete_response%20%3E%20(schema)>) #### PrefixesService Bindings ##### [List Service Bindings](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/list) addressing.prefixes.service\_bindings.list(strprefix\_id, ServiceBindingListParams\*\*kwargs) -> SyncSinglePage\[[ServiceBinding]()] GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Get Service Binding](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/get) addressing.prefixes.service\_bindings.get(strbinding\_id, ServiceBindingGetParams\*\*kwargs) -> [ServiceBinding]() GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### [Create Service Binding](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/create) addressing.prefixes.service\_bindings.create(strprefix\_id, ServiceBindingCreateParams\*\*kwargs) -> [ServiceBinding]() POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Delete Service Binding](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/delete) addressing.prefixes.service\_bindings.delete(strbinding\_id, ServiceBindingDeleteParams\*\*kwargs) -> [ServiceBindingDeleteResponse]() DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### ModelsExpand Collapse
class ServiceBinding: … id: Optional\[str] Identifier of a Service Binding. maxLength32 Link to this property cidr: Optional\[str] IP Prefix in Classless Inter-Domain Routing format. Link to this property
provisioning: Optional\[Provisioning] Status of a Service Binding’s deployment to the Cloudflare network
state: Optional\[Literal\["provisioning", "active", "magic\_transit\_route\_missing"]] When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service. One of the following: "provisioning" Link to this property "active" Link to this property "magic\_transit\_route\_missing" Link to this property
Link to this property
Link to this property service\_id: Optional\[str] Identifier of a Service on the Cloudflare network. Available services and their IDs may be found in the **List Services** endpoint. maxLength32 Link to this property service\_name: Optional\[str] Name of a service running on the Cloudflare network Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.service_bindings%20%3E%20(model)%20service_binding%20%3E%20(schema)>)
class ServiceBindingDeleteResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.service_bindings%20%3E%20(model)%20service_binding_delete_response%20%3E%20(schema)>) #### PrefixesBGP Prefixes ##### [List BGP Prefixes](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/list) addressing.prefixes.bgp\_prefixes.list(strprefix\_id, BGPPrefixListParams\*\*kwargs) -> SyncSinglePage\[[BGPPrefix]()] GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Fetch BGP Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/get) 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](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/create) addressing.prefixes.bgp\_prefixes.create(strprefix\_id, BGPPrefixCreateParams\*\*kwargs) -> [BGPPrefix]() POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Update BGP Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/edit) addressing.prefixes.bgp\_prefixes.edit(strbgp\_prefix\_id, BGPPrefixEditParams\*\*kwargs) -> [BGPPrefix]() PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Delete BGP Prefix](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/delete) addressing.prefixes.bgp\_prefixes.delete(strbgp\_prefix\_id, BGPPrefixDeleteParams\*\*kwargs) -> [BGPPrefixDeleteResponse]() DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### ModelsExpand Collapse
class BGPPrefix: … id: Optional\[str] Identifier of BGP Prefix. maxLength32 Link to this property asn: Optional\[int] Autonomous System Number (ASN) the prefix will be advertised under. Link to this property asn\_prepend\_count: Optional\[int] Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute maximum3 minimum0 Link to this property 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. Link to this property
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 Link to this property modified\_at: Optional\[datetime] Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled. formatdate-time Link to this property
Link to this property cidr: Optional\[str] IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property modified\_at: Optional\[datetime] formatdate-time Link to this property
on\_demand: Optional\[OnDemand] advertised: Optional\[bool] Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled. Link to this property 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 Link to this property on\_demand\_enabled: Optional\[bool] Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property on\_demand\_locked: Optional\[bool] Whether the advertisement status of the prefix is locked, meaning it cannot be changed. Link to this property
Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.bgp_prefixes%20%3E%20(model)%20bgp_prefix%20%3E%20(schema)>)
class BGPPrefixDeleteResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.bgp_prefixes%20%3E%20(model)%20bgp_prefix_delete_response%20%3E%20(schema)>) #### PrefixesAdvertisement Status ##### [Get Advertisement Status](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/get) Deprecated addressing.prefixes.advertisement\_status.get(strprefix\_id, AdvertisementStatusGetParams\*\*kwargs) -> [AdvertisementStatusGetResponse]() GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### [Update Prefix Dynamic Advertisement Status](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/edit) Deprecated addressing.prefixes.advertisement\_status.edit(strprefix\_id, AdvertisementStatusEditParams\*\*kwargs) -> [AdvertisementStatusEditResponse]() PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### ModelsExpand Collapse
class AdvertisementStatusGetResponse: … advertised: Optional\[bool] Advertisement status of the prefix. If true, the BGP route for the prefix is advertised to the Internet. If false, the BGP route is withdrawn. Link to this property 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 Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.advertisement_status%20%3E%20(model)%20advertisement_status_get_response%20%3E%20(schema)>)
class AdvertisementStatusEditResponse: … advertised: Optional\[bool] Advertisement status of the prefix. If true, the BGP route for the prefix is advertised to the Internet. If false, the BGP route is withdrawn. Link to this property 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 Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.advertisement_status%20%3E%20(model)%20advertisement_status_edit_response%20%3E%20(schema)>) #### PrefixesDelegations ##### [List Prefix Delegations](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/delegations/methods/list) addressing.prefixes.delegations.list(strprefix\_id, DelegationListParams\*\*kwargs) -> SyncSinglePage\[[Delegations]()] GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Create Prefix Delegation](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/delegations/methods/create) addressing.prefixes.delegations.create(strprefix\_id, DelegationCreateParams\*\*kwargs) -> [Delegations]() POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Delete Prefix Delegation](https://developers.cloudflare.com/api/python/resources/addressing/subresources/prefixes/subresources/delegations/methods/delete) addressing.prefixes.delegations.delete(strdelegation\_id, DelegationDeleteParams\*\*kwargs) -> [DelegationDeleteResponse]() DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations/{delegation\_id} ##### ModelsExpand Collapse
class Delegations: … id: Optional\[str] Identifier of a Delegation. maxLength32 Link to this property cidr: Optional\[str] IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property delegated\_account\_id: Optional\[str] Account identifier for the account to which prefix is being delegated. maxLength32 Link to this property modified\_at: Optional\[datetime] formatdate-time Link to this property parent\_prefix\_id: Optional\[str] Identifier of an IP Prefix. maxLength32 Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.delegations%20%3E%20(model)%20delegations%20%3E%20(schema)>)
class DelegationDeleteResponse: … id: Optional\[str] Identifier of a Delegation. maxLength32 Link to this property
[Link to this property](<#(resource)%20addressing.prefixes.delegations%20%3E%20(model)%20delegation_delete_response%20%3E%20(schema)>)