Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves 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


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange
 Command Line
whmapi1 get_application_contact_event_importance app=Check event=SecurityAdvisorStateChange

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.

 Output (JSON)
{
  "data": {
    "importance": 1,
    "name": "Disabled"
  },
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_application_contact_event_importance"
  }
}
 Output (XML)
<result>
    <data>
        <importance>0</importance>
        <name>Disabled</name>
    </data>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>get_application_contact_event_importance</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

     

Parameters

ParameterTypeDescriptionPossible valuesExample
appstring

Required

The application module's name.

A valid cPanel & WHM module name.
Check
eventstring

Required

The event's name.

A valid event name in the module.

SecurityAdvisorStateChange

Returns

Return

TypeDescriptionPossible valuesExample
importanceintegerThe importance level at which to send the notification.
  • 1 — High.
  • 2 — Medium.
  • 3 — Low.
  • 0 — Disabled.
0
namestringThe text version of the importance.
  • High

  • Medium

  • Low

  • Disabled

Disabled