Address Map Details

Show a particular address map owned by the account.

Responses

🟢200Address Map Details response

application/json

Body

result

required

Any of

address-maps

allOf {3}

can_delete

boolean

can_delete

read-onlyoptional

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

Example:

true

can_modify_ips

boolean

can_modify_ips

read-onlyoptional

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

Example:

true

created_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

default_sni

string | null

default_sni

optional

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.

Example:

*.example.com

description

string | null

address-maps_components-schemas-description

optional

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

Example:

My Ecommerce zones

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

modified_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

ips

array[object (address-maps-ip) {2}]

schemas-ips

optional

The set of IPs on the Address Map.

memberships

array[object (address-maps-membership) {4}]

memberships

optional

Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "can_delete": true,
        "can_modify_ips": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "default_sni": "*.example.com",
        "description": "My Ecommerce zones",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "modified_at": "2014-01-01T05:20:00.12345Z",
        "ips": [
            {
                "created_at": "2014-01-01T05:20:00.12345Z",
                "ip": "192.0.2.1"
            }
        ],
        "memberships": [
            {
                "can_delete": true,
                "created_at": "2014-01-01T05:20:00.12345Z",
                "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
                "kind": "zone"
            }
        ]
    },
    "success": true
}

🟢200Address Map Details response failure

Request

Request samples

Responses