Email Routing - DNS settings

Show the DNS records needed to configure your Email Routing zone.

/zones/{zone_identifier}/email/routing/dns

get

Email Routing settings

email-routing-settings-email-routing-dns-settings

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "com.cloudflare.api.account.zone.email.routing.config.read"
  ]
}

Debug "parameters"

[
  {
    "in": "path",
    "name": "zone_identifier",
    "required": true,
    "schema": {
      "description": "Identifier",
      "example": "023e105f4ecef8ad9ca31a8372d0c353",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "properties": {
                    "errors": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "messages": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "result": {
                      "anyOf": [
                        {
                          "type": "object"
                        },
                        {
                          "items": {},
                          "type": "array"
                        },
                        {
                          "type": "string"
                        }
                      ]
                    },
                    "success": {
                      "description": "Whether the API call was successful",
                      "enum": [
                        true
                      ],
                      "example": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "success",
                    "errors",
                    "messages",
                    "result"
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "items": {},
                      "nullable": true,
                      "type": "array"
                    },
                    "result_info": {
                      "properties": {
                        "count": {
                          "description": "Total number of results for the requested service",
                          "example": 1,
                          "type": "number"
                        },
                        "page": {
                          "description": "Current page within paginated list of results",
                          "example": 1,
                          "type": "number"
                        },
                        "per_page": {
                          "description": "Number of results per page of results",
                          "example": 20,
                          "type": "number"
                        },
                        "total_count": {
                          "description": "Total results available without any search parameters",
                          "example": 2000,
                          "type": "number"
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              ],
              "type": "object"
            },
            {
              "properties": {
                "result": {
                  "items": {
                    "description": "List of records needed to enable an Email Routing zone.",
                    "properties": {
                      "content": {
                        "description": "DNS record content.",
                        "example": "route1.mx.cloudflare.net",
                        "type": "string"
                      },
                      "name": {
                        "description": "DNS record name (or @ for the zone apex).",
                        "example": "example.com",
                        "maxLength": 255,
                        "type": "string"
                      },
                      "priority": {
                        "description": "Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.",
                        "example": 12,
                        "maximum": 65535,
                        "minimum": 0,
                        "type": "number"
                      },
                      "ttl": {
                        "anyOf": [
                          {
                            "example": 3600,
                            "maximum": 86400,
                            "minimum": 1,
                            "type": "number"
                          },
                          {
                            "enum": [
                              1
                            ],
                            "type": "number"
                          }
                        ],
                        "description": "Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.",
                        "example": 1,
                        "type": "number"
                      },
                      "type": {
                        "description": "DNS record type.",
                        "enum": [
                          "A",
                          "AAAA",
                          "CNAME",
                          "HTTPS",
                          "TXT",
                          "SRV",
                          "LOC",
                          "MX",
                          "NS",
                          "CERT",
                          "DNSKEY",
                          "DS",
                          "NAPTR",
                          "SMIMEA",
                          "SSHFP",
                          "SVCB",
                          "TLSA",
                          "URI"
                        ],
                        "example": "NS",
                        "readOnly": true,
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              }
            }
          ]
        }
      }
    },
    "description": "Email Routing - DNS settings response"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]