API Reference

Addressing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Address Maps

List Address Maps

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

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

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

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

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

can_delete?: boolean

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

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.

created_at?: string

formatdate-time

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.

description?: string | null

An optional description field which may be used to describe the types of IPs or zones on the map.

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.

modified_at?: string

formatdate-time

Kind = "zone" | "account"

The type of the membership.

One of the following:

"zone"

"account"

AddressMapGetResponse { id, can_delete, can_modify_ips, 7 more }

id?: string

Identifier of an Address Map.

maxLength32

can_delete?: boolean

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

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.

created_at?: string

formatdate-time

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.

description?: string | null

An optional description field which may be used to describe the types of IPs or zones on the map.

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.

ips?: IPsArray { created_at, ip }

The set of IPs on the Address Map.

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.

created_at?: string

formatdate-time

identifier?: string

The identifier for the membership (eg. a zone or account tag).

maxLength32

kind?: Kind

The type of the membership.

modified_at?: string

formatdate-time

AddressMapCreateResponse { id, can_delete, can_modify_ips, 7 more }

id?: string

Identifier of an Address Map.

maxLength32

can_delete?: boolean

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

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.

created_at?: string

formatdate-time

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.

description?: string | null

An optional description field which may be used to describe the types of IPs or zones on the map.

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.

ips?: IPsArray { created_at, ip }

The set of IPs on the Address Map.

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.

created_at?: string

formatdate-time

identifier?: string

The identifier for the membership (eg. a zone or account tag).

maxLength32

kind?: Kind

The type of the membership.

modified_at?: string

formatdate-time

AddressMapDeleteResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

Address MapsAccounts

Add an account membership to an Address Map

client.addressing.addressMaps.accounts.update(stringaddressMapId, AccountUpdateParams { account_id, body } params, RequestOptionsoptions?): AccountUpdateResponse { errors, messages, success, result_info }

PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}

Remove an account membership from an Address Map

client.addressing.addressMaps.accounts.delete(stringaddressMapId, AccountDeleteParams { account_id } params, RequestOptionsoptions?): AccountDeleteResponse { errors, messages, success, result_info }

DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}

ModelsExpand Collapse

AccountUpdateResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

AccountDeleteResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

Address MapsIPs

Add an IP to an Address Map

client.addressing.addressMaps.ips.update(stringaddressMapId, stringipAddress, IPUpdateParams { account_id, body } 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

client.addressing.addressMaps.ips.delete(stringaddressMapId, stringipAddress, IPDeleteParams { account_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

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

IPDeleteResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

Address MapsZones

Add a zone membership to an Address Map

client.addressing.addressMaps.zones.update(stringaddressMapId, ZoneUpdateParams { zone_id, account_id, body } params, RequestOptionsoptions?): ZoneUpdateResponse { errors, messages, success, result_info }

PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}

Remove a zone membership from an Address Map

client.addressing.addressMaps.zones.delete(stringaddressMapId, ZoneDeleteParams { zone_id, account_id } params, RequestOptionsoptions?): ZoneDeleteResponse { errors, messages, success, result_info }

DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}

ModelsExpand Collapse

ZoneUpdateResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

ZoneDeleteResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.