List Address Maps

List all address maps owned by the account.

application/json

Body

result

required

Any of

allOf {2}

array[object (address-maps) {7}]

allOf {2}

One of

array[object (address-maps) {7}]

object

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

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

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

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"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses