Developer Documentation
Child pages
  • WHM API 1 Functions - load_cpgreylist_config
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

Call cPanel API 2 and UAPI

 

 

Description

This function returns Greylisting's current settings.

Examples 

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


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": {
    "cpgreylist_config": {
      "is_enabled": "1",
      "spf_bypass": 1,
      "child_timeout_secs": 5,
      "record_exp_time_mins": 4320,
      "is_exim_enabled": 1,
      "initial_block_time_mins": 10,
      "purge_interval_mins": 60,
      "max_child_procs": 5,
      "must_try_time_mins": 240
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "load_cpgreylist_config"
  }
}
 Output (XML)
<result>
    <data>
        <cpgreylist_config>
            <is_enabled>1</is_enabled>
            <spf_bypass>1</spf_bypass>
            <child_timeout_secs>5</child_timeout_secs>
            <record_exp_time_mins>4320</record_exp_time_mins>
            <is_exim_enabled>1</is_exim_enabled>
            <initial_block_time_mins>10</initial_block_time_mins>
            <purge_interval_mins>60</purge_interval_mins>
            <max_child_procs>5</max_child_procs>
            <must_try_time_mins>240</must_try_time_mins>
        </cpgreylist_config>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>load_cpgreylist_config</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 accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample
cpgreylist_confighashA hash of Greylisting settings.This hash includes the is_enabled, spf_bypass, child_timeout_secs, record_exp_time_mins, is_exim_enabled, initial_block_time_mins, purge_interval_mins, max_child_procs, and must_try_time_mins returns. 

is_enabled

Boolean

Whether Greylisting is enabled.

The function returns this value in the cpgreylist_config hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

spf_bypass

Boolean

Whether emails with SPF bypass Greylisting.

The function returns this value in the cpgreylist_config hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

child_timeout_secs

integer

The maximum amount of time that Greylisting waits for a child process to time out.

The function returns this value in the cpgreylist_config hash.

A valid integer, in seconds.5

record_exp_time_mins

integer

The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet.

The function returns this value in the cpgreylist_config hash.

A valid integer, in minutes.

The maximum value for this parameter is 43200 minutes (30 days).

4320

is_exim_enabled

Boolean

Whether Exim is enabled.

The function returns this value in the cpgreylist_config hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

initial_block_time_mins

integer

The number of minutes during which Greylisting defers email from an unknown triplet.

The function returns this value in the cpgreylist_config hash.

A valid integer, in minutes.

The maximum value for this parameter is 240 minutes (four hours).

10

purge_interval_mins

integer

The number of minutes before Greylisting deletes the records in the Greylisting database.

The function returns this value in the cpgreylist_config hash.

A valid integer, in minutes.60

max_child_procs

integer

The maximum amount of child processes.

The function returns this value in the cpgreylist_config hash.

A valid positive integer.5

must_try_time_mins

integer

The number of minutes during which Greylisting accepts a resent email from an unknown triplet.

The function returns this value in the cpgreylist_config hash.

A valid integer, in minutes.

The maximum value for this parameter is 1440 minutes (one day).

240

Function information

API Version:

WHM API 1

Available in:

WHM 11.50+

Methods:

GET, POST

Required Parameters:

(none)

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 you 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