Create a trusted email domain

POST/accounts/{account_id}/email-security/settings/trusted_domains

Adds a domain to the trusted domains list for email security, reducing false positive detections.

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: Write

Path ParametersExpand Collapse

account_id: optional string

Account Identifier

maxLength32

minLength32

Body ParametersJSONExpand Collapse

body: object { is_recent, is_regex, is_similarity, 2 more } or array of object { is_recent, is_regex, is_similarity, 2 more }

One of the following:

EmailSecurityCreateTrustedDomain object { is_recent, is_regex, is_similarity, 2 more }

is_recent: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: boolean

is_similarity: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

pattern: string

maxLength1024

minLength1

comments: optional string

maxLength1024

array of object { is_recent, is_regex, is_similarity, 2 more }

is_recent: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: boolean

is_similarity: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

pattern: string

maxLength1024

minLength1

comments: optional string

maxLength1024

ReturnsExpand Collapse

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: object { id, created_at, is_recent, 5 more } or array of object { id, created_at, is_recent, 5 more }

One of the following:

EmailSecurityTrustedDomain object { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: boolean

is_similarity: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments: optional string

maxLength1024

array of object { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: boolean

is_similarity: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments: optional string

maxLength1024

success: boolean

Create a trusted email domain

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email-security/settings/trusted_domains \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "is_recent": true,
          "is_regex": false,
          "is_similarity": false,
          "pattern": "example.com"
        }'

{
  "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_recent": true,
    "is_regex": true,
    "is_similarity": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "pattern": "x",
    "comments": "comments"
  },
  "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_recent": true,
    "is_regex": true,
    "is_similarity": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "pattern": "x",
    "comments": "comments"
  },
  "success": true
}