v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email DNS Settings

Delete mail exchanger record

This function deletes a Mail Exchanger (MX) record. For more information about MX record settings, read our Email Routing Configuration documentation.

Important:

When you disable the DNS role, the system disables this function.

get/Email/delete_mx

Query parameters

domainstring domain required
Example:example.com

The mail exchanger's domain.

exchangerstring required
Example:mail.example.com

The mail exchanger's name.

priorityinteger required
Example:15

The mail exchanger's priority value. If multiple MX entries match the exchanger value, the system uses this parameter to find the correct entry.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete_mx",
  "module": "Email",
  "result": {
    "data": {
      "checkmx": {
        "changed": 1,
        "detected": "auto",
        "mxcheck": "auto",
        "warnings": "Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local."
      },
      "results": "Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]",
      "status": 1,
      "statusmsg": "Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]"
    },
    "status": 1
  }
}