---
title: "Return login security list records"
method: GET
path: "/read_cphulk_records"
tags: ["cPHulk", "Management"]
---

# Return login security list records

`GET /read_cphulk_records`

This function displays a cPHulk list's records.

## Query parameters

- `list_name` 'black' | 'white', required
- `skip_enabled_check` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `ips_in_list` object — IP address information.
    - `list_name` 'black' | 'white' — The cPHulk list's name. * `black` * `white`
    - `requester_ip` union — The requester's IP address.
      - string, ipv4
      - string, ipv6
    - `requester_ip_is_whitelisted` 0 | 1 — Whether the requester's IP address exists on cPHulk's whitelist. * `1` - The IP address exists on the whitelist. * `0` - The IP address does not exist on the white list.
    - `restart_ssh` 0 | 1 — Whether you must restart `sshd` in order to implement changes. * `1` — You **must** restart the `sshd` daemon. * `0` — The system will implement changes without a restart. **Note:** This return **only** appears if `sshd`’s `UseDNS` setting is enabled. Because `UseDNS` and cPHulk are incompatible, the system disables `UseDNS` when you enable cPHulk. * `1` - You must restart `sshd`. * `0` - The system will implement changes without a restart.
    - `warning_ip` string — A localized warning message, if the requester's IP address does not exist on the whitelist.
    - `warning_ssh` string — A message that explains why you must restart `sshd`. **Note:** This return **only** appears if the `restart_ssh` return's value is `1`.
  - `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)