---
title: "List accounts' web log retention settings"
method: GET
path: "/list_accounts_retention"
tags: ["Web Log Retention", "Logs"]
---

# List accounts' web log retention settings

`GET /list_accounts_retention`

List each cPanel account's web server log retention preference alongside the server default.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `default_retention` integer — The server-wide default web log retention period, in days, from Tweak Settings. A value of 0 means logs are retained indefinitely.
    - `accounts` object[] — A list of cPanel accounts and their web log retention preferences.
      - `user` string — The cPanel account username.
      - `domain` string — The account's primary domain.
      - `retention_days` integer, nullable — The account's custom web log retention period, in days. Null when the account uses the server default.
      - `using_default` boolean — Whether the account uses the server-wide default retention setting. * `true` — Uses the server default. * `false` — Uses a custom retention value.
  - `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)