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

# Return Greylisting status

`GET /cpgreylist_status`

This function returns the status of Greylisting.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `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.
    - `service` string — The name of the service.
  - `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)