--- title: Addressing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) 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/go/resources/addressing/subresources/regional_hostnames/methods/list) client.Addressing.RegionalHostnames.List(ctx, query) (\*SinglePage\[[RegionalHostnameListResponse]()], error) GET/zones/{zone\_id}/addressing/regional\_hostnames ##### [Fetch Regional Hostname](https://developers.cloudflare.com/api/go/resources/addressing/subresources/regional_hostnames/methods/get) client.Addressing.RegionalHostnames.Get(ctx, hostname, query) (\*[RegionalHostnameGetResponse](), error) GET/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Create Regional Hostname](https://developers.cloudflare.com/api/go/resources/addressing/subresources/regional_hostnames/methods/create) client.Addressing.RegionalHostnames.New(ctx, params) (\*[RegionalHostnameNewResponse](), error) POST/zones/{zone\_id}/addressing/regional\_hostnames ##### [Update Regional Hostname](https://developers.cloudflare.com/api/go/resources/addressing/subresources/regional_hostnames/methods/edit) client.Addressing.RegionalHostnames.Edit(ctx, hostname, params) (\*[RegionalHostnameEditResponse](), error) PATCH/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} ##### [Delete Regional Hostname](https://developers.cloudflare.com/api/go/resources/addressing/subresources/regional_hostnames/methods/delete) client.Addressing.RegionalHostnames.Delete(ctx, hostname, body) (\*[RegionalHostnameDeleteResponse](), error) DELETE/zones/{zone\_id}/addressing/regional\_hostnames/{hostname} #### AddressingRegional HostnamesRegions ##### [List Regions](https://developers.cloudflare.com/api/go/resources/addressing/subresources/regional_hostnames/subresources/regions/methods/list) client.Addressing.RegionalHostnames.Regions.List(ctx, query) (\*SinglePage\[[RegionalHostnameRegionListResponse]()], error) GET/accounts/{account\_id}/addressing/regional\_hostnames/regions #### AddressingServices ##### [List Services](https://developers.cloudflare.com/api/go/resources/addressing/subresources/services/methods/list) client.Addressing.Services.List(ctx, query) (\*SinglePage\[[ServiceListResponse]()], error) GET/accounts/{account\_id}/addressing/services #### AddressingAddress Maps ##### [List Address Maps](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/methods/list) client.Addressing.AddressMaps.List(ctx, query) (\*SinglePage\[[AddressMap]()], error) GET/accounts/{account\_id}/addressing/address\_maps ##### [Address Map Details](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/methods/get) client.Addressing.AddressMaps.Get(ctx, addressMapID, query) (\*[AddressMapGetResponse](), error) GET/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Create Address Map](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/methods/create) client.Addressing.AddressMaps.New(ctx, params) (\*[AddressMapNewResponse](), error) POST/accounts/{account\_id}/addressing/address\_maps ##### [Update Address Map](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/methods/edit) client.Addressing.AddressMaps.Edit(ctx, addressMapID, params) (\*[AddressMap](), error) PATCH/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### [Delete Address Map](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/methods/delete) client.Addressing.AddressMaps.Delete(ctx, addressMapID, body) (\*[AddressMapDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id} ##### ModelsExpand Collapse
type AddressMap struct{…} ID stringOptional Identifier of an Address Map. maxLength32 Link to this property CanDelete boolOptional If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. Link to this property CanModifyIPs boolOptional 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 CreatedAt TimeOptional formatdate-time Link to this property DefaultSNI stringOptional 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 stringOptional An optional description field which may be used to describe the types of IPs or zones on the map. Link to this property Enabled boolOptional 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 ModifiedAt TimeOptional formatdate-time Link to this property
[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20address_map%20%3E%20(schema)>)
type Kind string The type of the membership. One of the following: const KindZone Kind = "zone" Link to this property const KindAccount Kind = "account" Link to this property
[Link to this property](<#(resource)%20addressing.address_maps%20%3E%20(model)%20kind%20%3E%20(schema)>) #### AddressingAddress MapsAccounts ##### [Add an account membership to an Address Map](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/subresources/accounts/methods/update) client.Addressing.AddressMaps.Accounts.Update(ctx, addressMapID, memberAccountID, body) (\*[AddressMapAccountUpdateResponse](), error) 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/go/resources/addressing/subresources/address_maps/subresources/accounts/methods/delete) client.Addressing.AddressMaps.Accounts.Delete(ctx, addressMapID, memberAccountID, body) (\*[AddressMapAccountDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/accounts/{member\_account\_id} #### AddressingAddress MapsIPs ##### [Add an IP to an Address Map](https://developers.cloudflare.com/api/go/resources/addressing/subresources/address_maps/subresources/ips/methods/update) client.Addressing.AddressMaps.IPs.Update(ctx, addressMapID, ipAddress, body) (\*[AddressMapIPUpdateResponse](), error) 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/go/resources/addressing/subresources/address_maps/subresources/ips/methods/delete) client.Addressing.AddressMaps.IPs.Delete(ctx, addressMapID, ipAddress, body) (\*[AddressMapIPDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/address\_maps/{address\_map\_id}/ips/{ip\_address} #### AddressingAddress MapsZones #### AddressingLOA Documents ##### [Download LOA Document](https://developers.cloudflare.com/api/go/resources/addressing/subresources/loa_documents/methods/get) client.Addressing.LOADocuments.Get(ctx, loaDocumentID, query) (\*Response, error) GET/accounts/{account\_id}/addressing/loa\_documents/{loa\_document\_id}/download ##### [Upload LOA Document](https://developers.cloudflare.com/api/go/resources/addressing/subresources/loa_documents/methods/create) client.Addressing.LOADocuments.New(ctx, params) (\*[LOADocumentNewResponse](), error) POST/accounts/{account\_id}/addressing/loa\_documents #### AddressingPrefixes ##### [List Prefixes](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/list) client.Addressing.Prefixes.List(ctx, query) (\*SinglePage\[[Prefix]()], error) GET/accounts/{account\_id}/addressing/prefixes ##### [Prefix Details](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/get) client.Addressing.Prefixes.Get(ctx, prefixID, query) (\*[Prefix](), error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Add Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/create) client.Addressing.Prefixes.New(ctx, params) (\*[Prefix](), error) POST/accounts/{account\_id}/addressing/prefixes ##### [Update Prefix Description](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/edit) client.Addressing.Prefixes.Edit(ctx, prefixID, params) (\*[Prefix](), error) PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Delete Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/delete) client.Addressing.Prefixes.Delete(ctx, prefixID, body) (\*[PrefixDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id} ##### [Validate Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/methods/validate) client.Addressing.Prefixes.Validate(ctx, prefixID, body) (\*[Prefix](), error) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/validate ##### ModelsExpand Collapse
type Prefix struct{…} ID stringOptional Identifier of an IP Prefix. maxLength32 Link to this property AccountID stringOptional Identifier of a Cloudflare account. maxLength32 Link to this property DeprecatedAdvertised boolOptional 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 DeprecatedAdvertisedModifiedAt TimeOptional 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 stringOptional Approval state of the prefix (P = pending, V = active). Link to this property ASN int64Optional Autonomous System Number (ASN) the prefix will be advertised under. Link to this property CIDR stringOptional IP Prefix in Classless Inter-Domain Routing format. Link to this property CreatedAt TimeOptional formatdate-time Link to this property DelegateLOACreation boolOptional Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner. Link to this property Description stringOptional Description of the prefix. maxLength1000 Link to this property IrrValidationState stringOptional State of one kind of validation for an IP prefix. Link to this property LOADocumentID stringOptional Identifier for the uploaded LOA document. maxLength32 Link to this property ModifiedAt TimeOptional formatdate-time Link to this property DeprecatedOnDemandEnabled boolOptional 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 DeprecatedOnDemandLocked boolOptional 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 OwnershipValidationState stringOptional State of one kind of validation for an IP prefix. Link to this property OwnershipValidationToken stringOptional Token provided to demonstrate ownership of the prefix. Link to this property RPKIValidationState stringOptional 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)>) #### AddressingPrefixesService Bindings ##### [List Service Bindings](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/list) client.Addressing.Prefixes.ServiceBindings.List(ctx, prefixID, query) (\*SinglePage\[[ServiceBinding]()], error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Get Service Binding](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/get) client.Addressing.Prefixes.ServiceBindings.Get(ctx, prefixID, bindingID, query) (\*[ServiceBinding](), error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### [Create Service Binding](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/create) client.Addressing.Prefixes.ServiceBindings.New(ctx, prefixID, params) (\*[ServiceBinding](), error) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings ##### [Delete Service Binding](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/service_bindings/methods/delete) client.Addressing.Prefixes.ServiceBindings.Delete(ctx, prefixID, bindingID, body) (\*[PrefixServiceBindingDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bindings/{binding\_id} ##### ModelsExpand Collapse
type ServiceBinding struct{…} ID stringOptional Identifier of a Service Binding. maxLength32 Link to this property CIDR stringOptional IP Prefix in Classless Inter-Domain Routing format. Link to this property
Provisioning ServiceBindingProvisioningOptional Status of a Service Binding’s deployment to the Cloudflare network
State ServiceBindingProvisioningStateOptional 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: const ServiceBindingProvisioningStateProvisioning ServiceBindingProvisioningState = "provisioning" Link to this property const ServiceBindingProvisioningStateActive ServiceBindingProvisioningState = "active" Link to this property const ServiceBindingProvisioningStateMagicTransitRouteMissing ServiceBindingProvisioningState = "magic\_transit\_route\_missing" Link to this property
Link to this property
Link to this property ServiceID stringOptional 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 ServiceName stringOptional 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)>) #### AddressingPrefixesBGP Prefixes ##### [List BGP Prefixes](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/list) client.Addressing.Prefixes.BGPPrefixes.List(ctx, prefixID, query) (\*SinglePage\[[BGPPrefix]()], error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Fetch BGP Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/get) client.Addressing.Prefixes.BGPPrefixes.Get(ctx, prefixID, bgpPrefixID, query) (\*[BGPPrefix](), error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Create BGP Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/create) client.Addressing.Prefixes.BGPPrefixes.New(ctx, prefixID, params) (\*[BGPPrefix](), error) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes ##### [Update BGP Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/edit) client.Addressing.Prefixes.BGPPrefixes.Edit(ctx, prefixID, bgpPrefixID, params) (\*[BGPPrefix](), error) PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### [Delete BGP Prefix](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/methods/delete) client.Addressing.Prefixes.BGPPrefixes.Delete(ctx, prefixID, bgpPrefixID, body) (\*[PrefixBGPPrefixDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/prefixes/{bgp\_prefix\_id} ##### ModelsExpand Collapse
type BGPPrefix struct{…} ID stringOptional Identifier of BGP Prefix. maxLength32 Link to this property ASN int64Optional Autonomous System Number (ASN) the prefix will be advertised under. Link to this property ASNPrependCount int64Optional Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute maximum3 minimum0 Link to this property AutoAdvertiseWithdraw boolOptional 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
BGPSignalOpts BGPPrefixBGPSignalOptsOptional Enabled boolOptional Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal Link to this property ModifiedAt TimeOptional 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 stringOptional IP Prefix in Classless Inter-Domain Routing format. Link to this property CreatedAt TimeOptional formatdate-time Link to this property ModifiedAt TimeOptional formatdate-time Link to this property
OnDemand BGPPrefixOnDemandOptional Advertised boolOptional Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled. Link to this property AdvertisedModifiedAt TimeOptional Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled. formatdate-time Link to this property OnDemandEnabled boolOptional Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property OnDemandLocked boolOptional 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)>) #### AddressingPrefixesAdvertisement Status ##### [Get Advertisement Status](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/get) Deprecated client.Addressing.Prefixes.AdvertisementStatus.Get(ctx, prefixID, query) (\*[PrefixAdvertisementStatusGetResponse](), error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status ##### [Update Prefix Dynamic Advertisement Status](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/advertisement_status/methods/edit) Deprecated client.Addressing.Prefixes.AdvertisementStatus.Edit(ctx, prefixID, params) (\*[PrefixAdvertisementStatusEditResponse](), error) PATCH/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/bgp/status #### AddressingPrefixesDelegations ##### [List Prefix Delegations](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/delegations/methods/list) client.Addressing.Prefixes.Delegations.List(ctx, prefixID, query) (\*SinglePage\[[Delegations]()], error) GET/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Create Prefix Delegation](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/delegations/methods/create) client.Addressing.Prefixes.Delegations.New(ctx, prefixID, params) (\*[Delegations](), error) POST/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations ##### [Delete Prefix Delegation](https://developers.cloudflare.com/api/go/resources/addressing/subresources/prefixes/subresources/delegations/methods/delete) client.Addressing.Prefixes.Delegations.Delete(ctx, prefixID, delegationID, body) (\*[PrefixDelegationDeleteResponse](), error) DELETE/accounts/{account\_id}/addressing/prefixes/{prefix\_id}/delegations/{delegation\_id} ##### ModelsExpand Collapse
type Delegations struct{…} ID stringOptional Identifier of a Delegation. maxLength32 Link to this property CIDR stringOptional IP Prefix in Classless Inter-Domain Routing format. Link to this property CreatedAt TimeOptional formatdate-time Link to this property DelegatedAccountID stringOptional Account identifier for the account to which prefix is being delegated. maxLength32 Link to this property ModifiedAt TimeOptional formatdate-time Link to this property ParentPrefixID stringOptional 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)>)