---
title: "Return Greylisting settings"
method: GET
path: "/load_cpgreylist_config"
tags: ["Greylisting", "Spam Protection (Greylisting)"]
---

# Return Greylisting settings

`GET /load_cpgreylist_config`

This function returns Greylisting's current settings.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `cpgreylist_config` object — An object that contains Greylisting settings.
      - `child_timeout_secs` integer — The maximum amount of seconds that Greylisting waits for a child process to time out.
      - `initial_block_time_mins` integer — The number of minutes during which Greylisting defers email from an unknown triplet.
      - `is_enabled` 0 | 1 — Whether Greylisting is enabled. * `1` — Enabled. * `0` — Disabled.
      - `is_exim_enabled` 0 | 1 — Whether Exim is enabled. * `1` — Enabled. * `0` — Disabled.
      - `max_child_procs` integer — The maximum amount of child processes.
      - `must_try_time_mins` integer — The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet.
      - `purge_interval_mins` integer — The number of minutes before Greylisting deletes the records in the Greylisting database.
      - `record_exp_time_mins` integer — The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet.
      - `spf_bypass` 0 | 1 — Whether emails with SPF bypass Greylisting. * `1` — Enabled. * `0` — Disabled.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)