v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

EmailAuth

Email DNS Settings

Enable domains' DKIM records

This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.

Note:

If a DKIM record does not exist on the server, this function will install a new DKIM record.

get/EmailAuth/enable_dkim

Query parameters

domainstring domain required

The domain for which to enable DKIM records on the DNS server.

Note:

To enable multiple domain DKIM records, duplicate or increment the parameter. For example, to perform this for three domains, you could:

Use the domain parameter multiple times.
Use the domain, domain-1, and domain-2 parameters.

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": "enable_dkim",
  "module": "EmailAuth",
  "result": {
    "data": [
      {
        "domain": "example.com",
        "msg": "[no changes needed]",
        "status": 1
      }
    ],
    "status": 1
  }
}