cPanel API 2 Functions - DKIMUI::getrecords

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

Examples 


 WHM API (JSON)

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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',
 
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

cpapi2 --user=username DKIMUI get_records

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "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"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

 Return 

Type

Description

Possible values

Example

 record

 string

 The full DKIM record.

 A DKIM key record.

 Click to view

 reason

 string

 A reason for failure.

 Note:

 

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

 

 

 A string that describes the error.

  This is an error message. 

 result

 Boolean 

 Whether the function succeeded.

 

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

 1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....