- Created by Documentation, last modified on Feb 18, 2019
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function installs existing keys for use in a Domain Keys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records.
Important:
MailSend
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Notes:
- This function does not update the local DNS server's records.
- If the local DNS server is authoritative for the domain's DNS records, use the WHM API 1
enable_dkim
function to update the local DNS server's DNS records.- We recommend that you use the WHM API 1
install_dkim_private_keys
andenable_dkim
functions in a batch WHM API 1 call.
- We recommend that you use the WHM API 1
Examples
https://hostname.example.com:2087/cpsess##########/json-api/install_dkim_private_keys?api.version=1&domain=example.com&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a
whmapi1 install_dkim_private_keys domain=example.com key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "payload": [ { "domain": "example.com", "msg": "[ADD:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]", "status": 1 } ], "metadata": { "command": "", "reason": "OK", "result": 1, "version": 1 } } }
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
domain | string | Required The domain for which to install an RSA private key to the local server's DKIM record. Note: To install RSA private keys for multiple domains, duplicate the parameter name. For example, use the | A valid domain. | example.com |
key | string | Required An RSA key in Privacy-Enhanced Mail (PEM) format. Note: You must provide this parameter for each | A valid Base64-encoded private key. | Click to view... AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
payload | array of hashes | An array that contains information about the RSA private key installation to the local server's DKIM record. | Each hash contains the | |
| string | The RSA private key's associated domain. This function returns this value in the | A valid domain. | example.com |
| string | The RSA private key's installation status message. This function returns this value in the | A valid string. | Click to view... [ADD:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;] |
| Boolean | Whether the system installed the RSA private key to the local server's DKIM record. This function returns this value in the |
|
|
Function information
API Version:
Available in:
WHM 78+
Methods:
GET, POST
Required Parameters:
domain
, key
Return Formats:
JSON
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - Addon Domains — Addon Domain functions allow you to manage addon domains or convert them to full cPanel accounts.
-
Page:WHM API 1 Functions - convert_addon_fetch_conversion_details — This function returns the details of the convert addon domain to account process.
-
Page:WHM API 1 Functions - convert_addon_fetch_domain_details — This function retrieves domain data for an addon domain.
-
Page:WHM API 1 Functions - convert_addon_get_conversion_status — This function returns the status of the convert addon domain to account process for specified conversion jobs.
-
Page:WHM API 1 Functions - convert_addon_initiate_conversion — This function initiates the conversion process for an addon domain.