Return Greylisting IP addresses of mail providers

This function lists Greylisting's IP addresses for the specified mail provider.

Authorizations:
query Parameters
provider
required
string

The mail provider.

Note:

  • To list entries for multiple mail providers, increment the parameter name. For example, provider-0, provider-1, and provider-2.
  • Call WHM API 1's cpgreylist_load_common_mail_providers_config function to return a list of valid provider keys.
Examples:
provider=provider-0=example-0 provider-1=example-1 provider-2=example-2
provider=cpanel

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  cpgreylist_list_entries_for_common_mail_provider \
  provider='cpanel'

Response samples

Content type
application/json
{
  • "data": {
    • "providers": {
      • "cpanel": {
        • "ips": [
          • {
            • "create_time": "2015-07-28T08:16:52.000Z",
            • "host_ip": "208.115.214.0-208.115.214.255",
            • "is_trusted": 1,
            • "provider_id": 7
            },
          • {
            • "create_time": "2015-07-28T08:16:52.000Z",
            • "host_ip": "74.63.202.0-74.63.202.255",
            • "is_trusted": 1,
            • "provider_id": 7
            }
          ]
        }
      },
    • "providers_failed": {
      • "dpanel": "Unknown mail provider: dpanel"
      }
    },
  • "metadata": {
    • "command": "cpgreylist_list_entries_for_common_mail_provider",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}