latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
Mail DNS Settings

Validate domain's DKIM keys

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

Note:

  • 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/ensure_dkim_keys_exist

Query parameters

domainstring required

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

Note:

To check the DKIM key validity for multiple domain, duplicate the parameter name. For example, use the domain-1=example.com, domain-2=example2.com, and domain-3=example3.com parameters.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "payload": [
      {
        "domain": "example.com",
        "msg": "created new key",
        "status": 1
      }
    ]
  },
  "metadata": {
    "command": "ensure_dkim_keys_exist",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}