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.

SecurityBasicAuth

Request

query Parameters

domain

required

string

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.

Examples:

Check the DKIM key validity for multiple domains. domain=domain=example1.com&domain=example2.com&domain=example3.com

Check the DKIM key validity for a single domain. domain=example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/ensure_dkim_keys_exist

Request samples

whmapi1 --output=jsonpretty \
  ensure_dkim_keys_exist \
  domain='example.com'

Response samples

application/json

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