# Subdomains ## List sending subdomains `email_sending.subdomains.list(SubdomainListParams**kwargs) -> SyncSinglePage[SubdomainListResponse]` **get** `/zones/{zone_id}/email/sending/subdomains` Lists all sending-enabled subdomains for the zone. ### Parameters - `zone_id: str` Identifier. ### Returns - `class SubdomainListResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) page = client.email_sending.subdomains.list( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.email_sending_enabled) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "email_sending_enabled": true, "name": "sub.example.com", "tag": "aabbccdd11223344aabbccdd11223344", "created": "2014-01-02T02:20:00Z", "email_sending_dkim_selector": "cf-bounce", "email_sending_return_path_domain": "cf-bounce.sub.example.com", "enabled": true, "modified": "2014-01-02T02:20:00Z" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Get a sending subdomain `email_sending.subdomains.get(strsubdomain_id, SubdomainGetParams**kwargs) -> SubdomainGetResponse` **get** `/zones/{zone_id}/email/sending/subdomains/{subdomain_id}` Gets information for a specific sending subdomain. ### Parameters - `zone_id: str` Identifier. - `subdomain_id: str` Sending subdomain identifier. ### Returns - `class SubdomainGetResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) subdomain = client.email_sending.subdomains.get( subdomain_id="aabbccdd11223344aabbccdd11223344", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subdomain.email_sending_enabled) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "email_sending_enabled": true, "name": "sub.example.com", "tag": "aabbccdd11223344aabbccdd11223344", "created": "2014-01-02T02:20:00Z", "email_sending_dkim_selector": "cf-bounce", "email_sending_return_path_domain": "cf-bounce.sub.example.com", "enabled": true, "modified": "2014-01-02T02:20:00Z" } } ``` ## Create a sending subdomain `email_sending.subdomains.create(SubdomainCreateParams**kwargs) -> SubdomainCreateResponse` **post** `/zones/{zone_id}/email/sending/subdomains` Creates a new sending subdomain or re-enables sending on an existing subdomain that had it disabled. If zone-level Email Sending has not been enabled yet, the zone flag is automatically set when the entitlement is present. ### Parameters - `zone_id: str` Identifier. - `name: str` The subdomain name. Must be within the zone. ### Returns - `class SubdomainCreateResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) subdomain = client.email_sending.subdomains.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", name="sub.example.com", ) print(subdomain.email_sending_enabled) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "email_sending_enabled": true, "name": "sub.example.com", "tag": "aabbccdd11223344aabbccdd11223344", "created": "2014-01-02T02:20:00Z", "email_sending_dkim_selector": "cf-bounce", "email_sending_return_path_domain": "cf-bounce.sub.example.com", "enabled": true, "modified": "2014-01-02T02:20:00Z" } } ``` ## Delete a sending subdomain `email_sending.subdomains.delete(strsubdomain_id, SubdomainDeleteParams**kwargs) -> SubdomainDeleteResponse` **delete** `/zones/{zone_id}/email/sending/subdomains/{subdomain_id}` Disables sending on a subdomain and removes its DNS records. If routing is still active on the subdomain, only sending is disabled. ### Parameters - `zone_id: str` Identifier. - `subdomain_id: str` Sending subdomain identifier. ### Returns - `class SubdomainDeleteResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) subdomain = client.email_sending.subdomains.delete( subdomain_id="aabbccdd11223344aabbccdd11223344", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subdomain.errors) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true } ``` ## Domain Types ### Subdomain List Response - `class SubdomainListResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Subdomain Get Response - `class SubdomainGetResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Subdomain Create Response - `class SubdomainCreateResponse: …` - `email_sending_enabled: bool` Whether Email Sending is enabled on this subdomain. - `name: str` The subdomain domain name. - `tag: str` Sending subdomain identifier. - `created: Optional[datetime]` The date and time the destination address has been created. - `email_sending_dkim_selector: Optional[str]` The DKIM selector used for email signing. - `email_sending_return_path_domain: Optional[str]` The return-path domain used for bounce handling. - `enabled: Optional[bool]` Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row. - `modified: Optional[datetime]` The date and time the destination address was last modified. ### Subdomain Delete Response - `class SubdomainDeleteResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` # DNS ## Get sending subdomain DNS records `email_sending.subdomains.dns.get(strsubdomain_id, DNSGetParams**kwargs) -> SyncSinglePage[DNSRecord]` **get** `/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns` Returns the expected DNS records for a sending subdomain. ### Parameters - `zone_id: str` Identifier. - `subdomain_id: str` Sending subdomain identifier. ### Returns - `class DNSRecord: …` List of records needed to enable an Email Routing zone. - `content: Optional[str]` DNS record content. - `name: Optional[str]` DNS record name (or @ for the zone apex). - `priority: Optional[float]` Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred. - `ttl: Optional[Union[float, Literal[1], null]]` Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'. - `float` - `Literal[1]` Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'. - `1` - `type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]` DNS record type. - `"A"` - `"AAAA"` - `"CNAME"` - `"HTTPS"` - `"TXT"` - `"SRV"` - `"LOC"` - `"MX"` - `"NS"` - `"CERT"` - `"DNSKEY"` - `"DS"` - `"NAPTR"` - `"SMIMEA"` - `"SSHFP"` - `"SVCB"` - `"TLSA"` - `"URI"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) page = client.email_sending.subdomains.dns.get( subdomain_id="aabbccdd11223344aabbccdd11223344", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.content) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "content": "route1.mx.cloudflare.net", "name": "example.com", "priority": 12, "ttl": 1, "type": "NS" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```