core-lightning/doc/schemas/lightning-delforward.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "rpc": "delforward",
  "title": "Command for removing a forwarding entry",
  "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."
  ],
  "request": {
    "required": [
      "in_channel",
      "in_htlc_id",
      "status"
    ],
    "additionalProperties": false,
    "properties": {
      "in_channel": {
        "type": "short_channel_id",
        "description": [
          "Only the matching forwards on the given inbound channel are deleted. Note: for **listforwards** entries without an *in_htlc_id* entry (no longer created in v22.11, but can exist from older versions), a value of 18446744073709551615 can be used, but then it will delete *all* entries without *in_htlc_id* for this *in_channel* and *status*."
        ]
      },
      "in_htlc_id": {
        "type": "u64",
        "description": [
          "The unique HTLC id the sender gave this (not present if incoming channel was closed before upgrade to v22.11)."
        ]
      },
      "status": {
        "type": "string",
        "description": [
          "The status of the forward to delete. You cannot delete forwards which have status *offered* (i.e. are currently active)."
        ],
        "enum": [
          "settled",
          "local_failed",
          "failed"
        ]
      }
    }
  },
  "response": {
    "required": [],
    "additionalProperties": false,
    "properties": {}
  },
  "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>"
  ],
  "examples": [
    {
      "request": {
        "id": "example:delforward#1",
        "method": "delforward",
        "params": {
          "in_channel": "109x1x1",
          "in_htlc_id": 4,
          "status": "local_failed"
        }
      },
      "response": {}
    },
    {
      "request": {
        "id": "example:delforward#2",
        "method": "delforward",
        "params": [
          "109x1x1",
          19,
          "failed"
        ]
      },
      "response": {}
    }
  ]
}