Get Email Routing settings

Get information about the settings for your Email Routing zone.

/zones/{zone_identifier}/email/routing

get

Email Routing settings

email-routing-settings-get-email-routing-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": {
                      "anyOf": [
                        {
                          "type": "object"
                        },
                        {
                          "type": "string"
                        }
                      ]
                    }
                  }
                }
              ],
              "type": "object"
            },
            {
              "properties": {
                "result": {
                  "allOf": [
                    {
                      "properties": {
                        "created": {
                          "description": "The date and time the settings have been created.",
                          "example": "2014-01-02T02:20:00Z",
                          "format": "date-time",
                          "readOnly": true,
                          "type": "string"
                        },
                        "enabled": {
                          "default": true,
                          "description": "State of the zone settings for Email Routing.",
                          "enum": [
                            true,
                            false
                          ],
                          "example": true,
                          "type": "boolean"
                        },
                        "modified": {
                          "description": "The date and time the settings have been modified.",
                          "example": "2014-01-02T02:20:00Z",
                          "format": "date-time",
                          "readOnly": true,
                          "type": "string"
                        },
                        "name": {
                          "description": "Domain of your zone.",
                          "example": "example.net",
                          "readOnly": true,
                          "type": "string"
                        },
                        "skip_wizard": {
                          "default": true,
                          "description": "Flag to check if the user skipped the configuration wizard.",
                          "enum": [
                            true,
                            false
                          ],
                          "example": true,
                          "type": "boolean"
                        },
                        "status": {
                          "description": "Show the state of your account, and the type or configuration error.",
                          "enum": [
                            "ready",
                            "unconfigured",
                            "misconfigured",
                            "misconfigured/locked",
                            "unlocked"
                          ],
                          "example": "ready",
                          "readOnly": true,
                          "type": "string"
                        },
                        "tag": {
                          "description": "Email Routing settings identifier.",
                          "example": "75610dab9e69410a82cf7e400a09ecec",
                          "maxLength": 32,
                          "readOnly": true,
                          "type": "string"
                        }
                      },
                      "type": "object"
                    }
                  ],
                  "type": "object"
                }
              }
            }
          ]
        }
      }
    },
    "description": "Get Email Routing settings response"
  }
}

Debug "security"

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