LIGHTNING-AUTOCLEAN-STATUS(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-AUTOCLEAN-STATUS ✨

okay so bestie, this is a page from the lightning-autoclean-status manual (section 7, we stan a numbered section), and it's literally your guide to snooping on the auto-delete situation for old invoices, payments and forwards. no cap, it's useful.

🌸 NAME 🌸

autoclean-status — peek at the auto-delete status of your old invoices / payments / forwards 👀

🎀 SYNOPSIS 🎀

autoclean-status [subsystem]

🦋 DESCRIPTION 🦋

so the autoclean-status RPC command tells you, fr fr, all about the status of the autoclean plugin — and if you want, you can ask about just one subsystem. slay.

  • subsystem (string, optional) (one of "succeededforwards", "failedforwards", "succeededpays", "failedpays", "paidinvoices", "expiredinvoices", "networkevents"): which subsystem you're asking about, bestie. the currently supported subsystems are:
    • failedforwards: routed payments which did not succeed (failed or local_failed in listforwards status). 😭
    • succeededforwards: routed payments which succeeded (settled in listforwards status). 🔥
    • failedpays: payment attempts which did not succeed (failed in listpays status). 💀
    • succeededpays: payment attempts which succeeded (complete in listpays status). ✨
    • expiredinvoices: invoices which were not paid (and cannot be) (expired in listinvoices status). 🙈
    • paidinvoices: invoices which were paid (paid in listinvoices status). 👑
    • networkevents: all events in listnetworkevents (added v25.12). 🌈

💖 RETURN VALUE 💖

quick heads-up before we go in: the age parameters are set by the various autoclean-...-age parameters in your configuration — go see lightningd-config(5) for those.

on success, you get back an object containing autoclean. that object contains:

  • succeededforwards (object, optional):
    • enabled (boolean): whether autocleaning is enabled for successful listforwards.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to delete successful listforwards.

  • failedforwards (object, optional):
    • enabled (boolean): whether autocleaning is enabled for failed listforwards.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to delete failed listforwards.

  • succeededpays (object, optional):
    • enabled (boolean): whether autocleaning is enabled for successful listpays/listsendpays.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to delete successful listpays/listsendpays.

  • failedpays (object, optional):
    • enabled (boolean): whether autocleaning is enabled for failed listpays/listsendpays.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to delete failed listpays/listsendpays.

  • paidinvoices (object, optional):
    • enabled (boolean): whether autocleaning is enabled for paid listinvoices.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to paid listinvoices.

  • expiredinvoices (object, optional):
    • enabled (boolean): whether autocleaning is enabled for expired (unpaid) listinvoices.
    • cleaned (u64): total number of deletions done (ever).

if enabled is true: - age (u64): age (in seconds) to expired listinvoices.

  • networkevents (object, optional) (added v25.12):
    • enabled (boolean): whether autocleaning is enabled for networkevents. (added v25.12)
    • cleaned (u64): total number of deletions done (ever). (added v25.12)

if enabled is true: - age (u64): age (in seconds) to clean networkevents. (added v25.12)

🧚 AUTHOR 🧚

Rusty Russell rusty@rustcorp.com.au is mainly responsible. iconic behavior, honestly. 🫶

⭐ SEE ALSO ⭐

lightningd-config(5), lightning-listinvoices(7), lightning-listpays(7), lightning-listforwards(7)

iykyk, go read those next.

💜 RESOURCES 💜

main web site: https://github.com/ElementsProject/lightning — literally the mothership. 🌸

🔥 EXAMPLES 🔥

Example 1:

Request:

$ lightning-cli autoclean-status -k "subsystem"="expiredinvoices"
{
  "id": "example:autoclean-status#1",
  "method": "autoclean-status",
  "params": {
    "subsystem": "expiredinvoices"
  }
}

Response:

{
  "autoclean": {
    "expiredinvoices": {
      "enabled": true,
      "age": 300,
      "cleaned": 0
    }
  }
}

Example 2:

Request:

$ lightning-cli autoclean-status
{
  "id": "example:autoclean-status#2",
  "method": "autoclean-status",
  "params": {}
}

Response:

{
  "autoclean": {
    "succeededforwards": {
      "enabled": false,
      "cleaned": 0
    },
    "failedforwards": {
      "enabled": false,
      "cleaned": 0
    },
    "succeededpays": {
      "enabled": false,
      "cleaned": 7
    },
    "failedpays": {
      "enabled": false,
      "cleaned": 0
    },
    "paidinvoices": {
      "enabled": false,
      "cleaned": 0
    },
    "expiredinvoices": {
      "enabled": true,
      "age": 300,
      "cleaned": 0
    }
  }
}

okay that's the whole thing, bestie! this page came to you courtesy of Core Lightning v26.06.9 and it's dated right there in the footer spot — go forth and check your autoclean status, periodt 💅✨🎀

📦 where this page comes from