--- title: Address Maps --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Addressing](https://developers.cloudflare.com/api/typescript/resources/addressing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Address 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