List email allow policies

GET/accounts/{account_id}/email-security/settings/allow_policies

Lists, searches, and sorts an account’s email allow policies.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloud Email Security: WriteCloud Email Security: Read

Path ParametersExpand Collapse

account_id: string

Account Identifier

maxLength32

minLength32

Query ParametersExpand Collapse

direction: optional "asc" or "desc"

The sorting direction.

One of the following:

"asc"

"desc"

is_acceptable_sender: optional boolean

is_exempt_recipient: optional boolean

is_recipient: optional boolean

is_sender: optional boolean

is_spoof: optional boolean

is_trusted_sender: optional boolean

order: optional "pattern" or "created_at"

The field to sort by.

One of the following:

"pattern"

"created_at"

page: optional number

The page number of paginated results.

formatint32

minimum1

pattern: optional string

pattern_type: optional "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

per_page: optional number

The number of results per page.

formatint32

minimum1

search: optional string

Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future.

verify_sender: optional boolean

ReturnsExpand Collapse

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

result: array of { id, created_at, is_acceptable_sender, 11 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_acceptable_sender: boolean

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient: boolean

Messages to this recipient will bypass all detections.

is_regex: boolean

is_trusted_sender: boolean

Messages from this sender will bypass all detections and link following.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: boolean

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

comments: optional string

maxLength1024

Deprecatedis_recipient: optional boolean

Deprecatedis_sender: optional boolean

Deprecatedis_spoof: optional boolean

result_info: { count, page, per_page, total_count }

count: number

Total number of results for the requested service

formatint32

page: number

Current page within paginated list of results

formatint32

per_page: number

Number of results per page of results

formatint32

total_count: number

Total results available without any search parameters

formatint32

success: boolean

List email allow policies

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email-security/settings/allow_policies \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": 2401,
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_acceptable_sender": true,
      "is_exempt_recipient": true,
      "is_regex": true,
      "is_trusted_sender": true,
      "last_modified": "2019-12-27T18:11:19.117Z",
      "pattern": "x",
      "pattern_type": "EMAIL",
      "verify_sender": true,
      "comments": "comments",
      "is_recipient": true,
      "is_sender": true,
      "is_spoof": true
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": 2401,
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_acceptable_sender": true,
      "is_exempt_recipient": true,
      "is_regex": true,
      "is_trusted_sender": true,
      "last_modified": "2019-12-27T18:11:19.117Z",
      "pattern": "x",
      "pattern_type": "EMAIL",
      "verify_sender": true,
      "comments": "comments",
      "is_recipient": true,
      "is_sender": true,
      "is_spoof": true
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  },
  "success": true
}