Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - enable_monitor_all_enabled_services - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - enable_monitor_all_enabled_services
Skip to end of metadata
Go to start of metadata

Description

This function enables monitoring for all enabled services.

Notes:

  • For a list of enabled services, navigate to WHM's Service Manager interface (Home >> Service Configuration >> Service Manager).
  • To enable or disable individual services, use the configureservice function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/enable_monitor_all_enabled_services?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/enable_monitor_all_enabled_services?api.version=1
 Command Line
whmapi1 enable_monitor_all_enabled_services


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": {
    "services": [
      {
        "monitored": 1,
        "service": "clamd"
      },
      {
        "monitored": 1,
        "service": "cpdavd"
      },
      {
        "monitored": 1,
        "service": "cpgreylistd"
      },
      {
        "monitored": 1,
        "service": "cphulkd"
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "enable_monitor_all_enabled_services"
  }
}
 Output (XML)
<result>
    <data>
        <services>
            <monitored>1</monitored>
            <service>clamd</service>
        </services>
        <services>
            <monitored>1</monitored>
            <service>cpdavd</service>
        </services>
        <services>
            <monitored>1</monitored>
            <service>cpgreylistd</service>
        </services>
        <services>
            <monitored>1</monitored>
            <service>cphulkd</service>
        </services>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>enable_monitor_all_enabled_services</command>
    </metadata>
</result>


Note:

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

Parameters

This function does not require parameters.

Returns

ReturnsTypeDescriptionPossible valuesExample
servicesarray of hashes

An array of hashes that contains information about a service and its monitoring status.

This array of hashes includes the monitored and service returns.
 

monitored

Boolean

Whether the system monitors the service.

This function returns this value in the services hash.

  • 1 — Monitored.
  • 0Not monitored.
1

service

string

The service's name.

This function returns this value in the services hash.

A valid service name.

cphulkd