cPanel module
6 functions, invoked through the cpanel_uapi tool.
scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="cPGreyList", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.
disable_all_domains GET # Disable Greylisting for all domains
This function disables Greylisting on a cPanel account's domains.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
dependencies array<string>
The domains that your changes will affect.
enabled integer
Whether Greylisting is enabled. - 1 — Enabled. - 0 — Disabled.
One of: 0 1
searchhint string
A comma-separated list of domain-related search terms.
type string
The domain type. - main — A main domain. - addon — An addon domain. - parked — A parked domain.
One of: main addon parked
disable_domains GET # Disable Greylisting for specified domains
This function disables Greylisting on a cPanel account's selected domains.
domains string Required
The domain on which to disable Greylisting. Note: To disable Greylisting on multiple domains, use the domains parameter multiple times.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
dependencies array<string>
An array of domains that your changes will affect.
enabled integer
Whether Greylisting is disabled. 1 — Enabled. 0 — Disabled.
One of: 0 1
searchhint string
A comma-separated list of domain-related search terms.
type string
The domain type. main — A main domain. sub — A subdomain.
One of: main sub
enable_all_domains GET # Enable Greylisting for all domains
This function enables Greylisting on all of the cPanel account's domains.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
dependencies array<string>
An array of domains that your changes will affect.
enabled integer
Whether Greylisting is enabled. 1 — Enabled. 0 — Disabled.
One of: 0 1
searchhint string
A comma-separated list of domain-related search terms.
type string
The domain type. main — A main domain. sub — A subdomain.
enable_domains GET # Enable Greylisting for specified domains
This function enables Greylisting on a cPanel account's selected domains.
domains string Required
The domain on which to enable Greylisting. Note: To enable Greylisting on multiple domains, use the domains parameter multiple times.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
dependencies array<string>
An array of domains that your changes will affect.
enabled integer
Whether Greylisting is disabled. 1 — Enabled. 0 — Disabled.
One of: 0 1
searchhint string
A comma-separated list of domain-related search terms.
type string
The domain type. main — A main domain. sub — A subdomain.
One of: main sub
has_greylisting_enabled GET # Return whether Greylisting is enabled
This function checks whether Greylisting is enabled for the cPanel account.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data contains:
enabled integer
Whether Greylisting is enabled. 1 — Enabled. 0 — Disabled.
One of: 0 1
list_domains GET # Return Greylisting status for domains
This function returns Greylisting's status for a cPanel account's domains.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
cPGreyList object
An object that contains the number of domains with Greylisting enabled or disabled.
total_disabled integer
The number of domains with Greylisting disabled.
total_enabled integer
The number of domains with Greylisting enabled.
dependencies array<string>
An array of domains that your changes to a selected domain will affect.
enabled integer
Whether Greylisting is enabled. 1 — Enabled. 0 — Disabled.
One of: 0 1
searchhint string
A comma-separated list of domain-related search terms.
type string
The domain type. main — A main domain. sub — A subdomain.
One of: main sub