v1

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

Validate domains' DKIM private keys

This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains.

Notes:

  • If an existing DKIM key does not meet the server's security requirements, the system replaces the existing DKIM key.
  • If no DKIM key exists, the system creates a new key for the domain.
get/EmailAuth/ensure_dkim_keys_exist

Query parameters

domainstring domain required

The domain for which to confirm a valid DKIM key exists.

Note:

To check the DKIM key validity for multiple domains, duplicate the parameter name. For example, use the domain=example.com, domain=example2.com, and domain=example3.com 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": "ensure_dkim_keys_exist",
  "module": "EmailAuth",
  "result": {
    "data": [
      {
        "domain": "example.com",
        "msg": "created new key",
        "status": 1
      }
    ],
    "status": 1
  }
}