Address Maps

List Address Maps

GET/accounts/{account_id}/addressing/address_maps

Address Map Details

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

Create Address Map

POST/accounts/{account_id}/addressing/address_maps

Update Address Map

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

Delete Address Map

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

ModelsExpand Collapse

AddressMap = object { id, can_delete, can_modify_ips, 5 more }

id: optional string

Identifier of an Address Map.

maxLength32

can_delete: optional boolean

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

can_modify_ips: optional 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: optional string

formatdate-time

default_sni: optional string

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 string

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

enabled: optional boolean

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 string

formatdate-time

Kind = "zone" or "account"

The type of the membership.

One of the following:

"zone"

"account"

AddressMapGetResponse = object { id, can_delete, can_modify_ips, 7 more }

id: optional string

Identifier of an Address Map.

maxLength32

can_delete: optional boolean

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

can_modify_ips: optional 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: optional string

formatdate-time

default_sni: optional string

description: optional string

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

enabled: optional boolean

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 { created_at, ip }

The set of IPs on the Address Map.

memberships: optional array of object { can_delete, created_at, identifier, kind }

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 boolean

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

created_at: optional string

formatdate-time

identifier: optional string

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

maxLength32

kind: optional Kind

The type of the membership.

modified_at: optional string

formatdate-time

AddressMapCreateResponse = object { id, can_delete, can_modify_ips, 7 more }

id: optional string

Identifier of an Address Map.

maxLength32

can_delete: optional boolean

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

can_modify_ips: optional 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: optional string

formatdate-time

default_sni: optional string

description: optional string

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

enabled: optional boolean

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 { created_at, ip }

The set of IPs on the Address Map.

memberships: optional array of object { can_delete, created_at, identifier, kind }

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 boolean

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

created_at: optional string

formatdate-time

identifier: optional string

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

maxLength32

kind: optional Kind

The type of the membership.

modified_at: optional string

formatdate-time

AddressMapDeleteResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

Address MapsAccounts

Add an account membership to an Address Map

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

Remove an account membership from an Address Map

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

ModelsExpand Collapse

AccountUpdateResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

AccountDeleteResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

Address MapsIPs

Add an IP to an Address Map

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

Remove an IP from an Address Map

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

ModelsExpand Collapse

IPUpdateResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

IPDeleteResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

Address MapsZones

Add a zone membership to an Address Map

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

Remove a zone membership from an Address Map

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

ModelsExpand Collapse

ZoneUpdateResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

ZoneDeleteResponse = object { errors, messages, success, result_info }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.