Address Maps

List Address Maps

client.Addressing.AddressMaps.List(ctx, query) (*SinglePage[AddressMap], error)

GET/accounts/{account_id}/addressing/address_maps

Address Map Details

client.Addressing.AddressMaps.Get(ctx, addressMapID, query) (*AddressMapGetResponse, error)

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

Create Address Map

client.Addressing.AddressMaps.New(ctx, params) (*AddressMapNewResponse, error)

POST/accounts/{account_id}/addressing/address_maps

Update Address Map

client.Addressing.AddressMaps.Edit(ctx, addressMapID, params) (*AddressMap, error)

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

Delete Address Map

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

CanDelete booloptional

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

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.

CreatedAt Timeoptional

formatdate-time

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.

Description stringoptional

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

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.

ModifiedAt Timeoptional

formatdate-time

type Kind string

The type of the membership.

One of the following:

const KindZone Kind = "zone"

const KindAccount Kind = "account"

Address MapsAccounts

Add an account membership to an Address Map

client.Addressing.AddressMaps.Accounts.Update(ctx, addressMapID, params) (*AddressMapAccountUpdateResponse, error)

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(ctx, addressMapID, body) (*AddressMapAccountDeleteResponse, error)

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

Address MapsIPs

Add an IP to an Address Map

client.Addressing.AddressMaps.IPs.Update(ctx, addressMapID, ipAddress, params) (*AddressMapIPUpdateResponse, error)

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(ctx, addressMapID, ipAddress, body) (*AddressMapIPDeleteResponse, error)

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

Address MapsZones

Add a zone membership to an Address Map

client.Addressing.AddressMaps.Zones.Update(ctx, addressMapID, params) (*AddressMapZoneUpdateResponse, error)

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(ctx, addressMapID, body) (*AddressMapZoneDeleteResponse, error)

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