Child pages
  • WHM API 1 Functions - get_application_contact_importance
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function retrieves the importance level of an application's events 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_importance?api.version=1&app=Check
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_application_contact_importance?api.version=1&app=Check
 Command Line
whmapi1 get_application_contact_importance app=Check event=SecurityAdvisorStateChange


Notes:

  • Unless otherwise noted, 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

 Output (JSON)
{
  "data": {
    "importance": 1,
    "name": "Disabled"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_application_contact_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_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

Returns

Return

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

The text version of the importance setting.

  • High

  • Medium

  • Low

  • Disabled

Disabled
  • No labels