Software Development Kit
Page tree
Skip to end of metadata
Go to start of metadata

 

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Use WHM API to Call cPanel API & UAPI

 

 

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

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled
 Command Line
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.

 Output (JSON)
{
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "set_application_contact_event_importance"
  }
}
 Output (XML)
<result>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>set_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
importancestring

Required

The importance level at which to send the notification.

  • High
  • Medium
  • Low
  • Disabled

Disabled

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 58+

Methods:

GET, POST

Required Parameters:

app, event, importance

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

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 or 2087) to call WHM API functions.
  

Find a function

Related functions