--- title: Addressing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/addressing/subresources/regional_hostnames/methods/list) client.addressing.regionalHostnames.list(RegionalHostnameListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [RegionalHostnameListResponse]() {created\_on, hostname, region\_key, routing } > GET/zones/{zone\_id}/addressing/regional\_hostnames ##### [Fetch Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/get) client.addressing.regionalHostnames.get(stringhostname, RegionalHostnameGetParams {zone\_id } params, RequestOptionsoptions?): [RegionalHostnameGetResponse]() {created\_on, hostname, region\_key, routing } GET/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Create Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/create) client.addressing.regionalHostnames.create(RegionalHostnameCreateParams {zone\_id, hostname, region\_key, routing } params, RequestOptionsoptions?): [RegionalHostnameCreateResponse]() {created\_on, hostname, region\_key, routing } POST/zones/{zone\_id}/addressing/regional\_hostnames ##### [Update Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/edit) client.addressing.regionalHostnames.edit(stringhostname, RegionalHostnameEditParams {zone\_id, region\_key } params, RequestOptionsoptions?): [RegionalHostnameEditResponse]() {created\_on, hostname, region\_key, routing } PATCH/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Delete Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/delete) client.addressing.regionalHostnames.delete(stringhostname, RegionalHostnameDeleteParams {zone\_id } params, RequestOptionsoptions?): [RegionalHostnameDeleteResponse]() {errors, messages, success } DELETE/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### ModelsExpand Collapse

RegionalHostnameListResponse {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 {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 {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 {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 {errors, messages, success }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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/typescript/resources/addressing/subresources/regional_hostnames/subresources/regions/methods/list) client.addressing.regionalHostnames.regions.list(RegionListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [RegionListResponse]() {key, label } > GET/accounts/{account\_id}/addressing/regional\_hostnames/regions ##### ModelsExpand Collapse

RegionListResponse {key, label }

key?: string Identifying key for the region Link to this property label?: 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/typescript/resources/addressing/subresources/services/methods/list) client.addressing.services.list(ServiceListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [ServiceListResponse]() {id, name } > GET/accounts/{account\_id}/addressing/services ##### ModelsExpand Collapse

ServiceListResponse {id, name }

id?: 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?: 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/typescript/resources/addressing/subresources/address_maps/methods/list) client.addressing.addressMaps.list(AddressMapListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [AddressMap]() {id, can\_delete, can\_modify\_ips, 5 more } > GET/accounts/{account\_id}/addressing/address\_maps ##### [Address Map Details](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/address_maps/methods/get) client.addressing.addressMaps.get(stringaddressMapID, AddressMapGetParams {account\_id } params, RequestOptionsoptions?): [AddressMapGetResponse]() {id, can\_delete, can\_modify\_ips, 7 more } GET/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Create Address Map](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/address_maps/methods/create) client.addressing.addressMaps.create(AddressMapCreateParams {account\_id, description, enabled, 2 more } params, RequestOptionsoptions?): [AddressMapCreateResponse]() {id, can\_delete, can\_modify\_ips, 7 more } POST/accounts/{account\_id}/addressing/address\_maps ##### [Update Address Map](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/address_maps/methods/edit) client.addressing.addressMaps.edit(stringaddressMapID, AddressMapEditParams {account\_id, default\_sni, description, enabled } params, RequestOptionsoptions?): [AddressMap]() {id, can\_delete, can\_modify\_ips, 5 more } PATCH/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Delete Address Map](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/address_maps/methods/delete) client.addressing.addressMaps.delete(stringaddressMapID, AddressMapDeleteParams {account\_id } params, RequestOptionsoptions?): [AddressMapDeleteResponse]() {errors, messages, success, result\_info } DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### ModelsExpand Collapse

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

id?: string Identifier of an Address Map. maxLength32 Link to this property can\_delete?: 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?: 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?: string formatdate-time Link to this property default\_sni?: string| null 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?: string| null An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled?: boolean| null 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?: 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"| "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 {id, can\_delete, can\_modify\_ips, 7 more }

id?: string Identifier of an Address Map. maxLength32 Link to this property can\_delete?: 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?: 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?: string formatdate-time Link to this property default\_sni?: string| null 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?: string| null An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled?: boolean| null 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?: IPsArray {created\_at, ip } The set of IPs on the Address Map. Link to this property

memberships?: Array<Membership> Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

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

Link to this property modified\_at?: 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 {id, can\_delete, can\_modify\_ips, 7 more }

id?: string Identifier of an Address Map. maxLength32 Link to this property can\_delete?: 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?: 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?: string formatdate-time Link to this property default\_sni?: string| null 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?: string| null An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property enabled?: boolean| null 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?: IPsArray {created\_at, ip } The set of IPs on the Address Map. Link to this property

memberships?: Array<Membership> Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

Link to this property modified\_at?: 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 {errors, messages, success, result\_info }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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?: ResultInfo {count, page, per\_page, 2 more }

count?: number Total number of results for the requested service. Link to this property page?: number Current page within paginated list of results. Link to this property per\_page?: number Number of results per page of results. Link to this property total\_count?: number Total results available without any search parameters. Link to this property total\_pages?: 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/typescript/resources/addressing/subresources/address_maps/subresources/accounts/methods/update) client.addressing.addressMaps.accounts.update(stringmemberAccountID, AccountUpdateParams {account\_id, address\_map\_id } params, RequestOptionsoptions?): [AccountUpdateResponse]() {errors, messages, success, result\_info } 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/typescript/resources/addressing/subresources/address_maps/subresources/accounts/methods/delete) client.addressing.addressMaps.accounts.delete(stringmemberAccountID, AccountDeleteParams {account\_id, address\_map\_id } params, RequestOptionsoptions?): [AccountDeleteResponse]() {errors, messages, success, result\_info } DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/accounts/{member\_account\_id} ##### ModelsExpand Collapse

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

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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?: ResultInfo {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 {errors, messages, success, result\_info }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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?: ResultInfo {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/typescript/resources/addressing/subresources/address_maps/subresources/ips/methods/update) client.addressing.addressMaps.ips.update(stringipAddress, IPUpdateParams {account\_id, address\_map\_id } params, RequestOptionsoptions?): [IPUpdateResponse]() {errors, messages, success, result\_info } 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/typescript/resources/addressing/subresources/address_maps/subresources/ips/methods/delete) client.addressing.addressMaps.ips.delete(stringipAddress, IPDeleteParams {account\_id, address\_map\_id } params, RequestOptionsoptions?): [IPDeleteResponse]() {errors, messages, success, result\_info } DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/ips/{ip\_address} ##### ModelsExpand Collapse

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

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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?: ResultInfo {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 {errors, messages, success, result\_info }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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?: ResultInfo {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/typescript/resources/addressing/subresources/loa_documents/methods/get) client.addressing.loaDocuments.get(stringloaDocumentID, LOADocumentGetParams {account\_id } params, RequestOptionsoptions?): Response GET/accounts/{account\_id}/addressing/loa\_documents/{loa\_document\_id}/download ##### [Upload LOA Document](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/loa_documents/methods/create) client.addressing.loaDocuments.create(LOADocumentCreateParams {account\_id, loa\_document } params, RequestOptionsoptions?): [LOADocumentCreateResponse]() {id, account\_id, auto\_generated, 5 more } POST/accounts/{account\_id}/addressing/loa\_documents ##### ModelsExpand Collapse

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

id?: string| null Identifier for the uploaded LOA document. maxLength32 Link to this property account\_id?: string Identifier of a Cloudflare account. maxLength32 Link to this property auto\_generated?: boolean Whether the LOA has been auto-generated for the prefix owner by Cloudflare. Link to this property created?: string formatdate-time Link to this property filename?: string Name of LOA document. Max file size 10MB, and supported filetype is pdf. Link to this property size\_bytes?: number File size of the uploaded LOA document. Link to this property verified?: boolean Whether the LOA has been verified by Cloudflare staff. Link to this property verified\_at?: string| null 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/typescript/resources/addressing/subresources/prefixes/methods/list) client.addressing.prefixes.list(PrefixListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [Prefix]() {id, account\_id, advertised, 15 more } > GET/accounts/{account\_id}/addressing/prefixes ##### [Prefix Details](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/methods/get) client.addressing.prefixes.get(stringprefixID, PrefixGetParams {account\_id } params, RequestOptionsoptions?): [Prefix]() {id, account\_id, advertised, 15 more } GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Add Prefix](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/methods/create) client.addressing.prefixes.create(PrefixCreateParams {account\_id, asn, cidr, 3 more } params, RequestOptionsoptions?): [Prefix]() {id, account\_id, advertised, 15 more } POST/accounts/{account\_id}/addressing/prefixes ##### [Update Prefix Description](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/methods/edit) client.addressing.prefixes.edit(stringprefixID, PrefixEditParams {account\_id, description } params, RequestOptionsoptions?): [Prefix]() {id, account\_id, advertised, 15 more } PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Delete Prefix](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/methods/delete) client.addressing.prefixes.delete(stringprefixID, PrefixDeleteParams {account\_id } params, RequestOptionsoptions?): [PrefixDeleteResponse]() {errors, messages, success } DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Validate Prefix](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/methods/validate) client.addressing.prefixes.validate(stringprefixID, PrefixValidateParams {account\_id } params, RequestOptionsoptions?): [Prefix]() {id, account\_id, advertised, 15 more } POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/validate ##### ModelsExpand Collapse

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

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

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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/typescript/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/list) client.addressing.prefixes.serviceBindings.list(stringprefixID, ServiceBindingListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [ServiceBinding]() {id, cidr, provisioning, 2 more } > GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Get Service Binding](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/get) client.addressing.prefixes.serviceBindings.get(stringbindingID, ServiceBindingGetParams {account\_id, prefix\_id } params, RequestOptionsoptions?): [ServiceBinding]() {id, cidr, provisioning, 2 more } GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### [Create Service Binding](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/create) client.addressing.prefixes.serviceBindings.create(stringprefixID, ServiceBindingCreateParams {account\_id, cidr, service\_id } params, RequestOptionsoptions?): [ServiceBinding]() {id, cidr, provisioning, 2 more } POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Delete Service Binding](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/delete) client.addressing.prefixes.serviceBindings.delete(stringbindingID, ServiceBindingDeleteParams {account\_id, prefix\_id } params, RequestOptionsoptions?): [ServiceBindingDeleteResponse]() {errors, messages, success } DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### ModelsExpand Collapse

ServiceBinding {id, cidr, provisioning, 2 more }

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

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

state?: "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?: 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?: 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 {errors, messages, success }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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/typescript/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/get) client.addressing.prefixes.bgpPrefixes.get(stringbgpPrefixID, BGPPrefixGetParams {account\_id, prefix\_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](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/edit) client.addressing.prefixes.bgpPrefixes.edit(stringbgpPrefixID, BGPPrefixEditParams {account\_id, prefix\_id, asn\_prepend\_count, 2 more } params, RequestOptionsoptions?): [BGPPrefix]() {id, asn, asn\_prepend\_count, 6 more } PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Delete BGP Prefix](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/delete) client.addressing.prefixes.bgpPrefixes.delete(stringbgpPrefixID, BGPPrefixDeleteParams {account\_id, prefix\_id } params, RequestOptionsoptions?): [BGPPrefixDeleteResponse]() {errors, messages, success } DELETE/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 Link to this property asn?: number| null Autonomous System Number (ASN) the prefix will be advertised under. Link to this property asn\_prepend\_count?: number Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute maximum3 minimum0 Link to this property 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. Link to this property

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

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. Link to this property 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 Link to this property on\_demand\_enabled?: boolean Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property on\_demand\_locked?: 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 {errors, messages, success }

errors: Array<Error>

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

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

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

source?: Source {pointer }

pointer?: 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/typescript/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/get) Deprecated client.addressing.prefixes.advertisementStatus.get(stringprefixID, AdvertisementStatusGetParams {account\_id } params, RequestOptionsoptions?): [AdvertisementStatusGetResponse]() {advertised, advertised\_modified\_at } GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### [Update Prefix Dynamic Advertisement Status](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/edit) Deprecated client.addressing.prefixes.advertisementStatus.edit(stringprefixID, AdvertisementStatusEditParams {account\_id, advertised } params, RequestOptionsoptions?): [AdvertisementStatusEditResponse]() {advertised, advertised\_modified\_at } PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### ModelsExpand Collapse

AdvertisementStatusGetResponse {advertised, advertised\_modified\_at }

advertised?: 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?: string| null 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 {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/typescript/resources/addressing/subresources/prefixes/subresources/delegations/methods/list) client.addressing.prefixes.delegations.list(stringprefixID, DelegationListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [Delegations]() {id, cidr, created\_at, 3 more } > GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Create Prefix Delegation](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/delegations/methods/create) client.addressing.prefixes.delegations.create(stringprefixID, DelegationCreateParams {account\_id, cidr, delegated\_account\_id } params, RequestOptionsoptions?): [Delegations]() {id, cidr, created\_at, 3 more } POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Delete Prefix Delegation](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/prefixes/subresources/delegations/methods/delete) client.addressing.prefixes.delegations.delete(stringdelegationID, DelegationDeleteParams {account\_id, prefix\_id } params, RequestOptionsoptions?): [DelegationDeleteResponse]() {id } DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations/{delegation\_id} ##### ModelsExpand Collapse

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

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

id?: 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)>)