Validate DKIM records

This function retrieves and checks the DomainKeys Identified Mail (DKIM) records for one or more domains.

SecurityBasicAuth

Request

query Parameters

domain

required

string

The domain for which to check the DKIM records.

Note:

To check multiple domains, duplicate or increment the parameter name. For example, domain-1, domain-2, and domain-3 parameters.

Examples:

Check the DKIM records for multiple domains. domain=domain-1=example.com&domain-2=example.com&domain-3=example3.com

Check the DKIM records for multiple domains. domain=domain=example.com&domain=example2.com&domain=example3.com

Check the DKIM records for a single domain. domain=example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/validate_current_dkims

Request samples

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

Response samples

application/json

{"data": {"payload": [{"domain": "default._domainkey.example.com",
"expected": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\",
"records": [{"current": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\",
"state": "VALID"
}
],
"state": "VALID",
"validity_cache_update": "valid"
},
{"domain": "default._domainkey.example2.com",
"error": "(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “default._domainkey.example2.com”’s “TXT” records.",
"expected": "v=DKIM1; k=rsa; p=MIIBIjAAAgkrhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4mA8NH3BkYvOmB0+ll23U78JesahG8304unKhW+MAm0ZE+i6EWN6iXhUj7FRPvI/6jFRd7qAHCPKFLo5+/PTy8C8eK312tfSnF3N0eucYFbgZ8F8iSRdgrcgEjvJ1vM1uvcUF211yd/e3jxT2Ge4/fmZcTYNjfH3uAuriv61L6pdIwHUWPhcjQvgOQoKQgXgooCUbUkWFDkMAH+EF/0g1dnXf289LjlvQsKhY7Y135Zpvm21kjUcj5mrLDlHJALzCVb8K/r/LCxjV5GFUyJiiNLAxkI9V1vZ4pMQvKIsN7wzu6gXK87w6mEWvKvipMAP8A2choDrk6H/fcQtfNodgwIDADAB;",
"records": [ ],
"state": "ERROR",
"validity_cache_update": "none"
}
]
},
"metadata": {"command": "validate_current_dkims",
"reason": "OK",
"result": 1,
"version": 1
}
}