Update an email domain

PATCH/accounts/{account_id}/email-security/settings/domains/{domain_id}

Updates configuration for a domain in email security.

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

Account Identifier

maxLength32

minLength32

domain_id: number

The unique identifier for the domain.

formatint32

Body ParametersJSONExpand Collapse

ip_restrictions: array of string

allowed_delivery_modes: optional array of "DIRECT" or "BCC" or "JOURNAL" or 2 more

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

domain: optional string

drop_dispositions: optional array of "MALICIOUS" or "MALICIOUS-BEC" or "SUSPICIOUS" or 7 more

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

folder: optional "AllItems" or "Inbox"

One of the following:

"AllItems"

"Inbox"

integration_id: optional string

formatuuid

lookback_hops: optional number

formatint32

maximum20

minimum1

regions: optional array of "GLOBAL" or "AU" or "DE" or 2 more

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

require_tls_inbound: optional boolean

require_tls_outbound: optional boolean

transport: optional string

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: { id, allowed_delivery_modes, created_at, 17 more }

id: number

The unique identifier for the domain.

formatint32

allowed_delivery_modes: array of "DIRECT" or "BCC" or "JOURNAL" or 2 more

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

created_at: string

formatdate-time

domain: string

drop_dispositions: array of "MALICIOUS" or "MALICIOUS-BEC" or "SUSPICIOUS" or 7 more

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

ip_restrictions: array of string

last_modified: string

formatdate-time

lookback_hops: number

formatint32

regions: array of "GLOBAL" or "AU" or "DE" or 2 more

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

transport: string

authorization: optional { authorized, timestamp, status_message }

authorized: boolean

timestamp: string

formatdate-time

status_message: optional string

dmarc_status: optional "none" or "good" or "invalid"

One of the following:

"none"

"good"

"invalid"

emails_processed: optional { timestamp, total_emails_processed, total_emails_processed_previous }

timestamp: string

formatdate-time

total_emails_processed: number

formatint32

minimum0

total_emails_processed_previous: number

formatint32

minimum0

folder: optional "AllItems" or "Inbox"

One of the following:

"AllItems"

"Inbox"

inbox_provider: optional "Microsoft" or "Google"

One of the following:

"Microsoft"

"Google"

integration_id: optional string

formatuuid

o365_tenant_id: optional string

require_tls_inbound: optional boolean

require_tls_outbound: optional boolean

spf_status: optional "none" or "good" or "neutral" or 2 more

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

success: boolean

Update an email domain

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email-security/settings/domains/$DOMAIN_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "ip_restrictions": [
            "192.0.2.0/24",
            "2001:db8::/32"
          ]
        }'

{
  "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"
  },
  "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"
  },
  "success": true
}