v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

cPGreyList

Spam Filtering (Greylisting)

Return Greylisting status for domains

This function returns Greylisting's status for a cPanel account's domains.

get/cPGreyList/list_domains

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_domains",
  "module": "cPGreyList",
  "result": {
    "data": [
      {
        "cPGreyList": {
          "total_disabled": 1
        },
        "dependencies": [
          "this.com",
          "that.com",
          "theother.com"
        ],
        "domain": "example.com",
        "searchhint": "this, that, and the other.",
        "type": "main"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}