--- title: Addressing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Addressing #### AddressingRegional Hostnames ##### [List Regional Hostnames](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/methods/list) GET/zones/{zone\_id}/addressing/regional\_hostnames ##### [Fetch Regional Hostname](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/methods/get) GET/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Create Regional Hostname](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/methods/create) POST/zones/{zone\_id}/addressing/regional\_hostnames ##### [Update Regional Hostname](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/methods/edit) PATCH/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Delete Regional Hostname](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/methods/delete) DELETE/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### ModelsExpand Collapse

RegionalHostnameListResponse object {created\_on, hostname, region\_key, routing }

created\_on: string When the regional hostname was created formatdate-time Link to this property hostname: string DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com Link to this property region\_key: string Identifying key for the region Link to this property routing: string Configure which routing method to use for the regional hostname Link to this property

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)>)

RegionalHostnameGetResponse object {created\_on, hostname, region\_key, routing }

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)>)

RegionalHostnameCreateResponse object {created\_on, hostname, region\_key, routing }

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)>)

RegionalHostnameEditResponse object {created\_on, hostname, region\_key, routing }

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)>)

RegionalHostnameDeleteResponse object {errors, messages, success }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)>) #### AddressingRegional HostnamesRegions ##### [List Regions](https://developers.cloudflare.com/api/resources/addressing/subresources/regional_hostnames/subresources/regions/methods/list) GET/accounts/{account\_id}/addressing/regional\_hostnames/regions ##### ModelsExpand Collapse

RegionListResponse object {key, label }

key: optional string Identifying key for the region Link to this property label: optional string Human-readable text label for the region Link to this property

