Skip to content
Cloudflare API
Start here
API Reference
Email Security
Settings
Trusted Domains

Create a trusted email domain

email_security.settings.trusted_domains.create(TrustedDomainCreateParams**kwargs) -> TrustedDomainCreateResponse
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
ParametersExpand Collapse
account_id: str

Account Identifier

maxLength32
minLength32
is_recent: bool

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

is_regex: bool
is_similarity: bool

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

pattern: str
maxLength1024
minLength1
comments: Optional[str]
maxLength1024
ReturnsExpand Collapse
One of the following:
class EmailSecurityTrustedDomain: …
id: int

The unique identifier for the trusted domain.

formatint32
created_at: datetime
formatdate-time
is_recent: bool

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

is_regex: bool
is_similarity: bool

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: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
comments: Optional[str]
maxLength1024
List[UnionMember1]
id: int

The unique identifier for the trusted domain.

formatint32
created_at: datetime
formatdate-time
is_recent: bool

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

is_regex: bool
is_similarity: bool

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: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
comments: Optional[str]
maxLength1024

Create a trusted email domain

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
trusted_domain = client.email_security.settings.trusted_domains.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    is_recent=True,
    is_regex=False,
    is_similarity=False,
    pattern="example.com",
)
print(trusted_domain)
{
  "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
}