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

List protected email domains

email_security.settings.domains.list(DomainListParams**kwargs) -> SyncV4PagePaginationArray[DomainListResponse]
GET/accounts/{account_id}/email-security/settings/domains

Lists, searches, and sorts an account’s email domains.

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
ParametersExpand Collapse
account_id: str

Account Identifier

maxLength32
minLength32
active_delivery_mode: Optional[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]

Filters response to domains with the currently active delivery mode.

One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
allowed_delivery_mode: Optional[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]

Filters response to domains with the provided delivery mode.

One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
direction: Optional[Literal["asc", "desc"]]

The sorting direction.

One of the following:
"asc"
"desc"
domain: Optional[SequenceNotStr[str]]

Filters results by the provided domains, allowing for multiple occurrences.

integration_id: Optional[str]

Filters response to domains with the provided integration ID.

formatuuid
order: Optional[Literal["domain", "created_at"]]

The field to sort by.

One of the following:
"domain"
"created_at"
page: Optional[int]

The page number of paginated results.

formatint32
minimum1
per_page: Optional[int]

The number of results per page.

formatint32
minimum1
ReturnsExpand Collapse
class DomainListResponse: …
id: int

The unique identifier for the domain.

formatint32
allowed_delivery_modes: List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
created_at: datetime
formatdate-time
domain: str
drop_dispositions: List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
ip_restrictions: List[str]
last_modified: datetime
formatdate-time
lookback_hops: int
formatint32
regions: List[Literal["GLOBAL", "AU", "DE", 2 more]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
transport: str
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
formatint32
minimum0
total_emails_processed_previous: int
formatint32
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]
One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
o365_tenant_id: Optional[str]
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"

List protected email domains

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
)
page = client.email_security.settings.domains.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "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": 2400,
      "allowed_delivery_modes": [
        "API"
      ],
      "created_at": "2023-11-14T22:13:20Z",
      "domain": "example.com",
      "drop_dispositions": [
        "MALICIOUS",
        "SPAM"
      ],
      "ip_restrictions": [
        "string"
      ],
      "last_modified": "2023-11-14T22:13:20Z",
      "lookback_hops": 2,
      "regions": [
        "GLOBAL"
      ],
      "transport": "example.com",
      "authorization": {
        "authorized": true,
        "timestamp": "2019-12-27T18:11:19.117Z",
        "status_message": "status_message"
      },
      "dmarc_status": "good",
      "emails_processed": {
        "timestamp": "2019-12-27T18:11:19.117Z",
        "total_emails_processed": 0,
        "total_emails_processed_previous": 0
      },
      "folder": "Inbox",
      "inbox_provider": "Microsoft",
      "integration_id": "a5dbb180-60ea-4578-84bb-d01a5d4e50c3",
      "o365_tenant_id": "c3c3239d-8858-47df-9618-0e2d9bdf6aa8",
      "require_tls_inbound": false,
      "require_tls_outbound": true,
      "spf_status": "good"
    }
  ],
  "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": 2400,
      "allowed_delivery_modes": [
        "API"
      ],
      "created_at": "2023-11-14T22:13:20Z",
      "domain": "example.com",
      "drop_dispositions": [
        "MALICIOUS",
        "SPAM"
      ],
      "ip_restrictions": [
        "string"
      ],
      "last_modified": "2023-11-14T22:13:20Z",
      "lookback_hops": 2,
      "regions": [
        "GLOBAL"
      ],
      "transport": "example.com",
      "authorization": {
        "authorized": true,
        "timestamp": "2019-12-27T18:11:19.117Z",
        "status_message": "status_message"
      },
      "dmarc_status": "good",
      "emails_processed": {
        "timestamp": "2019-12-27T18:11:19.117Z",
        "total_emails_processed": 0,
        "total_emails_processed_previous": 0
      },
      "folder": "Inbox",
      "inbox_provider": "Microsoft",
      "integration_id": "a5dbb180-60ea-4578-84bb-d01a5d4e50c3",
      "o365_tenant_id": "c3c3239d-8858-47df-9618-0e2d9bdf6aa8",
      "require_tls_inbound": false,
      "require_tls_outbound": true,
      "spf_status": "good"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  },
  "success": true
}