---
title: "Retrieve cPanel account's log archival settings"
method: GET
path: "/LogManager/get_settings"
tags: ["LogManager", "Logs"]
---

# Retrieve cPanel account's log archival settings

`GET /LogManager/get_settings`

This function retrieves the account's log archival settings.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `archive_logs` 1 | 0 — Whether the system archives log files to your home directory. * `1` — Archives the logs. * `0` — Does **not** archive the logs.
      - `prune_archive` 1 | 0 — Whether the system removes the previous month's archived log files from your home directory. * `1` — Removes the logs. * `0` — Does **not** remove the logs.
      - `retention_days` integer — The number of days the system retains archived log files before automatic removal. A value of `0` means the system retains logs indefinitely. When the user has not set a custom value, this returns the server-wide default.
      - `using_default` 1 | 0 — Whether the user uses the server-wide default retention period. * `1` — Uses the server default. * `0` — Uses a custom retention value.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/versions/632e2f8e6d04/schema)