- Created by Documentation, last modified on Dec 12, 2017
Use WHM API to Call cPanel API & UAPI
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 sets the importance level of an application event for WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).
Note:
The system will create a notification setting for the application's events if one does not already exist.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled
https://hostname.example.com:2087/cpsess##########/xml-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled
whmapi1 set_application_contact_event_importance app=Check event=SecurityAdvisorStateChange importance=Disabled
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. - We introduced this functionality in cPanel & WHM version 11.52.0.8.
{ "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "set_application_contact_event_importance" } }
<result> <metadata> <reason>OK</reason> <version>1</version> <result>1</result> <command>set_application_contact_event_importance</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
app | string | Required The application module's name. | A valid cPanel & WHM module name..
| Check |
event | string | Required The event's name. | A valid event name in the module. | SecurityAdvisorStateChange |
importance | string | Required The importance level at which to send the notification. |
|
|
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 58+
Methods:
GET, POST
Required Parameters:
app
, event
, importance
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that the caller 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 Functions - get_tweaksetting — This function retrieves a value from the
/var/cpanel/cpanel.config
file. -
Page:WHM API 1 Functions - getdiskusage — This function retrieves the server's drive partition information.
-
Page:WHM API 1 Functions - systemloadavg — This function retrieves the system's load average.
-
Page:WHM API 1 Functions - loadavg — This function retrieves the server's load average.
-
Page:WHM API 1 Functions - gethostname — This function retrieves the server's hostname.