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.

Authorizations:
query Parameters
domain
required
string <domain>

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.
Examples:
domain=domain-1=example1.com domain-2=example2.com domain-3=example3.com
domain=domain=example1.com domain=example2.com domain=example3.com
domain=example.com

Responses

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

Request samples

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

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "enable_dkim",
  • "module": "EmailAuth",
  • "result": {
    • "data": [
      • {
        • "domain": "example.com",
        • "msg": "[no changes needed]",
        • "status": 1
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}