core-lightning/doc/lightning-delforward.7.md
Rusty Russell 3079afb024 lightningd: add delforward command.
Changelog-Added: JSON-RPC: `delforward` command to delete listforwards entries.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-22 15:19:46 +02:00

53 lines
1.2 KiB
Markdown

lightning-delforward -- Command for removing a forwarding entry
===============================================================
SYNOPSIS
--------
**delforward** *in_channel* *in_htlc_id* *status*
DESCRIPTION
-----------
The **delforward** RPC command removes a single forward from **listforwards**,
using the uniquely-identifying *in_channel* and *in_htlc_id* (and, as a sanity
check, the *status*) given by that command.
This command is mainly used by the *autoclean* plugin (see lightningd-config(7)),
As these database entries are only kept for your own analysis, removing them
has no effect on the running of your node.
You cannot delete forwards which have status *offered* (i.e. are
currently active).
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
ERRORS
------
The following errors may be reported:
- 1401: The forward specified does not exist.
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-autoclean(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:200de829c6635242cb2dd8ec0650c2fa8f5fcbf413f4a704884516df80492fcb)