Developer Documentation
Child pages
  • WHM API 1 Functions - get_application_contact_event_importance

Versions Compared

Old Version 2

changes.mady.by.user Documentation

Saved on

compared with

New Version Current

changes.mady.by.user Documentation

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Include Page
LIB:_WHMAPI1Menu
LIB:_WHMAPI1Menu

 

Description

Excerpt

This function retrieves the importance level of an application event for WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).

Note
titleNote:

The system will create a notification setting for the application's events if one does not already exist.

Panel
bgColor#F2F2F2
borderStylenone

Examples

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange
Expand
titleCommand Line
Code Block
languagebash
whmapi1 get_application_contact_event_importance app=Check event=SecurityAdvisorStateChange

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "data": {
    "importance": 1,
    "name": "Disabled"
  },
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_application_contact_event_importance"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

     

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
Panel
bgColor#F2F2F2
borderStylenone

Function information

Panel
bgColor#FFFFFF
borderStylenone
Section
Column
width40%

API Version:

Column

WHM API 1

Section
Column
width40%

Available in:

Column

WHM 58+

Section
Column
width40%

Methods:

Column

GET, POST

Section
Column
width40%

Required Parameters:

Column
app, event
Section
Column
width40%

Return Formats:

Column

JSON, XML

Multiexcerpt include
MultiExcerptNameShort Macro
PageWithExcerptLIB:_XMLDeprecated

About WHM API 1

Include Page
LIB:_WHMAPI1About
LIB:_WHMAPI1About
  

Find a function

Livesearch
additionalpage excerpt
placeholderSearch...
labelswhmapi1

Related functions

Content by Label
showLabelsfalse
max5
showSpacefalse
sortmodified
excerpttrue
excerptTypesimple
operatorAND
cqllabel = "server" and label = "whmapi1"
labelswhmapi1,server

 

 

HideElements
metastrue