{"openapi":"3.0.0","info":{"description":"Cloudflare Email Security API — message investigation, security settings, DMARC management and SPF inspection.","version":[]},"servers":[{"description":"Cloudflare Email Security API — message investigation, security settings, DMARC management and SPF inspection.","url":"https://api.apirails.com/cloudflare-email-security"}],"paths":{"/client/v4/accounts/{account_id}/email-security/analytics/monthly_report":{"get":{"tags":["Analytics"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/analytics/monthly_report"},"summary":"Get monthly report","description":"Get monthly report","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate":{"get":{"tags":["Investigate"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"alert_id","in":"query","description":"alert id","required":false,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"delivery_status","in":"query","description":"Delivery status of the message.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["delivered","moved","quarantined","rejected","deferred","bounced","queued","move_failed"]}}},{"name":"detections_only","in":"query","description":"detections only","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"domain","in":"query","description":"domain","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"end","required":false,"schema":{"type":"string","example":""}},{"name":"final_disposition","in":"query","description":"final disposition","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"]}}},{"name":"message_action","in":"query","description":"message action","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["PREVIEW","QUARANTINE_RELEASED","MOVED"]}}},{"name":"message_id","in":"query","description":"message id","required":false,"schema":{"type":"string","example":""}},{"name":"metric","in":"query","description":"metric","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"query","in":"query","description":"query","required":false,"schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"recipient","required":false,"schema":{"type":"string","example":""}},{"name":"sender","in":"query","description":"sender","required":false,"schema":{"type":"string","example":""}},{"name":"smtp_helo_ip","in":"query","description":"smtp helo ip","required":false,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"start","required":false,"schema":{"type":"string","example":""}},{"name":"subject","in":"query","description":"subject","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate"},"summary":"Search email messages","description":"Search email messages","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/bulk":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"action_type","in":"query","description":"action type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["MOVE","RELEASE"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["PENDING","DISCOVERING","PROCESSING","COMPLETED","FAILED","CANCELLED","SKIPPED"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk"},"summary":"List bulk action jobs","description":"List bulk action jobs","security":[{"bearerAuth":[]}]},"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk"},"summary":"Create a bulk action job","description":"Create a bulk action job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"action","required":true,"enum":["MOVE","RELEASE"]},"comment":{"type":"string","description":"comment"},"destination":{"type":"string","description":"destination","enum":["Inbox","JunkEmail","DeletedItems","RecoverableItemsDeletions","RecoverableItemsPurges"]},"expected_disposition":{"type":"string","description":"expected disposition","enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"]},"search_params":{"type":"object","description":"search params","required":true,"properties":{}}}},"example":{"action":"","comment":"","destination":"","expected_disposition":"","search_params":{}}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}"},"summary":"Get bulk action job details","description":"Get bulk action job details","security":[{"bearerAuth":[]}]},"delete":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}"},"summary":"Delete a bulk action job","description":"Delete a bulk action job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel"},"summary":"Cancel a bulk action job","description":"Cancel a bulk action job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}/messages":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["PENDING","DISCOVERING","PROCESSING","COMPLETED","FAILED","CANCELLED","SKIPPED"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/bulk/{job_id}/messages"},"summary":"List messages for a bulk action job","description":"List messages for a bulk action job","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/move":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/move"},"summary":"Move multiple messages","description":"Move multiple messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"destination":{"type":"string","description":"destination","required":true,"enum":["Inbox","JunkEmail","DeletedItems","RecoverableItemsDeletions","RecoverableItemsPurges"]},"expected_disposition":{"type":"string","description":"expected disposition","enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"]},"ids":{"type":"array","description":"List of message IDs to move.","items":{"type":"string"}},"postfix_ids":{"type":"array","description":"Deprecated, use `ids` instead. End of life: November 1, 2026.","items":{"type":"string"}}}},"example":{"destination":"","expected_disposition":"","ids":[],"postfix_ids":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/preview":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/preview"},"summary":"Preview for non-detection messages","description":"Preview for non-detection messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"postfix_id":{"type":"string","description":"The identifier of the message.","required":true}}},"example":{"postfix_id":""}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/release":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/release"},"summary":"Release messages from quarantine","description":"Release messages from quarantine","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}},{"name":"submission","in":"query","description":"submission","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}"},"summary":"Get message details","description":"Get message details","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/action_log":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/action_log"},"summary":"Get action log for a message","description":"Get action log for a message","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/detections":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/detections"},"summary":"Get message detection details","description":"Get message detection details","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/move":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/move"},"summary":"Move a message","description":"Move a message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"destination":{"type":"string","description":"destination","required":true,"enum":["Inbox","JunkEmail","DeletedItems","RecoverableItemsDeletions","RecoverableItemsPurges"]},"expected_disposition":{"type":"string","description":"expected disposition","enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"]}}},"example":{"destination":"","expected_disposition":""}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/preview":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/preview"},"summary":"Get email preview","description":"Get email preview","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/raw":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/raw"},"summary":"Get raw email content","description":"Get raw email content","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify":{"post":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify"},"summary":"Change email classification","description":"Change email classification","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"eml_content":{"type":"string","description":"Base64 encoded content of the EML file."},"escalated_submission_id":{"type":"string","description":"escalated submission id"},"expected_disposition":{"type":"string","description":"expected disposition","required":true,"enum":["NONE","BULK","MALICIOUS","SPAM","SPOOF","SUSPICIOUS"]}}},"example":{"eml_content":"","escalated_submission_id":"","expected_disposition":""}}}}}},"/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/trace":{"get":{"tags":["Settings"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"investigate_id","in":"path","description":"Unique identifier for a message retrieved from investigation.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/investigate/{investigate_id}/trace"},"summary":"Get email trace","description":"Get email trace","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/phishguard/reports":{"get":{"tags":["Phishguard Reports"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"end","required":false,"schema":{"type":"string","example":""}},{"name":"from_date","in":"query","description":"from date","required":false,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"start","required":false,"schema":{"type":"string","example":""}},{"name":"to_date","in":"query","description":"to date","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/phishguard/reports"},"summary":"Get PhishGuard reports","description":"Get PhishGuard reports","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/settings/allow_policies":{"get":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"is_acceptable_sender","in":"query","description":"is acceptable sender","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_exempt_recipient","in":"query","description":"is exempt recipient","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_trusted_sender","in":"query","description":"is trusted sender","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pattern","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"pattern","in":"query","description":"pattern","required":false,"schema":{"type":"string","example":""}},{"name":"pattern_type","in":"query","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["EMAIL","DOMAIN","IP","UNKNOWN"]}}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}},{"name":"verify_sender","in":"query","description":"verify sender","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies"},"summary":"List email allow policies","description":"List email allow policies","security":[{"bearerAuth":[]}]},"post":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies"},"summary":"Create email allow policy","description":"Create email allow policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at","required":true},"id":{"type":"string","description":"Allow policy identifier.","required":true},"is_acceptable_sender":{"type":"boolean","description":"Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.","required":true,"enum":[true,false]},"is_exempt_recipient":{"type":"boolean","description":"Bypasses all detections for messages to this recipient.","required":true,"enum":[true,false]},"is_recipient":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026.","enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"is_sender":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_spoof":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_trusted_sender":{"type":"boolean","description":"Bypasses all detections and link following for messages from this sender.","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026.","required":true},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents.","required":true},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":true,"enum":["EMAIL","DOMAIN","IP","UNKNOWN"]},"verify_sender":{"type":"boolean","description":"Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.","required":true,"enum":[true,false]}}},"example":{"comments":"","created_at":"","id":"","is_acceptable_sender":"","is_exempt_recipient":"","is_recipient":"","is_regex":"","is_sender":"","is_spoof":"","is_trusted_sender":"","last_modified":"","modified_at":"","pattern":"","pattern_type":"","verify_sender":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/allow_policies/batch":{"post":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies/batch"},"summary":"Batch allow policies operations","description":"Batch allow policies operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}":{"get":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Allow policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}"},"summary":"Get an email allow policy","description":"Get an email allow policy","security":[{"bearerAuth":[]}]},"put":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Allow policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}"},"summary":"Replace an email allow policy","description":"Replace an email allow policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at","required":true},"id":{"type":"string","description":"Allow policy identifier.","required":true},"is_acceptable_sender":{"type":"boolean","description":"Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.","required":true,"enum":[true,false]},"is_exempt_recipient":{"type":"boolean","description":"Bypasses all detections for messages to this recipient.","required":true,"enum":[true,false]},"is_recipient":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026.","enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"is_sender":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_spoof":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_trusted_sender":{"type":"boolean","description":"Bypasses all detections and link following for messages from this sender.","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026.","required":true},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents.","required":true},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":true,"enum":["EMAIL","DOMAIN","IP","UNKNOWN"]},"verify_sender":{"type":"boolean","description":"Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.","required":true,"enum":[true,false]}}},"example":{"comments":"","created_at":"","id":"","is_acceptable_sender":"","is_exempt_recipient":"","is_recipient":"","is_regex":"","is_sender":"","is_spoof":"","is_trusted_sender":"","last_modified":"","modified_at":"","pattern":"","pattern_type":"","verify_sender":""}}}}},"patch":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Allow policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}"},"summary":"Update an email allow policy","description":"Update an email allow policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at","required":true},"id":{"type":"string","description":"Allow policy identifier.","required":true},"is_acceptable_sender":{"type":"boolean","description":"Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.","enum":[true,false]},"is_exempt_recipient":{"type":"boolean","description":"Bypasses all detections for messages to this recipient.","enum":[true,false]},"is_recipient":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026.","enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","enum":[true,false]},"is_sender":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_spoof":{"type":"boolean","description":"Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026.","enum":[true,false]},"is_trusted_sender":{"type":"boolean","description":"Bypasses all detections and link following for messages from this sender.","enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026.","required":true},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents."},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","enum":["EMAIL","DOMAIN","IP","UNKNOWN"]},"verify_sender":{"type":"boolean","description":"Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.","enum":[true,false]}}},"example":{"comments":"","created_at":"","id":"","is_acceptable_sender":"","is_exempt_recipient":"","is_recipient":"","is_regex":"","is_sender":"","is_spoof":"","is_trusted_sender":"","last_modified":"","modified_at":"","pattern":"","pattern_type":"","verify_sender":""}}}}},"delete":{"tags":["Allow Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Allow policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}"},"summary":"Delete an email allow policy","description":"Delete an email allow policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/block_senders":{"get":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pattern","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"pattern","in":"query","description":"pattern","required":false,"schema":{"type":"string","example":""}},{"name":"pattern_type","in":"query","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["EMAIL","DOMAIN","IP","UNKNOWN"]}}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders"},"summary":"List blocked email senders","description":"List blocked email senders","security":[{"bearerAuth":[]}]},"post":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders"},"summary":"Create blocked email sender","description":"Create blocked email sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Blocked sender pattern identifier."},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents.","required":true},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":true,"enum":["EMAIL","DOMAIN","IP","UNKNOWN"]}}},"example":{"comments":"","created_at":"","id":"","is_regex":"","last_modified":"","modified_at":"","pattern":"","pattern_type":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/block_senders/batch":{"post":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders/batch"},"summary":"Batch blocked senders operations","description":"Batch blocked senders operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}":{"get":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"Blocked sender pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}"},"summary":"Get a blocked email sender","description":"Get a blocked email sender","security":[{"bearerAuth":[]}]},"put":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"Blocked sender pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}"},"summary":"Replace a blocked email sender","description":"Replace a blocked email sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Blocked sender pattern identifier."},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents.","required":true},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","required":true,"enum":["EMAIL","DOMAIN","IP","UNKNOWN"]}}},"example":{"comments":"","created_at":"","id":"","is_regex":"","last_modified":"","modified_at":"","pattern":"","pattern_type":""}}}}},"patch":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"Blocked sender pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}"},"summary":"Update a blocked email sender","description":"Update a blocked email sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Blocked sender pattern identifier."},"is_regex":{"type":"boolean","description":"is regex","enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"The pattern value to match. The format depends on `pattern_type`: a valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents."},"pattern_type":{"type":"string","description":"Type of pattern matching. - EMAIL: matches a full email address (e.g. `user@example.com`) - DOMAIN: matches a domain name (e.g. `example.com`) - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or `2606:4700:4700::/48`). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries.","enum":["EMAIL","DOMAIN","IP","UNKNOWN"]}}},"example":{"comments":"","created_at":"","id":"","is_regex":"","last_modified":"","modified_at":"","pattern":"","pattern_type":""}}}}},"delete":{"tags":["Block Senders"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"Blocked sender pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}"},"summary":"Delete a blocked email sender","description":"Delete a blocked email sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/content_policies":{"get":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"enabled","in":"query","description":"enabled","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"name","in":"query","description":"name","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["name","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies"},"summary":"List content policies","description":"List content policies","security":[{"bearerAuth":[]}]},"post":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies"},"summary":"Create a content policy","description":"Create a content policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"created_at":{"type":"string","description":"created at"},"enabled":{"type":"boolean","description":"enabled","required":true,"enum":[true,false]},"id":{"type":"string","description":"Content policy identifier."},"modified_at":{"type":"string","description":"modified at"},"name":{"type":"string","description":"name","required":true},"notes":{"type":"string","description":"notes"},"pattern":{"type":"string","description":"pattern","required":true},"targets":{"type":"array","description":"targets","required":true,"enum":["SUBJECT","BODY"],"items":{"type":"string"}}}},"example":{"created_at":"","enabled":"","id":"","modified_at":"","name":"","notes":"","pattern":"","targets":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/content_policies/batch":{"post":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies/batch"},"summary":"Batch content policy operations","description":"Batch content policy operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/content_policies/{policy_id}":{"get":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Content policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies/{policy_id}"},"summary":"Get a content policy","description":"Get a content policy","security":[{"bearerAuth":[]}]},"patch":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Content policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies/{policy_id}"},"summary":"Update a content policy","description":"Update a content policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"created_at":{"type":"string","description":"created at"},"enabled":{"type":"boolean","description":"enabled","enum":[true,false]},"id":{"type":"string","description":"Content policy identifier."},"modified_at":{"type":"string","description":"modified at"},"name":{"type":"string","description":"name"},"notes":{"type":"string","description":"notes"},"pattern":{"type":"string","description":"pattern"},"targets":{"type":"array","description":"targets","enum":["SUBJECT","BODY"],"items":{"type":"string"}}}},"example":{"created_at":"","enabled":"","id":"","modified_at":"","name":"","notes":"","pattern":"","targets":[]}}}}},"delete":{"tags":["Content Policies"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"policy_id","in":"path","description":"Content policy identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/content_policies/{policy_id}"},"summary":"Delete a content policy","description":"Delete a content policy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/domains":{"get":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"active_delivery_mode","in":"query","description":"active delivery mode","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"]}}},{"name":"allowed_delivery_mode","in":"query","description":"allowed delivery mode","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"]}}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"domain","in":"query","description":"domain","required":false,"schema":{"type":"array","example":""}},{"name":"integration_id","in":"query","description":"integration id","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["domain","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["PENDING","ACTIVE","FAILED","TIMEOUT",null]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains"},"summary":"List protected email domains","description":"List protected email domains","security":[{"bearerAuth":[]}]},"post":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains"},"summary":"Add a new email domain","description":"Add a new email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_delivery_modes":{"type":"array","description":"allowed delivery modes","required":true,"enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"],"items":{"type":"string"}},"domain":{"type":"string","description":"domain","required":true},"drop_dispositions":{"type":"array","description":"drop dispositions","required":true,"enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"],"items":{"type":"string"}},"folder":{"type":"string","description":"folder","enum":["AllItems","Inbox",null]},"integration_id":{"type":"string","description":"integration id"},"ip_restrictions":{"type":"array","description":"ip restrictions","required":true,"items":{"type":"string"}},"lookback_hops":{"type":"number","description":"lookback hops"},"regions":{"type":"array","description":"regions","required":true,"enum":["GLOBAL","AU","DE","IN","US"],"items":{"type":"string"}},"require_tls_inbound":{"type":"boolean","description":"require tls inbound","enum":[true,false]},"require_tls_outbound":{"type":"boolean","description":"require tls outbound","enum":[true,false]},"transport":{"type":"string","description":"transport"}}},"example":{"allowed_delivery_modes":[],"domain":"","drop_dispositions":[],"folder":"","integration_id":"","ip_restrictions":[],"lookback_hops":"","regions":[],"require_tls_inbound":"","require_tls_outbound":"","transport":""}}}}},"delete":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains"},"summary":"Unprotect multiple email domains","description":"Unprotect multiple email domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/domains/batch":{"post":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/batch"},"summary":"Batch domain operations","description":"Batch domain operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}":{"get":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"path","description":"Domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}"},"summary":"Get an email domain","description":"Get an email domain","security":[{"bearerAuth":[]}]},"put":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"path","description":"Domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}"},"summary":"Replace an email domain","description":"Replace an email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_delivery_modes":{"type":"array","description":"allowed delivery modes","required":true,"enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"],"items":{"type":"string"}},"drop_dispositions":{"type":"array","description":"drop dispositions","required":true,"enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"],"items":{"type":"string"}},"folder":{"type":"string","description":"folder","enum":["AllItems","Inbox",null]},"integration_id":{"type":"string","description":"integration id"},"ip_restrictions":{"type":"array","description":"ip restrictions","required":true,"items":{"type":"string"}},"lookback_hops":{"type":"number","description":"lookback hops"},"regions":{"type":"array","description":"regions","required":true,"enum":["GLOBAL","AU","DE","IN","US"],"items":{"type":"string"}},"require_tls_inbound":{"type":"boolean","description":"require tls inbound","enum":[true,false]},"require_tls_outbound":{"type":"boolean","description":"require tls outbound","enum":[true,false]},"transport":{"type":"string","description":"transport"}}},"example":{"allowed_delivery_modes":[],"drop_dispositions":[],"folder":"","integration_id":"","ip_restrictions":[],"lookback_hops":"","regions":[],"require_tls_inbound":"","require_tls_outbound":"","transport":""}}}}},"patch":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"path","description":"Domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}"},"summary":"Update an email domain","description":"Update an email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_delivery_modes":{"type":"array","description":"allowed delivery modes","enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"],"items":{"type":"string"}},"drop_dispositions":{"type":"array","description":"drop dispositions","enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"],"items":{"type":"string"}},"folder":{"type":"string","description":"folder","enum":["AllItems","Inbox",null]},"integration_id":{"type":"string","description":"integration id"},"ip_restrictions":{"type":"array","description":"ip restrictions","items":{"type":"string"}},"lookback_hops":{"type":"number","description":"lookback hops"},"regions":{"type":"array","description":"regions","enum":["GLOBAL","AU","DE","IN","US"],"items":{"type":"string"}},"require_tls_inbound":{"type":"boolean","description":"require tls inbound","enum":[true,false]},"require_tls_outbound":{"type":"boolean","description":"require tls outbound","enum":[true,false]},"transport":{"type":"string","description":"transport"}}},"example":{"allowed_delivery_modes":[],"drop_dispositions":[],"folder":"","integration_id":"","ip_restrictions":[],"lookback_hops":"","regions":[],"require_tls_inbound":"","require_tls_outbound":"","transport":""}}}}},"delete":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"path","description":"Domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}"},"summary":"Unprotect an email domain","description":"Unprotect an email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}/verification":{"get":{"tags":["Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"path","description":"Domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/domains/{domain_id}/verification"},"summary":"Get domain verification details","description":"Get domain verification details","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry":{"get":{"tags":["Impersonation Registry"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["name","email","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"provenance","in":"query","description":"provenance","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["A1S_INTERNAL","SNOOPY-CASB_OFFICE_365","SNOOPY-OFFICE_365","SNOOPY-GOOGLE_DIRECTORY"]}}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry"},"summary":"List entries in impersonation registry","description":"List entries in impersonation registry","security":[{"bearerAuth":[]}]},"post":{"tags":["Impersonation Registry"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry"},"summary":"Create impersonation registry entry","description":"Create impersonation registry entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"directory_id":{"type":"number","description":"directory id"},"directory_node_id":{"type":"number","description":"directory node id"},"email":{"type":"string","description":"email","required":true},"external_directory_node_id":{"type":"string","description":"external directory node id"},"id":{"type":"string","description":"Impersonation registry entry identifier."},"is_email_regex":{"type":"boolean","description":"is email regex","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"name":{"type":"string","description":"name","required":true},"provenance":{"type":"string","description":"provenance","enum":["A1S_INTERNAL","SNOOPY-CASB_OFFICE_365","SNOOPY-OFFICE_365","SNOOPY-GOOGLE_DIRECTORY"]}}},"example":{"comments":"","created_at":"","directory_id":"","directory_node_id":"","email":"","external_directory_node_id":"","id":"","is_email_regex":"","last_modified":"","modified_at":"","name":"","provenance":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}":{"get":{"tags":["Impersonation Registry"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"impersonation_registry_id","in":"path","description":"Impersonation registry entry identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}"},"summary":"Get an impersonation registry entry","description":"Get an impersonation registry entry","security":[{"bearerAuth":[]}]},"patch":{"tags":["Impersonation Registry"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"impersonation_registry_id","in":"path","description":"Impersonation registry entry identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}"},"summary":"Update an impersonation registry entry","description":"Update an impersonation registry entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"directory_id":{"type":"number","description":"directory id"},"directory_node_id":{"type":"number","description":"directory node id"},"email":{"type":"string","description":"email"},"external_directory_node_id":{"type":"string","description":"external directory node id"},"id":{"type":"string","description":"Impersonation registry entry identifier."},"is_email_regex":{"type":"boolean","description":"is email regex","enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"name":{"type":"string","description":"name"},"provenance":{"type":"string","description":"provenance","enum":["A1S_INTERNAL","SNOOPY-CASB_OFFICE_365","SNOOPY-OFFICE_365","SNOOPY-GOOGLE_DIRECTORY"]}}},"example":{"comments":"","created_at":"","directory_id":"","directory_node_id":"","email":"","external_directory_node_id":"","id":"","is_email_regex":"","last_modified":"","modified_at":"","name":"","provenance":""}}}}},"delete":{"tags":["Impersonation Registry"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"impersonation_registry_id","in":"path","description":"Impersonation registry entry identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}"},"summary":"Delete an impersonation registry entry","description":"Delete an impersonation registry entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions":{"get":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["domain","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions"},"summary":"List sending domain restrictions","description":"List sending domain restrictions","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions"},"summary":"Create a sending domain restriction","description":"Create a sending domain restriction","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"domain":{"type":"string","description":"Domain that requires TLS enforcement.","required":true},"exclude":{"type":"array","description":"Subdomains to exempt from TLS requirements.","required":true,"items":{"type":"string"}},"id":{"type":"string","description":"Sending domain restriction identifier."},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"}}},"example":{"comments":"","created_at":"","domain":"","exclude":[],"id":"","last_modified":"","modified_at":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/batch":{"post":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/batch"},"summary":"Batch sending domain restrictions operations","description":"Batch sending domain restrictions operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}":{"get":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"sending_domain_restriction_id","in":"path","description":"Sending domain restriction identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}"},"summary":"Get a sending domain restriction","description":"Get a sending domain restriction","security":[{"bearerAuth":[]}]},"patch":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"sending_domain_restriction_id","in":"path","description":"Sending domain restriction identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}"},"summary":"Update a sending domain restriction","description":"Update a sending domain restriction","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"domain":{"type":"string","description":"Domain that requires TLS enforcement."},"exclude":{"type":"array","description":"Subdomains to exempt from TLS requirements.","items":{"type":"string"}},"id":{"type":"string","description":"Sending domain restriction identifier."},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"}}},"example":{"comments":"","created_at":"","domain":"","exclude":[],"id":"","last_modified":"","modified_at":""}}}}},"delete":{"tags":["Sending Domain Restrictions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"sending_domain_restriction_id","in":"path","description":"Sending domain restriction identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}"},"summary":"Delete a sending domain restriction","description":"Delete a sending domain restriction","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/trusted_domains":{"get":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"is_recent","in":"query","description":"is recent","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_similarity","in":"query","description":"is similarity","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pattern","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"pattern","in":"query","description":"pattern","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains"},"summary":"List trusted email domains","description":"List trusted email domains","security":[{"bearerAuth":[]}]},"post":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains"},"summary":"Create trusted email domain","description":"Create trusted email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Trusted domain identifier."},"is_recent":{"type":"boolean","description":"Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.","required":true,"enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"is_similarity":{"type":"boolean","description":"Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"pattern","required":true}}},"example":{"comments":"","created_at":"","id":"","is_recent":"","is_regex":"","is_similarity":"","last_modified":"","modified_at":"","pattern":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/batch":{"post":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/batch"},"summary":"Batch trusted domains operations","description":"Batch trusted domains operations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}":{"get":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"trusted_domain_id","in":"path","description":"Trusted domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}"},"summary":"Get a trusted email domain","description":"Get a trusted email domain","security":[{"bearerAuth":[]}]},"put":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"trusted_domain_id","in":"path","description":"Trusted domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}"},"summary":"Replace a trusted email domain","description":"Replace a trusted email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Trusted domain identifier."},"is_recent":{"type":"boolean","description":"Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.","required":true,"enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","required":true,"enum":[true,false]},"is_similarity":{"type":"boolean","description":"Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.","required":true,"enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"pattern","required":true}}},"example":{"comments":"","created_at":"","id":"","is_recent":"","is_regex":"","is_similarity":"","last_modified":"","modified_at":"","pattern":""}}}}},"patch":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"trusted_domain_id","in":"path","description":"Trusted domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}"},"summary":"Update a trusted email domain","description":"Update a trusted email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"comments"},"created_at":{"type":"string","description":"created at"},"id":{"type":"string","description":"Trusted domain identifier."},"is_recent":{"type":"boolean","description":"Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.","enum":[true,false]},"is_regex":{"type":"boolean","description":"is regex","enum":[true,false]},"is_similarity":{"type":"boolean","description":"Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.","enum":[true,false]},"last_modified":{"type":"string","description":"Deprecated, use `modified_at` instead. End of life: November 1, 2026."},"modified_at":{"type":"string","description":"modified at"},"pattern":{"type":"string","description":"pattern"}}},"example":{"comments":"","created_at":"","id":"","is_recent":"","is_regex":"","is_similarity":"","last_modified":"","modified_at":"","pattern":""}}}}},"delete":{"tags":["Trusted Domains"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"trusted_domain_id","in":"path","description":"Trusted domain identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}"},"summary":"Delete a trusted email domain","description":"Delete a trusted email domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns":{"get":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns"},"summary":"List URL ignore patterns","description":"List URL ignore patterns","security":[{"bearerAuth":[]}]},"post":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns"},"summary":"Create a URL ignore pattern","description":"Create a URL ignore pattern","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"Optional note describing the reason for the ignore pattern."},"pattern":{"type":"string","description":"Regular expression identifying URLs to exempt from rewriting.","required":true}}},"example":{"comments":"","pattern":""}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/batch":{"post":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/batch"},"summary":"Batch URL ignore patterns","description":"Batch URL ignore patterns","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletes":{"type":"array","description":"deletes","required":true,"items":{"type":"object","properties":{}}},"patches":{"type":"array","description":"patches","required":true,"items":{"type":"object","properties":{}}},"posts":{"type":"array","description":"posts","required":true,"items":{"type":"object","properties":{}}},"puts":{"type":"array","description":"puts","required":true,"items":{"type":"object","properties":{}}}}},"example":{"deletes":[],"patches":[],"posts":[],"puts":[]}}}}}},"/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}":{"get":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"URL ignore pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}"},"summary":"Get a URL ignore pattern","description":"Get a URL ignore pattern","security":[{"bearerAuth":[]}]},"patch":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"URL ignore pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}"},"summary":"Update a URL ignore pattern","description":"Update a URL ignore pattern","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"Optional note describing the reason for the ignore pattern."},"pattern":{"type":"string","description":"Regular expression identifying URLs to exempt from rewriting."}}},"example":{"comments":"","pattern":""}}}}},"delete":{"tags":["URL Ignore Patterns"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"URL ignore pattern identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}"},"summary":"Delete a URL ignore pattern","description":"Delete a URL ignore pattern","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email-security/submissions":{"get":{"tags":["Submissions"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["TEAM","USER"]}}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"end","in":"query","description":"end","required":false,"schema":{"type":"string","example":""}},{"name":"escalated_from_user","in":"query","description":"escalated from user","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["submission_id","subject","original_disposition","requested_disposition","outcome_disposition","requested_at"]}}},{"name":"original_disposition","in":"query","description":"original disposition","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"]}}},{"name":"outcome_disposition","in":"query","description":"outcome disposition","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"query","in":"query","description":"query","required":false,"schema":{"type":"string","example":""}},{"name":"requested_disposition","in":"query","description":"requested disposition","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"]}}},{"name":"start","in":"query","description":"start","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":""}},{"name":"submission_id","in":"query","description":"submission id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email-security/submissions"},"summary":"Get reclassify submissions","description":"Get reclassify submissions","security":[{"bearerAuth":[]}]}},"/client/v4/zones/{zone_id}/email/auth/dmarc-reports":{"get":{"tags":["Email Auth"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/auth/dmarc-reports"},"summary":"Get DMARC Report Status","description":"Get DMARC Report Status","security":[{"bearerAuth":[]}]},"patch":{"tags":["Email Auth"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/auth/dmarc-reports"},"summary":"Configure DMARC Reports","description":"Configure DMARC Reports","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"Enable or disable DMARC reports for this zone","enum":[true,false]},"skip_wizard":{"type":"boolean","description":"Skip the DMARC setup wizard","enum":[true,false]}}},"example":{"enabled":"","skip_wizard":""}}}}}},"/client/v4/zones/{zone_id}/email/auth/spf/inspect":{"get":{"tags":["Email Auth"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-security/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/auth/spf/inspect"},"summary":"Inspect SPF Record","description":"Inspect SPF Record","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}