xrpl-dev-portal/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md

html, parent, seo, labels

html	parent	seo	labels
ledger_cleaner.html	logging-and-data-management-methods.html	description Configure the ledger cleaner service to check for corrupted data.	Data Retention

ledger_cleaner

[Source]

The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers.

The ledger_cleaner method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

{% tabs %}

{% tab label="WebSocket" %}

{
    "command": "ledger_cleaner",
    "max_ledger": 13818756,
    "min_ledger": 13818000,
    "stop": false
}

{% /tab %}

{% /tabs %}

The request includes the following parameters:

Field	Type	Description
ledger	Number - [Ledger Index][]	(Optional) If provided, check and correct the specified ledger only.
max_ledger	Number - [Ledger Index][]	(Optional) Configure the ledger cleaner to check ledgers with ledger indexes equal or lower than this.
min_ledger	Number - [Ledger Index][]	(Optional) Configure the ledger cleaner to check ledgers with ledger indexes equal or higher than this.
full	Boolean	(Optional) If true, fix ledger state objects and transactions in the specified ledger(s). Defaults to false. Automatically set to true if ledger is provided.
fix_txns	Boolean	(Optional) If true, correct transaction in the specified ledger(s). Overrides full if provided.
check_nodes	Boolean	(Optional) If true, correct ledger state objects in the specified ledger(s). Overrides full if provided.
stop	Boolean	(Optional) If true, disable the ledger cleaner.

Response Format

An example of a successful response:

{% tabs %}

{% tab label="JSON-RPC" %}

200 OK

{
   "result" : {
      "message" : "Cleaner configured",
      "status" : "success"
   }
}

{% /tab %}

{% /tabs %}

The response follows the [standard format][], with a successful result containing the following fields:

Field	Type	Description
message	String	Cleaner configured on success.

Possible Errors

• Any of the [universal error types][].
• internal if one the parameters is specified incorrectly. (This is a bug; the intended error code is invalidParams.)

{% raw-partial file="/docs/_snippets/common-links.md" /%}