Description

This function retrieves active Domain Keys Identified Mail (DKIM) records.


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DKIMUI&cpanel_jsonapi_func=getrecords



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve DomainKeys records on example.com.
$dkim_get_records = $cpanel->api2(
    'DKIMUI', 'getreords'

    ) 
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve DomainKeys records on example.com.
my $dkim_get_records = $cpliveapi->api2(
    'DKIMUI', 'getrecords',

);




cpapi2 --user=username DKIMUI getrecords



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getrecords",
    "data": [
      {
        "record": "default._domainkey.example IN TXT \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDC7hPOOwu+OE61dxZp7NlM2N1V79ir5xqCXPFmuCzUb2TZTO18LpZqVvSAXz3laLSSo6sF2TKmxZCFcIKdwUJNA+aeAzMlmQF2Kau8puVCWdqcRNZvVHI5LE8zlPPcrmlHekOFl\/lEGcwjYBUSmHUMlOsNirngTmmY6wOZ1CkYxQIDAQAB;\""
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DKIMUI"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
recordstringThe full DKIM record.A DKIM key record.


 p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDC7hPOOwu+OE61dxZp7NlM2N1V79ir5xqCXPFmuCzUb2TZTO18LpZqVvSAXz3laLSSo6sF2TKmxZCFcIKdwUJNA+aeAzMlmQF2Kau8puVCWdqcRNZvVHI5LE8zlPPcrmlHekOFl\/lEGcwjYBUSmHUMlOsNirngTmmY6wOZ1CkYxQIDAQAB;\""


reasonstring

A reason for failure.

This function only returns a reason value if there was an error. 


A string that describes the error.  This is an error message.
resultBoolean

Whether the function succeeded.

 

  • 1 — The function succeeded.
  • 0 — The function failed.
1