home | help
LIGHTNING-DISCONNECT(7) 				 LIGHTNING-DISCONNECT(7)

NAME
     disconnect -- Command for disconnecting from another lightning node

SYNOPSIS
     disconnect id [force]

DESCRIPTION
     The disconnect RPC command closes an existing connection to a peer, identi-
     fied  by id, in the Lightning Network, as long as it doesn't have an active
     channel.

     *	id (pubkey): The public key of the peer to terminate the connection.  It
	can  be discovered as peer_id in the output of the listpeerchannels com-
	mand.
     *	force (boolean, optional): If set to True, it will disconnect even  with
	an active channel.

RETURN VALUE
     On success, an empty object is returned.

ERRORS
     On error the returned object will contain code and message properties, with
     code being one of the following:

     *	-32602: If the given parameters are wrong.
     *	-1: Catchall nonspecific error.

AUTHOR
     Michael Hawkins michael.hawkins@protonmail.com.

SEE ALSO
     lightning-connect(7), lightning-listpeerchannels(7)

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

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli disconnect -k "id"="nodeid040404040404040404040404040404040404040404040404040404040404" "force"=False

     {
       "id": "example:disconnect#1",
       "method": "disconnect",
       "params": {
	 "id": "nodeid040404040404040404040404040404040404040404040404040404040404",
	 "force": false
       }
     }

     Response:

     {}

     Example 2:

     Request:

     $ lightning-cli disconnect -k "id"="nodeid050505050505050505050505050505050505050505050505050505050505" "force"=True

     {
       "id": "example:disconnect#2",
       "method": "disconnect",
       "params": {
	 "id": "nodeid050505050505050505050505050505050505050505050505050505050505",
	 "force": true
       }
     }

     Response:

     {}

Core Lightning v26.06.1 				 LIGHTNING-DISCONNECT(7)

home | help