- 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 removes the Domain Keys Identified Mail (DKIM) records on the DNS server for one or more domains.
Important:
MailSend
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/disable_dkim?api.version=1&domain=example.com&domain=anotherexample.com
whmapi1 disable_dkim domain=example.com domain=anotherexample.com
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": "[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]", "status": 1 }, { "domain": "anotherexample.com", "msg": "[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]", "status": 1 } ], "metadata": { "command": "", "result": "OK", "": , "status": 1 } }
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
domain | string | Required The domain for which to remove DKIM records on the DNS server. Note: To remove multiple domain DKIM records, duplicate the parameter name. For example, use the | A valid domain. | example.com |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
payload | array of hashes | An array that contains information about the removal of a domain's DKIM record on the DNS server. | Each hash contains the | |
| string | The domain for which the system removed the DKIM record. This function returns this value in the | A valid domain. | example.com |
| string | Information about the removed DKIM record. This function returns this value in the | A valid string. | [REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\/xJtrPZKskZF8\/sU0zWGTqKUOErlyJfoJzMDUv3\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\;] |
| Boolean | Whether the system removed the domain's DKIM record on the DNS server. This function returns this value in the |
| 1 |
Function information
API Version:
Available in:
WHM 78+
Methods:
GET, POST
Required Parameters:
domain
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.