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

 

Description

This function returns the Greylisting trusted status of the server's netblock.

Examples 


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


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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "ip_blocks": {
      "199.0.0.0-199.3.255.255": 1,
      "10.0.0.0-10.255.255.255": 1,
      "48.0.0.0-48.255.255.255": 1
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "cpgreylist_is_server_netblock_trusted"
  }
}
 Output (XML)
<result>
    <data>
        <ip_blocks>
             <199.0.0.0-199.3.255.255>1</199.0.0.0-199.3.255.255>
             <10.0.0.0-10.255.255.255>1</10.0.0.0-10.255.255.255>
             <48.0.0.0-48.255.255.255>1</48.0.0.0-48.255.255.255>
        </ip_blocks>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>cpgreylist_is_server_netblock_trusted</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
ip_blockshashA hash of the neighboring netblocks.This hash contains one or more IP address range returns. 

IP Address Range

Boolean

Whether the Trusted Hosts list includes the IP address range.

Note:

The return's name is the IP address range.

The function returns this value in the ip_blocks hash.

  • 1 Trusted
  • 0 Not trusted.
1