[Link to this property](<#(resource)%20addressing.regional_hostnames.regions%20%3E%20(model)%20region_list_response%20%3E%20(schema)>) #### AddressingServices ##### [List Services](https://developers.cloudflare.com/api/resources/addressing/subresources/services/methods/list) GET/accounts/{account\_id}/addressing/services ##### ModelsExpand Collapse

ServiceListResponse object {id, name }

id: optional string 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 name: optional string Name of a service running on the Cloudflare network Link to this property

[Link to this property](<#(resource)%20addressing.services%20%3E%20(model)%20service_list_response%20%3E%20(schema)>) #### AddressingAddress Maps ##### [List Address Maps](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/methods/list) GET/accounts/{account\_id}/addressing/address\_maps ##### [Address Map Details](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/methods/get) GET/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Create Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/methods/create) POST/accounts/{account\_id}/addressing/address\_maps ##### [Update Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/methods/edit) PATCH/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Delete Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/methods/delete) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### ModelsExpand Collapse

AddressMap object {id, can\_delete, can\_modify\_ips, 5 more }

id: optional string Identifier of an Address Map. maxLength32 Link to this property can\_delete: optional boolean If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. Link to this property can\_modify\_ips: optional boolean If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps. Link to this property created\_at: optional string formatdate-time Link to this property default\_sni: optional string If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account. Link to this property description: optional string An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled: optional boolean Whether the Address Map is enabled or not. Cloudflare’s DNS will not respond with IP addresses on an Address Map until the map is enabled. Link to this property modified\_at: optional string formatdate-time Link to this property

[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20address_map%20%3E%20(schema)>)

Kind = "zone"or "account" The type of the membership.

One of the following: "zone" Link to this property "account" Link to this property

[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20kind%20%3E%20(schema)>)

AddressMapGetResponse object {id, can\_delete, can\_modify\_ips, 7 more }

id: optional string Identifier of an Address Map. maxLength32 Link to this property can\_delete: optional boolean If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. Link to this property can\_modify\_ips: optional boolean If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps. Link to this property created\_at: optional string formatdate-time Link to this property default\_sni: optional string If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account. Link to this property description: optional string An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled: optional boolean Whether the Address Map is enabled or not. Cloudflare’s DNS will not respond with IP addresses on an Address Map until the map is enabled. Link to this property ips: optional IPs { created\_at, ip } The set of IPs on the Address Map. Link to this property

memberships: optional array of object {can\_delete, created\_at, identifier, kind } Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

can\_delete: optional boolean Controls whether the membership can be deleted via the API or not. Link to this property created\_at: optional string formatdate-time Link to this property identifier: optional string The identifier for the membership (eg. a zone or account tag). maxLength32 Link to this property kind: optional Kind The type of the membership. Link to this property

Link to this property modified\_at: optional string formatdate-time Link to this property

[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20address_map_get_response%20%3E%20(schema)>)

AddressMapCreateResponse object {id, can\_delete, can\_modify\_ips, 7 more }

id: optional string Identifier of an Address Map. maxLength32 Link to this property can\_delete: optional boolean If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. Link to this property can\_modify\_ips: optional boolean If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps. Link to this property created\_at: optional string formatdate-time Link to this property default\_sni: optional string If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account. Link to this property description: optional string An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled: optional boolean Whether the Address Map is enabled or not. Cloudflare’s DNS will not respond with IP addresses on an Address Map until the map is enabled. Link to this property ips: optional IPs { created\_at, ip } The set of IPs on the Address Map. Link to this property

Link to this property modified\_at: optional string formatdate-time Link to this property

[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20address_map_create_response%20%3E%20(schema)>)

AddressMapDeleteResponse object {errors, messages, success, result\_info }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

result\_info: optional object {count, page, per\_page, 2 more }

count: optional number Total number of results for the requested service. Link to this property page: optional number Current page within paginated list of results. Link to this property per\_page: optional number Number of results per page of results. Link to this property total\_count: optional number Total results available without any search parameters. Link to this property total\_pages: optional number The number of total pages in the entire result set. Link to this property

Link to this property

[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20address_map_delete_response%20%3E%20(schema)>) #### AddressingAddress MapsAccounts ##### [Add an account membership to an Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/subresources/accounts/methods/update) PUT/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/accounts/{member\_account\_id} ##### [Remove an account membership from an Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/subresources/accounts/methods/delete) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/accounts/{member\_account\_id} ##### ModelsExpand Collapse

AccountUpdateResponse object {errors, messages, success, result\_info }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

result\_info: optional object {count, page, per\_page, 2 more }

Link to this property

[Link to this property](<#(resource)%20addressing.address_maps.accounts%20%3E%20(model)%20account_update_response%20%3E%20(schema)>)

AccountDeleteResponse object {errors, messages, success, result\_info }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

result\_info: optional object {count, page, per\_page, 2 more }

Link to this property

[Link to this property](<#(resource)%20addressing.address_maps.accounts%20%3E%20(model)%20account_delete_response%20%3E%20(schema)>) #### AddressingAddress MapsIPs ##### [Add an IP to an Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/subresources/ips/methods/update) PUT/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/ips/{ip\_address} ##### [Remove an IP from an Address Map](https://developers.cloudflare.com/api/resources/addressing/subresources/address_maps/subresources/ips/methods/delete) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/ips/{ip\_address} ##### ModelsExpand Collapse

IPUpdateResponse object {errors, messages, success, result\_info }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

result\_info: optional object {count, page, per\_page, 2 more }

Link to this property

[Link to this property](<#(resource)%20addressing.address_maps.ips%20%3E%20(model)%20ip_update_response%20%3E%20(schema)>)

IPDeleteResponse object {errors, messages, success, result\_info }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

result\_info: optional object {count, page, per\_page, 2 more }

Link to this property

[Link to this property](<#(resource)%20addressing.address_maps.ips%20%3E%20(model)%20ip_delete_response%20%3E%20(schema)>) #### AddressingAddress MapsZones #### AddressingLOA Documents ##### [Download LOA Document](https://developers.cloudflare.com/api/resources/addressing/subresources/loa_documents/methods/get) GET/accounts/{account\_id}/addressing/loa\_documents/{loa\_document\_id}/download ##### [Upload LOA Document](https://developers.cloudflare.com/api/resources/addressing/subresources/loa_documents/methods/create) POST/accounts/{account\_id}/addressing/loa\_documents ##### ModelsExpand Collapse

LOADocumentCreateResponse object {id, account\_id, auto\_generated, 5 more }

id: optional string Identifier for the uploaded LOA document. maxLength32 Link to this property account\_id: optional string Identifier of a Cloudflare account. maxLength32 Link to this property auto\_generated: optional boolean Whether the LOA has been auto-generated for the prefix owner by Cloudflare. Link to this property created: optional string formatdate-time Link to this property filename: optional string Name of LOA document. Max file size 10MB, and supported filetype is pdf. Link to this property size\_bytes: optional number File size of the uploaded LOA document. Link to this property verified: optional boolean Whether the LOA has been verified by Cloudflare staff. Link to this property verified\_at: optional string Timestamp of the moment the LOA was marked as validated. formatdate-time Link to this property

[Link to this property](<#(resource)%20addressing.loa_documents%20%3E%20(model)%20loa_document_create_response%20%3E%20(schema)>) #### AddressingPrefixes ##### [List Prefixes](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/list) GET/accounts/{account\_id}/addressing/prefixes ##### [Prefix Details](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/get) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Add Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/create) POST/accounts/{account\_id}/addressing/prefixes ##### [Update Prefix Description](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/edit) PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Delete Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/delete) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Validate Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/methods/validate) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/validate ##### ModelsExpand Collapse

Prefix object {id, account\_id, advertised, 15 more }

id: optional string Identifier of an IP Prefix. maxLength32 Link to this property account\_id: optional string Identifier of a Cloudflare account. maxLength32 Link to this property Deprecatedadvertised: optional boolean 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 string 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 string Approval state of the prefix (P = pending, V = active). Link to this property asn: optional number Autonomous System Number (ASN) the prefix will be advertised under. Link to this property cidr: optional string IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: optional string formatdate-time Link to this property delegate\_loa\_creation: optional boolean Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner. Link to this property description: optional string Description of the prefix. maxLength1000 Link to this property irr\_validation\_state: optional string State of one kind of validation for an IP prefix. Link to this property loa\_document\_id: optional string Identifier for the uploaded LOA document. maxLength32 Link to this property modified\_at: optional string formatdate-time Link to this property Deprecatedon\_demand\_enabled: optional boolean 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 boolean 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 string State of one kind of validation for an IP prefix. Link to this property ownership\_validation\_token: optional string Token provided to demonstrate ownership of the prefix. Link to this property rpki\_validation\_state: optional string 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)>)

PrefixDeleteResponse object {errors, messages, success }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: 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)>) #### AddressingPrefixesService Bindings ##### [List Service Bindings](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/list) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Get Service Binding](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/get) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### [Create Service Binding](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/create) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Delete Service Binding](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/delete) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### ModelsExpand Collapse

ServiceBinding object {id, cidr, provisioning, 2 more }

id: optional string Identifier of a Service Binding. maxLength32 Link to this property cidr: optional string IP Prefix in Classless Inter-Domain Routing format. Link to this property

provisioning: optional object {state } Status of a Service Binding’s deployment to the Cloudflare network

state: optional "provisioning"or "active"or "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 string 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 string 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)>)

ServiceBindingDeleteResponse object {errors, messages, success }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: 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)>) #### AddressingPrefixesBGP Prefixes ##### [List BGP Prefixes](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/list) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Fetch BGP Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/get) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Create BGP Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/create) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Update BGP Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/edit) PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Delete BGP Prefix](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/delete) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### ModelsExpand Collapse

BGPPrefix object {id, asn, asn\_prepend\_count, 6 more }

id: optional string Identifier of BGP Prefix. maxLength32 Link to this property asn: optional number Autonomous System Number (ASN) the prefix will be advertised under. Link to this property asn\_prepend\_count: optional number Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute maximum3 minimum0 Link to this property auto\_advertise\_withdraw: optional 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. Link to this property

bgp\_signal\_opts: optional object {enabled, modified\_at }

enabled: optional boolean 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 string 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 string IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: optional string formatdate-time Link to this property modified\_at: optional string formatdate-time Link to this property

on\_demand: optional object {advertised, advertised\_modified\_at, on\_demand\_enabled, on\_demand\_locked }

advertised: optional boolean 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 string 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 boolean Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property on\_demand\_locked: optional boolean 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)>)

