UAPI Functions - cPGreyList::disable_domains - Knowledgebase

Description

This function disables Greylisting on a cPanel account's selected domains.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/disable_domains?domains=example.com%7Cexample1.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Disable Greylisting on example.com, example1.com, example2.com domains.
$disable_domains = $cpanel->uapi(
    'cPGreyList', 'disable_domains',
    array(
        'domains'     => 'example.com|example1.com',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Disable Greylisting on example.com, example1.com, example2.com domains.
my $disable_domains = $cpliveapi->uapi(
    'cPGreyList', 'disable_domains',
    {
        'domains'     => 'example.com|example1.com',
    }
);

cPanel Template Toolkit

[% execute('cPGreyList', 'disable_domains', { 'domains' => 'example.com|example1.com' }) %]

Command Line

uapi --user=username cPGreyList disable_domains domains=example.com%7Cexample1.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    "transformed": 1
  },
  "data": [
    {
      "domain": "example.com",
      "dependencies": [
          "this.com",
          "that.com",
          "theother.com",       
      ],
      "type": "main",
      "searchhint": "this, that, and the other",
      "enabled": 0
    }
  ]
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domains	string	Required The domains on which to disable Greylisting.	A pipe-separated list of valid domains that the cPanel account owns.	example.com\|example1.com

Parameter

Type

Description

Possible values

Example

domains

string

Required

The domains on which to disable Greylisting.

A pipe-separated list of valid domains that the cPanel account owns.

example.com|example1.com

Returns

Return	Type	Description	Possible values	Example
domain	string	The domain.	A valid domain on a cPanel account.	example.com
dependencies	array	An array of domains that your changes will affect.	An array of valid domains on the cPanel account.	"this.com", "that.com", "theother.com",
type	string	The domain type.	main — A main domain. sub — A subdomain.	main
searchhint	string	A list of domain-related search terms.	A comma-separated list of string values.	this, that, the other
enabled	Boolean	Whether Greylisting is disabled.	1 — Enabled. 0 — Disabled.	0

Knowledgebase

Categories

Categories