# DNS ## Email Routing - DNS settings `email_routing.dns.get(DNSGetParams**kwargs) -> DNSGetResponse` **get** `/zones/{zone_id}/email/routing/dns` Show the DNS records needed to configure your Email Routing zone. ### Parameters - `zone_id: str` Identifier. - `subdomain: Optional[str]` Domain of your zone. ### Returns - `DNSGetResponse` - `class EmailEmailRoutingDNSQueryResponse: …` - `errors: List[EmailEmailRoutingDNSQueryResponseError]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailEmailRoutingDNSQueryResponseErrorSource]` - `pointer: Optional[str]` - `messages: List[EmailEmailRoutingDNSQueryResponseMessage]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailEmailRoutingDNSQueryResponseMessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `result: Optional[EmailEmailRoutingDNSQueryResponseResult]` - `errors: Optional[List[EmailEmailRoutingDNSQueryResponseResultError]]` - `code: Optional[str]` - `missing: Optional[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"` - `record: Optional[List[DNSRecord]]` - `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'. - `type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]` DNS record type. - `result_info: Optional[EmailEmailRoutingDNSQueryResponseResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. - `total_pages: Optional[float]` The number of total pages in the entire result set. - `class EmailDNSSettingsResponseCollection: …` - `errors: List[EmailDNSSettingsResponseCollectionError]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailDNSSettingsResponseCollectionErrorSource]` - `pointer: Optional[str]` - `messages: List[EmailDNSSettingsResponseCollectionMessage]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailDNSSettingsResponseCollectionMessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `result: Optional[List[DNSRecord]]` - `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'. - `type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]` DNS record type. - `result_info: Optional[EmailDNSSettingsResponseCollectionResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. - `total_pages: Optional[float]` The number of total pages in the entire result set. ### 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 ) dns = client.email_routing.dns.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(dns) ``` #### 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": { "errors": [ { "code": "code", "missing": { "content": "route1.mx.cloudflare.net", "name": "example.com", "priority": 12, "ttl": 1, "type": "NS" } } ], "record": [ { "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 } } ``` ## Enable Email Routing `email_routing.dns.create(DNSCreateParams**kwargs) -> Settings` **post** `/zones/{zone_id}/email/routing/dns` Enable you Email Routing zone. Add and lock the necessary MX and SPF records. ### Parameters - `zone_id: str` Identifier. - `name: Optional[str]` Domain of your zone. ### Returns - `class Settings: …` - `id: str` Email Routing settings identifier. - `enabled: Literal[true, false]` State of the zone settings for Email Routing. - `true` - `false` - `name: str` Domain of your zone. - `created: Optional[datetime]` The date and time the settings have been created. - `modified: Optional[datetime]` The date and time the settings have been modified. - `skip_wizard: Optional[Literal[true, false]]` Flag to check if the user skipped the configuration wizard. - `true` - `false` - `status: Optional[Literal["ready", "unconfigured", "misconfigured", 2 more]]` Show the state of your account, and the type or configuration error. - `"ready"` - `"unconfigured"` - `"misconfigured"` - `"misconfigured/locked"` - `"unlocked"` - `tag: Optional[str]` Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) ### 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 ) settings = client.email_routing.dns.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(settings.id) ``` #### 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": { "id": "75610dab9e69410a82cf7e400a09ecec", "enabled": true, "name": "example.net", "created": "2014-01-02T02:20:00Z", "modified": "2014-01-02T02:20:00Z", "skip_wizard": true, "status": "ready", "tag": "75610dab9e69410a82cf7e400a09ecec" } } ``` ## Unlock Email Routing `email_routing.dns.edit(DNSEditParams**kwargs) -> Settings` **patch** `/zones/{zone_id}/email/routing/dns` Unlock MX Records previously locked by Email Routing. ### Parameters - `zone_id: str` Identifier. - `name: Optional[str]` Domain of your zone. ### Returns - `class Settings: …` - `id: str` Email Routing settings identifier. - `enabled: Literal[true, false]` State of the zone settings for Email Routing. - `true` - `false` - `name: str` Domain of your zone. - `created: Optional[datetime]` The date and time the settings have been created. - `modified: Optional[datetime]` The date and time the settings have been modified. - `skip_wizard: Optional[Literal[true, false]]` Flag to check if the user skipped the configuration wizard. - `true` - `false` - `status: Optional[Literal["ready", "unconfigured", "misconfigured", 2 more]]` Show the state of your account, and the type or configuration error. - `"ready"` - `"unconfigured"` - `"misconfigured"` - `"misconfigured/locked"` - `"unlocked"` - `tag: Optional[str]` Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) ### 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 ) settings = client.email_routing.dns.edit( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(settings.id) ``` #### 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": { "id": "75610dab9e69410a82cf7e400a09ecec", "enabled": true, "name": "example.net", "created": "2014-01-02T02:20:00Z", "modified": "2014-01-02T02:20:00Z", "skip_wizard": true, "status": "ready", "tag": "75610dab9e69410a82cf7e400a09ecec" } } ``` ## Disable Email Routing `email_routing.dns.delete(DNSDeleteParams**kwargs) -> SyncSinglePage[DNSRecord]` **delete** `/zones/{zone_id}/email/routing/dns` Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work. ### Parameters - `zone_id: str` 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_routing.dns.delete( 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 } ``` ## Domain Types ### DNS Record - `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"` ### DNS Get Response - `DNSGetResponse` - `class EmailEmailRoutingDNSQueryResponse: …` - `errors: List[EmailEmailRoutingDNSQueryResponseError]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailEmailRoutingDNSQueryResponseErrorSource]` - `pointer: Optional[str]` - `messages: List[EmailEmailRoutingDNSQueryResponseMessage]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailEmailRoutingDNSQueryResponseMessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `result: Optional[EmailEmailRoutingDNSQueryResponseResult]` - `errors: Optional[List[EmailEmailRoutingDNSQueryResponseResultError]]` - `code: Optional[str]` - `missing: Optional[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"` - `record: Optional[List[DNSRecord]]` - `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'. - `type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]` DNS record type. - `result_info: Optional[EmailEmailRoutingDNSQueryResponseResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. - `total_pages: Optional[float]` The number of total pages in the entire result set. - `class EmailDNSSettingsResponseCollection: …` - `errors: List[EmailDNSSettingsResponseCollectionError]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailDNSSettingsResponseCollectionErrorSource]` - `pointer: Optional[str]` - `messages: List[EmailDNSSettingsResponseCollectionMessage]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[EmailDNSSettingsResponseCollectionMessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `result: Optional[List[DNSRecord]]` - `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'. - `type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]` DNS record type. - `result_info: Optional[EmailDNSSettingsResponseCollectionResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. - `total_pages: Optional[float]` The number of total pages in the entire result set.