home | help 
LIGHTNING-AUTOCLEAN-STATUS(7)			   LIGHTNING-AUTOCLEAN-STATUS(7)

NAME
     autoclean-status -- Examine auto-delete of old invoices/payments/forwards

SYNOPSIS
     autoclean-status [subsystem]

DESCRIPTION
     The  autoclean-status  RPC  command tells you about the status of the auto-
     clean plugin, optionally for only one subsystem.

     *	subsystem (string, optional) (one  of  "succeededforwards",  "failedfor-
	wards",   "succeededpays",   "failedpays",  "paidinvoices",  "expiredin-
	voices", "networkevents"): What subsystem to ask about.  Currently  sup-
	ported subsystems are:
	*  failedforwards:  routed payments which did not succeed (failed or lo-
	   cal_failed in listforwards status).
	*  succeededforwards: routed payments which succeeded (settled in  list-
	   forwards status).
	*  failedpays:	payment  attempts which did not succeed (failed in list-
	   pays status).
	*  succeededpays: payment attempts which succeeded (complete in listpays
	   status).
	*  expiredinvoices: invoices which were not paid (and  cannot  be)  (ex-
	   pired in listinvoices status).
	*  paidinvoices:  invoices  which  were paid (paid in listinvoices `sta-
	   tus).
	*  `networkevents: all events in listnetworkevents (added v25.12)

RETURN VALUE
     Note that the ages parameters are set by various autoclean-...-age  parame-
     ters  in  your configuration: see lightningd-config(5).  On success, an ob-
     ject containing autoclean is returned. It is an object containing:

     *	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  list-
	   forwards.
	*  cleaned (u64): Total number of deletions done (ever).

	If enabled is true: - age (u64): Age (in seconds) to delete failed list-
	forwards.
     *	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 list-
	   pays/listsendpays.
	*  cleaned (u64): Total number of deletions done (ever).

	If enabled is true: - age (u64): Age (in seconds) to delete failed list-
	pays/listsendpays.
     *	paidinvoices (object, optional):
	*  enabled (boolean): Whether autocleaning is enabled for  paid  listin-
	   voices.
	*  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 (un-
	   paid) listinvoices.
	*  cleaned (u64): Total number of deletions done (ever).

	If enabled is true: - age (u64): Age (in  seconds)  to	expired  listin-
	voices.
     *	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 net-
	workevents. (added v25.12)

AUTHOR
     Rusty Russell rusty@rustcorp.com.au is mainly responsible.

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

RESOURCES
     Main web site: https://github.com/ElementsProject/lightning

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
	 }
       }
     }

Core Lightning v26.06.1 			   LIGHTNING-AUTOCLEAN-STATUS(7)
home | help