API Reference

Addressing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Address Maps

List Address Maps

addressing.address_maps.list(AddressMapListParams**kwargs) -> SyncSinglePage[AddressMap]

GET/accounts/{account_id}/addressing/address_maps

Address Map Details

addressing.address_maps.get(straddress_map_id, AddressMapGetParams**kwargs) -> AddressMapGetResponse

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

Create Address Map

addressing.address_maps.create(AddressMapCreateParams**kwargs) -> AddressMapCreateResponse

POST/accounts/{account_id}/addressing/address_maps

Update Address Map

addressing.address_maps.edit(straddress_map_id, AddressMapEditParams**kwargs) -> AddressMap

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

Delete Address Map

addressing.address_maps.delete(straddress_map_id, AddressMapDeleteParams**kwargs) -> AddressMapDeleteResponse

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

ModelsExpand Collapse

class AddressMap: …

id: Optional[str]

Identifier of an Address Map.

maxLength32

can_delete: Optional[bool]

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

can_modify_ips: Optional[bool]

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: Optional[datetime]

formatdate-time

default_sni: Optional[str]

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: Optional[str]

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

enabled: Optional[bool]

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: Optional[datetime]

formatdate-time

Literal["zone", "account"]

The type of the membership.

One of the following:

"zone"

"account"

class AddressMapGetResponse: …

id: Optional[str]

Identifier of an Address Map.

maxLength32

can_delete: Optional[bool]

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

can_modify_ips: Optional[bool]

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: Optional[datetime]

formatdate-time

default_sni: Optional[str]

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: Optional[str]

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

enabled: Optional[bool]

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: Optional[IPs]

The set of IPs on the Address Map.

memberships: Optional[List[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: Optional[bool]

Controls whether the membership can be deleted via the API or not.

created_at: Optional[datetime]

formatdate-time

identifier: Optional[str]

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

maxLength32

kind: Optional[Kind]

The type of the membership.

modified_at: Optional[datetime]

formatdate-time

class AddressMapCreateResponse: …

id: Optional[str]

Identifier of an Address Map.

maxLength32

can_delete: Optional[bool]

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

can_modify_ips: Optional[bool]

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: Optional[datetime]

formatdate-time

default_sni: Optional[str]

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: Optional[str]

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

enabled: Optional[bool]

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: Optional[IPs]

The set of IPs on the Address Map.

memberships: Optional[List[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: Optional[bool]

Controls whether the membership can be deleted via the API or not.

created_at: Optional[datetime]

formatdate-time

identifier: Optional[str]

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

maxLength32

kind: Optional[Kind]

The type of the membership.

modified_at: Optional[datetime]

formatdate-time

class AddressMapDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

Address MapsAccounts

Add an account membership to an Address Map

addressing.address_maps.accounts.update(straddress_map_id, AccountUpdateParams**kwargs) -> AccountUpdateResponse

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

Remove an account membership from an Address Map

addressing.address_maps.accounts.delete(straddress_map_id, AccountDeleteParams**kwargs) -> AccountDeleteResponse

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

ModelsExpand Collapse

class AccountUpdateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class AccountDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

Address MapsIPs

Add an IP to an Address Map

addressing.address_maps.ips.update(strip_address, IPUpdateParams**kwargs) -> IPUpdateResponse

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

Remove an IP from an Address Map

addressing.address_maps.ips.delete(strip_address, IPDeleteParams**kwargs) -> IPDeleteResponse

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

ModelsExpand Collapse

class IPUpdateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class IPDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

Address MapsZones

Add a zone membership to an Address Map

addressing.address_maps.zones.update(straddress_map_id, ZoneUpdateParams**kwargs) -> ZoneUpdateResponse

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

Remove a zone membership from an Address Map

addressing.address_maps.zones.delete(straddress_map_id, ZoneDeleteParams**kwargs) -> ZoneDeleteResponse

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

ModelsExpand Collapse

class ZoneUpdateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class ZoneDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]

count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.