openapi: 3.2.0 info: contact: email: cs@cpanel.net name: WebPros International, LLC url: https://cpanel.net/support/ description: WHM API. license: name: cPanel License url: https://cpanel.net/legal-notices/ termsOfService: https://cpanel.net/legal-notices/ title: WHM Greylisting API version: 11.137.9999.106 x-api-evangelist-provenance: 'Harvested verbatim from cPanel''s developer portal on 2026-09-05 via the MCP tool get-full-api-description at https://api.docs.cpanel.net/mcp. ONE mechanical change was made before storage: example values containing PEM private-key or certificate blocks, and AWS-access-key-shaped example strings, were replaced with REDACTED_* placeholders so the file can be stored in a public git repository without tripping secret scanning. No path, operation, parameter, schema or description was altered, added or removed.' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. security: - BasicAuth: [] tags: - description: The Greylisting module for WHM API 1. name: Greylisting paths: /cpgreylist_is_server_netblock_trusted: get: description: This function returns the Greylisting trusted status of the server's netblock. operationId: cPGreyList-cpgreylist_is_server_netblock_trusted parameters: [] responses: '200': content: application/json: schema: properties: data: properties: ip_blocks: additionalProperties: description: 'Whether the *Trusted Hosts* list includes the IP address range. This return''s name is the IP address range. * `1` — Trusted. * `0` — Not trusted.' enum: - 1 - 0 type: integer description: A list containing the neighboring netblocks. example: 10.0.0.0-10.255.255.255: 1 199.0.0.0-199.3.255.255: 1 48.0.0.0-48.255.255.255: 1 type: object type: object metadata: properties: command: description: The method name called. example: cpgreylist_is_server_netblock_trusted type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting trust status of server netblock tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_is_server_netblock_trusted\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_is_server_netblock_trusted?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /cpgreylist_list_entries_for_common_mail_provider: get: description: This function lists Greylisting's IP addresses for the specified mail provider. operationId: cPGreyList-cpgreylist_list_entries_for_common_mail_provider parameters: - description: "The mail provider.\n\n**Note:**\n\n * To list entries for multiple mail providers, increment the parameter name. For example, `provider-0`, `provider-1`, and `provider-2`.\n * Call WHM API 1's `cpgreylist_load_common_mail_providers_config` function to return a list of valid provider keys." examples: multiple: summary: List multiple mail provider entries. value: provider-0=example-0 provider-1=example-1 provider-2=example-2 single: summary: List a single mail provider entry. value: cpanel in: query name: provider required: true schema: type: string responses: '200': content: application/json: schema: properties: data: example: 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' properties: providers: additionalProperties: description: 'An object containing an object that contains the mail provider''s IP address data. **Note:** The return''s name is the mail provider''s display name.' properties: ips: description: An object containing the mail provider's IP address data. properties: create_time: description: The date and time when the function created the record. example: '2015-07-28T08:16:52.000Z' format: ISO-8601 Date Time (Space Separated) type: string host_ip: description: The mail provider's IP address or range. example: 192.168.0.1 format: ipv4 type: string is_trusted: description: 'Whether Greylisting trusts this mail provider''s IP addresses. - `1` — Trusted. - `0` — Not trusted.' enum: - 0 - 1 example: 1 type: integer provider_id: description: The mail provider's identification number. example: 7 minimum: 1 type: integer type: object description: An object containing mail providers and their IP addresses. providers_failed: additionalProperties: description: 'The reason why the system failed to list IP addresses for the provider. **Note:** The return''s name is the mail provider''s display name.' type: string description: An object containing mail providers that the system failed to retrieve data for. type: object type: object metadata: properties: command: description: The method name called. example: cpgreylist_list_entries_for_common_mail_provider type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting IP addresses of mail providers tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_list_entries_for_common_mail_provider \\\n provider='cpanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_list_entries_for_common_mail_provider?api.version=1&provider=cpanel x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.52' /cpgreylist_load_common_mail_providers_config: get: description: This function returns Greylisting's list of common mail service providers. operationId: cPGreyList-cpgreylist_load_common_mail_providers_config parameters: [] responses: '200': content: application/json: schema: properties: data: properties: autotrust_new_common_mail_providers: description: 'Whether Greylisting automatically trusts new mail providers that WebPros International, LLC adds to the common mail providers list. * `1` - New mail providers are automatically trusted. * `0` - New mail providers are **not** automatically trusted.' enum: - 0 - 1 example: 1 type: integer common_mail_providers: additionalProperties: description: "An object containing the provider's data.\n\n**Note:**\n\n The object's name is the provider's key name." properties: autoupdate: description: 'Whether Greylisting automatically trusts new IP addresses that WebPros International, LLC adds for this mail provider. * `1` - New IP addresses are automatically trusted. * `0` - New IP addresses are **not** automatically trusted.' enum: - 0 - 1 example: 1 type: integer display_name: description: The mail provider's name. example: cPanel type: string is_trusted: description: 'Whether Greylisting trusts this mail provider''s IP addresses. * `1` - The provider is trusted. * `0` - The provider is **not** trusted.' enum: - 0 - 1 example: 1 type: integer type: object description: An object containing common mail provider settings. example: cpanel: autoupdate: 1 display_name: cPanel is_trusted: 1 sectigo: autoupdate: 1 display_name: Comodo/Sectigo is_trusted: 1 type: object metadata: properties: command: description: The method name called. example: cpgreylist_load_common_mail_providers_config type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object type: object description: HTTP Request was successful. summary: Return Greylisting mail providers tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_load_common_mail_providers_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_load_common_mail_providers_config?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.52' /cpgreylist_save_common_mail_providers_config: get: description: This function sets whether Greylisting trusts new entries to cPanel's common mail providers list. operationId: cPGreyList-cpgreylist_save_common_mail_providers_config parameters: - description: 'Whether Greylisting automatically trusts new mail providers that cPanel adds to the common mail providers list. * `1` — Automatically trust new mail providers cPanel adds to the common mail providers list. * `0` — Do **not** automatically trust new mail providers cPanel adds to the common mail providers list.' in: query name: autotrust_new_common_mail_providers required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: "Whether Greylisting automatically trusts new IP addresses that cPanel adds to this mail provider.\n\n* `1` — Automatically trust new IP addresses cPanel adds to this mail provider.\n* `0` — Do **not** automatically trust new IP addresses cPanel adds to this mail provider.\n\nIf you do not specify this parameter, the system will **not** change Greylisting settings for **any** existing provider.\n\n**Note:**\n\n The parameter's name is the provider's key name.\n Example key and value:\n * `google=0`" in: query name: PROVIDERKEY required: false schema: enum: - 0 - 1 example: 0 type: integer responses: '200': content: application/json: schema: properties: data: properties: autotrust_new_common_mail_providers: description: 'Whether Greylisting automatically trusts new mail providers that WebPros International, LLC adds to the common mail providers list. * `1` - New mail providers are automatically trusted. * `0` - New mail providers are **not** automatically trusted.' enum: - 0 - 1 example: 1 type: integer common_mail_providers: additionalProperties: description: "An object containing the provider's data.\n\n**Note:**\n\n The object's name is the provider's key name." properties: autoupdate: description: 'Whether Greylisting automatically trusts new IP addresses that WebPros International, LLC adds for this mail provider. * `1` - New IP addresses are automatically trusted. * `0` - New IP addresses are **not** automatically trusted.' enum: - 0 - 1 example: 1 type: integer display_name: description: The mail provider's name. example: cPanel type: string is_trusted: description: 'Whether Greylisting trusts this mail provider''s IP addresses. * `1` - The provider is trusted. * `0` - The provider is **not** trusted.' enum: - 0 - 1 example: 1 type: integer type: object description: An object containing common mail provider settings. example: cpanel: autoupdate: 1 display_name: cPanel is_trusted: 1 sectigo: autoupdate: 1 display_name: Comodo/Sectigo is_trusted: 1 type: object metadata: properties: command: description: The method name called. example: cpgreylist_load_common_mail_providers_config type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object type: object description: HTTP Request was successful. summary: Update Greylisting new mail provider handling tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_save_common_mail_providers_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_save_common_mail_providers_config?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.52' /cpgreylist_status: get: description: This function returns the status of Greylisting. operationId: cPGreyList-cpgreylist_status parameters: [] responses: '200': content: application/json: schema: properties: data: properties: is_enabled: description: 'Whether Greylisting is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer is_exim_enabled: description: 'Whether Exim is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer service: description: The name of the service. example: cPGreyList type: string type: object metadata: properties: command: description: The method name called. example: cpgreylist_status type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting status tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_status\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_status?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /cpgreylist_trust_entries_for_common_mail_provider: get: description: This function marks the IP addresses for the specified mail provider as trusted. Greylisting will not defer emails from trusted IP addresses. operationId: cPGreyList-cpgreylist_trust_entries_for_common_mail_provider parameters: - description: "The mail providers’ names.\n\nCall the `cpgreylist_load_common_mail_providers_config` API function\nto retrieve the system’s recognized provider names.\n\n**Note:**\n\n To trust multiple mail providers, increment the parameter name (for example: `provider-0`, `provider-1`, and `provider-2`)." examples: multiple: summary: Trust multiple mail providers. value: provider-1=cpanel&provider-2=google single: summary: Trust a single mail provider. value: cpanel in: query name: provider required: true schema: example: cpanel type: string responses: '200': content: application/json: schema: properties: data: properties: providers_failed: additionalProperties: description: 'The reason for the provider’s failure. **Note:** The property’s keys are the provider name.' example: This failed because it rained. type: string description: The providers whose configuration changes failed. type: object providers_trusted: additionalProperties: description: 'The providers whose configuration changes succeeded. **Note:** The property’s keys are the provider name.' properties: ips_trusted: description: The total number of the mail provider's IP addresses that Greylisting trusts. example: 21 minimum: 1 type: integer type: object description: The mail providers that Greylisting trusts. type: object type: object metadata: properties: command: description: The method name called. example: cpgreylist_trust_entries_for_common_mail_provider type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Add mail provider to Greylisting trusted hosts tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_trust_entries_for_common_mail_provider \\\n provider='cpanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_trust_entries_for_common_mail_provider?api.version=1&provider=cpanel x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.52' /cpgreylist_untrust_entries_for_common_mail_provider: get: description: 'This function marks the IP addresses for the specified mail provider as not trusted. Greylisting defers emails from non-trusted IP addresses.' operationId: cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider parameters: - description: "The mail provider.\n\n**Note:**\n\nTo trust multiple mail providers,\n increment the parameter name. For example, provider-0, provider-1, provider-2." examples: multiple: summary: Trust multiple mail providers value: provider-1=10 provider-2=33 provider-3=15 single: summary: Trust a single mail provider value: '1' in: query name: provider required: true schema: example: cpanel type: string responses: '200': content: application/json: schema: properties: data: properties: providers_failed: additionalProperties: description: The mail provider's data. properties: ips_untrusted: description: The mail providers that failed to update. example: 21 type: integer type: object x-additionalPropertiesName: provider_key type: object providers_untrusted: additionalProperties: description: The reason why the change for a provider failed. example: Unknown mail provider. type: string x-additionalPropertiesName: provider_key description: The mail providers that Greylisting does not trust. type: object metadata: properties: command: description: The method name called. example: cpgreylist_untrust_entries_for_common_mail_provider type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Add mail provider to Greylisting non-trusted hosts tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n cpgreylist_untrust_entries_for_common_mail_provider \\\n provider='1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_untrust_entries_for_common_mail_provider?api.version=1&provider=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.52' /create_cpgreylist_trusted_host: get: description: This function adds an IP address to the *Greylisting Trusted Hosts* list. operationId: cPGreyList-create_cpgreylist_trusted_host parameters: - description: 'The record''s IP address, or a range of IP addresses. **Note:** To add multiple IP addresses, increment the parameter name. For example, `ip-1`, `ip-2`, and `ip-3`.' examples: multiple: summary: To add multiple IP addresses. value: ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3 single: summary: To add a single IP address. value: 192.168.0.1 in: query name: ip required: true schema: example: 192.168.0.1 type: string - description: A comment. in: query name: comment required: false schema: example: NoComment maxLength: 255 type: string responses: '200': content: application/json: schema: properties: data: properties: comment: description: Comment for the batch. example: NoComment maxLength: 255 type: string ips_added: description: An array of objects that contains the IP addresses that the function added to the Trusted Hosts list. items: properties: comment: description: Comment for the individual record. example: Fascinating maxLength: 255 type: string create_time: description: The date and time at which the function created the record. example: '2015-02-17T10:08:26.000Z' format: ISO-8601 Date Time (Space Separated) type: string host_ip: description: The trusted host's IP address. example: 192.168.0.1 format: ipv4 type: string id: description: The host's record number. example: 42 minimum: 1 type: integer type: object type: array ips_failed: description: An object that contains the IP addresses that the function failed to add to the Trusted Hosts list. properties: comment: description: The reason for the failure. example: Sorry, 192.168 is not a valid IP address. type: string type: object type: object metadata: properties: command: description: The method name called. example: create_cpgreylist_trusted_host type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Add IP address to Greylisting trusted hosts tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n create_cpgreylist_trusted_host \\\n ip='192.168.0.1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/create_cpgreylist_trusted_host?api.version=1&ip=192.168.0.1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /delete_cpgreylist_trusted_host: get: description: This function deletes an IP address from the Greylisting _Trusted Hosts_ list. operationId: cPGreyList-delete_cpgreylist_trusted_host parameters: - description: 'The record''s IP address, or a range of IP addresses. **Note:** To add multiple IP addresses, increment the parameter name (for example, `ip-1`, `ip-2`, `ip-3`).' examples: cidr-ipv4: summary: CIDR Format IPv4 value: 192.168.0.1/16 cidr-ipv6: summary: CIDR Format IPv6 value: 2001:db8::/32 multiple: description: Multiple IP addresses. value: ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3 single: description: A single IP address. value: 192.168.0.1 single-ipv4: summary: Single IPv4 Address value: 192.0.2.0 single-ipv6: summary: Single IPv6 Address value: 2001:db8::1 in: query name: ip required: true schema: example: 192.168.0.1 type: string responses: '200': content: application/json: schema: properties: data: properties: ips_failed: additionalProperties: description: A failed IP address and the error message. type: string description: An object that contains the IP addresses that the function failed to remove from the _Trusted Hosts_ list. example: '5.5': 'Invalid IP address or range: “5.5”' type: object ips_removed: description: An array of IP addresses that the function removed from the _Trusted Hosts_ list. example: - 192.168.0.1 - 2001:db8::1 items: type: string type: array type: object metadata: properties: command: description: The method name called. example: delete_cpgreylist_trusted_host type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Remove IP address from Greylisting trusted hosts tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n delete_cpgreylist_trusted_host \\\n ip='192.168.0.1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/delete_cpgreylist_trusted_host?api.version=1&ip=192.168.0.1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /disable_cpgreylist: get: description: This function disables Greylisting. operationId: cPGreyList-disable_cpgreylist parameters: [] responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: disable_cpgreylist type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Disable Greylisting tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n disable_cpgreylist\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/disable_cpgreylist?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /enable_cpgreylist: get: description: This function enables Greylisting. operationId: cPGreyList-enable_cpgreylist parameters: [] responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: enable_cpgreylist type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Enable Greylisting tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n enable_cpgreylist\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/enable_cpgreylist?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /load_cpgreylist_config: get: description: This function returns Greylisting's current settings. operationId: cPGreyList-load_cpgreylist_config parameters: [] responses: '200': content: application/json: schema: properties: data: properties: cpgreylist_config: description: An object that contains Greylisting settings. properties: child_timeout_secs: description: The maximum amount of seconds that Greylisting waits for a child process to time out. example: 5 minimum: 1 type: integer initial_block_time_mins: description: The number of minutes during which Greylisting defers email from an unknown triplet. example: 10 maximum: 240 minimum: 1 type: integer is_enabled: description: 'Whether Greylisting is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer is_exim_enabled: description: 'Whether Exim is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer max_child_procs: description: The maximum amount of child processes. example: 5 minimum: 1 type: integer must_try_time_mins: description: The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. example: 240 maximum: 1440 minimum: 1 type: integer purge_interval_mins: description: The number of minutes before Greylisting deletes the records in the Greylisting database. example: 60 minimum: 1 type: integer record_exp_time_mins: description: The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet. example: 4320 maximum: 43200 minimum: 1 type: integer spf_bypass: description: 'Whether emails with SPF bypass Greylisting. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer type: object type: object metadata: properties: command: description: The method name called. example: load_cpgreylist_config type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting settings tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n load_cpgreylist_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/load_cpgreylist_config?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /read_cpgreylist_deferred_entries: get: description: 'This function lists Greylisting''s deferred triplets. Greylisting identifies incoming email by triplets. A triplet is a collection of three pieces of data: * the IP address * the sender''s address * the recipient''s address' operationId: cPGreyList-read_cpgreylist_deferred_entries parameters: [] responses: '200': content: application/json: schema: properties: data: properties: greylist_deferred_entries: description: An object of deferred triplet data. items: properties: accepted_count: description: The number of times that Greylisting accepted the triplet. example: 0 minimum: 0 type: integer block_exp_time: description: The date and time when Greylisting will no longer defer the triplet. example: '2015-03-23T12:09:32.000Z' format: ISO-8601 Date Time (Space Separated) type: string create_time: description: The date and time when Greylisting created the triplet. example: '2015-03-23T11:59:32.000Z' format: ISO-8601 Date Time (Space Separated) type: string deferred_count: description: The number of times Greylisting deferred the triplet. example: 1 minimum: 0 type: integer from_addr: description: The email address that the system identified as the triplet's sender. example: fromaddress1.com@example.com format: email type: string id: description: The identification number that the system assigned to the triplet. example: 45 minimum: 1 type: integer must_retry_by: description: The date and time when Greylisting will no longer accept the resent triplet. example: '2015-03-23T15:59:32.000Z' format: ISO-8601 Date Time (Space Separated) type: string record_exp_time: description: The date and time when Greylisting will purge the triplet from the database. example: '2015-03-26T11:59:32.000Z' format: ISO-8601 Date Time (Space Separated) type: string sender_ip: description: The IP address that the system identified as the triplet's sender. example: 97.215.255.29 format: ipv4 type: string to_addr: description: The email address that the system identified as the triplet's recipient. example: toaddress1.com@example.com format: email type: string type: object type: array limit: description: The number of triplets in the interface. example: 20 minimum: 0 type: integer offset: description: The number of triplets to skip from the beginning of the query in the interface. example: 20 minimum: 0 type: integer server_timezone: description: The standard letter code abbreviation for the time zone. example: CDT type: string server_tzoffset: description: The time zone offset in minutes. example: 60 minimum: 0 type: integer total_rows: description: The total number of triplets in the database. example: 3 minimum: 0 type: integer type: object metadata: properties: command: description: The method name called. example: read_cpgreylist_deferred_entries type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting deferred incoming email triplets tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n read_cpgreylist_deferred_entries\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/read_cpgreylist_deferred_entries?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /read_cpgreylist_trusted_hosts: get: description: This function retrieves the entries on the Greylisting Trusted Hosts list. operationId: cPGreyList-read_cpgreylist_trusted_hosts parameters: [] responses: '200': content: application/json: schema: properties: data: properties: greylist_trusted_hosts: description: An array of objects that contain identification information for the trusted hosts. items: properties: comment: description: The IP address' comment. example: Example maximum: 255 type: string create_time: description: The date and time when the system added the IP address to the _Trusted Hosts_ list. example: '2015-03-24T10:22:38.000Z' format: ISO-8601 Date Time (Space Separated) type: string host_ip: description: The IP address of the host that the system added to the _Trusted Hosts_ list. example: 192.0.2.0 format: ipv4 type: string id: description: The identification number that the system assigned to the IP address. example: 19 minimum: 1 type: integer type: object type: array type: object metadata: properties: command: description: The method name called. example: read_cpgreylist_trusted_hosts type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Greylisting trusted hosts tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n read_cpgreylist_trusted_hosts\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/read_cpgreylist_trusted_hosts?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' /save_cpgreylist_config: get: description: 'This function modifies the server''s Greylisting configuration settings. **Important:** When you call this function, you **must** include at least one of the following parameters: * `spf_bypass` * `child_timeout_secs` * `record_exp_time_mins` * `initial_block_time_mins` * `max_child_procs` * `purge_interval_mins` * `must_try_time_mins`' operationId: cPGreyList-save_cpgreylist_config parameters: - description: 'The maximum of seconds that Greylisting waits for a child process to timeout. **Note:** This parameter affects the function of the `cPGreyList` daemon. Do **not** change this value unless it is absolutely necessary.' in: query name: child_timeout_secs required: false schema: example: 5 minimum: 1 type: integer - description: The number of minutes during which Greylisting defers email from an unknown triplet. The maximum value for this parameter is four hours (`240` minutes). in: query name: initial_block_time_mins required: false schema: example: 10 maximum: 240 minimum: 1 type: integer - description: "The maximum number of child processes.\n\n**Notes:**\n\n This parameter affects the function of the `cPGreyList` daemon. Do **not** change this\n value unless it is absolutely necessary." in: query name: max_child_procs required: false schema: example: 5 minimum: 1 type: integer - description: The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. The maximum value for this parameter is one day (`1440` minutes). in: query name: must_try_time_mins required: false schema: example: 240 maximum: 1440 minimum: 1 type: integer - description: 'The number of minutes before Greylisting deletes the records in the Greylisting database. **Note:** This parameter affects the function of the `cPGreyList` daemon. Do **not** change this value unless it is absolutely necessary.' in: query name: purge_interval_mins required: false schema: example: 60 minimum: 1 type: integer - description: 'The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as coming from a new, unknown triplet. The maximum value for this parameter is 30 days (`43200` minutes).' in: query name: record_exp_time_mins required: false schema: example: 4320 maximum: 43200 minimum: 1 type: integer - description: 'Whether emails with SPF bypass Greylisting. * `1` — Enabled. * `0` — Disabled.' in: query name: spf_bypass required: false schema: enum: - 1 - 0 example: 1 type: integer responses: '200': content: application/json: schema: properties: data: properties: cpgreylist_config: description: A list of Greylisting settings. properties: child_timeout_secs: description: The maximum amount of seconds that Greylisting waits for child process to time out. example: 5 minimum: 1 type: integer initial_block_time_mins: description: The number of minutes during which Greylisting defers email from an unknown triplet. example: 10 maximum: 240 minimum: 1 type: integer is_enabled: description: 'Whether Greylisting is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 1 - 0 example: 1 type: integer is_exim_enabled: description: 'Whether Exim is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 1 - 0 example: 1 type: integer max_child_procs: description: The maximum amount of child processes. example: 5 minimum: 1 type: integer must_try_time_mins: description: The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. example: 240 maximum: 1440 minimum: 1 type: integer purge_interval_mins: description: The number of minutes before Greylisting deletes the records in the Greylisting database. example: 60 minimum: 1 type: integer record_exp_time_mins: description: The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet. example: 4320 maximum: 43200 minimum: 1 type: integer spf_bypass: description: 'Whether emails with SPF bypass Greylisting. * `1` — Bypass. * `0` — Do **not** bypass.' enum: - 1 - 0 example: 1 type: integer type: object type: object metadata: properties: command: description: The method name called. example: save_cpgreylist_config type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update Greylisting settings tags: - Greylisting x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n save_cpgreylist_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/save_cpgreylist_config?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.50' components: securitySchemes: BasicAuth: scheme: basic type: http externalDocs: url: https://cpanel.net/developers/ x-tagGroups: - name: Account Restoration tags: - Restore Account - Restore Queue Management - Restore Queue Reporting - name: Accounts tags: - Account Creation - Account Enhancements - Account Management - Bandwidth and Disk Quotas - Domain Information - Passwords - Styles - Suspensions - name: API Development Tools tags: - API Execution - API Statistics - API Token Management - Applications - Session - name: Authentication tags: - Authentication Providers - External Authentication - Login URL - SSH Keys and Connections - Two-Factor Authentication - name: Backups tags: - Backup Destination - Backup or Restore - Backup Settings - Legacy Migration - name: Commerce Integration tags: - Market Integration - Sitejet - name: cPanel Market tags: - Product Management - Provider Management - name: cPanel Support Tickets tags: - Support Access - Ticket Management - name: Customizations tags: - Brand - Customizations - name: Databases tags: - Manage MySQL Server - MySQL Databases - PostgreSQL Databases - Remote MySQL Databases - name: DNS tags: - DNS Cluster Settings - DNS Security - DNS Zones - Domain Management - Domain Management - Resolvers - Service Records - name: Hosting Plans tags: - Feature Access - Feature Lists - Hosting Plan Extensions - Hosting Plans - name: InProductSurvey tags: - InProductSurvey - name: Integrations tags: - API Authentication - Links - Scripts Hooks - name: IP Address Management tags: - IPv4 Address Settings - IPv6 Address Settings - Network Address Translation - name: Login Security (cPHulk) tags: - Management - Reporting - Settings - name: Logs tags: - Web Log Retention - name: Mail tags: - cPanel Account Mail Management - Mail DNS Settings - Mail Server Settings - Spam Management - Spam Protection (Greylisting) - name: Monitoring tags: - 360 Monitoring - name: NGINX Manager tags: - NGINX Manager - name: Resellers tags: - Account Enhancement Limit - Account Limits - Account Permissions - Account Settings - Reseller Account Management - name: Security tags: - WHM Access - name: Server Administration tags: - Configuration Clusters - Configurations - Connected Applications - Connections - cPanel Analytics - License Management - Notifications - Plugin-Based Features - Security - Server Nodes - Server Profiles - Services - System Information - Updates - name: SSL Certificates tags: - Auto-Generated Certificates - cPanel Account Settings - SSL Server Settings - name: System Package Management tags: - Install or Uninstall Package - List Package Information - Package Manager Settings - name: Transfers tags: - cPanel Account Transfer - Transfer Configuration - Transfer Monitoring - name: UserData tags: - UserData - name: Web Server Configuration tags: - EasyApache Settings - PHP - PHP-FPM - name: Web Server Security (ModSecurity) tags: - Rule Settings - Rule Vendor Settings - Server Settings