Return Greylisting status for domains

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

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/cPGreyList/list_domains
Request samples
uapi --output=jsonpretty \
  --user=username \
  cPGreyList \
  list_domains
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "list_domains",
  • "module": "cPGreyList",
  • "result": {
    • "data": [
      • {
        • "cPGreyList": {
          • "total_disabled": 1,
          • "total_enabled": 0
          },
        • "dependencies": [
          • "this.com",
          • "that.com",
          • "theother.com"
          ],
        • "domain": "example.com",
        • "enabled": 0,
        • "searchhint": "this, that, and the other.",
        • "type": "main"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}