BGPPrefixDeleteResponse object {errors, messages, success }

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

Link to this property success: 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)>) #### AddressingPrefixesAdvertisement Status ##### [Get Advertisement Status](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/get) Deprecated GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### [Update Prefix Dynamic Advertisement Status](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/edit) Deprecated PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### ModelsExpand Collapse

AdvertisementStatusGetResponse object {advertised, advertised\_modified\_at }

advertised: optional boolean 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 string 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)>)

AdvertisementStatusEditResponse object {advertised, advertised\_modified\_at }

[Link to this property](<#(resource)%20addressing.prefixes.advertisement_status%20%3E%20(model)%20advertisement_status_edit_response%20%3E%20(schema)>) #### AddressingPrefixesDelegations ##### [List Prefix Delegations](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/delegations/methods/list) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Create Prefix Delegation](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/delegations/methods/create) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Delete Prefix Delegation](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/delegations/methods/delete) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations/{delegation\_id} ##### ModelsExpand Collapse

Delegations object {id, cidr, created\_at, 3 more }

id: optional string Identifier of a Delegation. maxLength32 Link to this property cidr: optional string IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: optional string formatdate-time Link to this property delegated\_account\_id: optional string Account identifier for the account to which prefix is being delegated. maxLength32 Link to this property modified\_at: optional string formatdate-time Link to this property parent\_prefix\_id: optional string 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)>)

DelegationDeleteResponse object {id }

id: optional string 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)>)