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.

SecurityBasicAuth

Request

query Parameters

domain

required

string <domain>

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.

Examples:

Multiple domains. domain=domain=example.com&domain=example2.com&domain=example3.com

A single domain. domain=example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/EmailAuth/ensure_dkim_keys_exist

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  EmailAuth \
  ensure_dkim_keys_exist \
  domain='example.com'

Response samples

application/json

{"apiversion": 3,
"func": "ensure_dkim_keys_exist",
"module": "EmailAuth",
"result": {"data": [{"domain": "example.com",
"msg": "created new key",
"status": 1
}
],
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}