mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-22 06:41:44 +01:00
81 lines
2.1 KiB
JSON
81 lines
2.1 KiB
JSON
|
{
|
||
|
|
"$schema": "../rpc-schema-draft.json",
|
||
|
|
"type": "object",
|
||
|
|
"additionalProperties": false,
|
||
|
|
"rpc": "disconnect",
|
||
|
|
"title": "Command for disconnecting from another lightning node",
|
||
|
|
"description": [
|
||
|
|
"The disconnect RPC command closes an existing connection to a peer, identified by *id*, in the Lightning Network, as long as it doesn't have an active channel."
|
||
|
|
],
|
||
|
|
"request": {
|
||
|
|
"required": [
|
||
|
|
"id"
|
||
|
|
],
|
||
|
|
"properties": {
|
||
|
|
"id": {
|
||
|
|
"type": "pubkey",
|
||
|
|
"description": [
|
||
|
|
"The public key of the peer to terminate the connection. It can be discovered in the output of the listpeers command, which returns a set of peers:",
|
||
|
|
"{",
|
||
|
|
" 'peers':",
|
||
|
|
" [",
|
||
|
|
" {",
|
||
|
|
" 'id': '0563aea81...',",
|
||
|
|
" 'connected': true,",
|
||
|
|
" ...",
|
||
|
|
" }",
|
||
|
|
" ]",
|
||
|
|
"}"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"force": {
|
||
|
|
"type": "boolean",
|
||
|
|
"description": [
|
||
|
|
"If set to True, it will disconnect even with an active channel."
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"properties": {}
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
],
|
||
|
|
"example_json_request": [
|
||
|
|
{
|
||
|
|
"id": "example:disconnect#1",
|
||
|
|
"method": "disconnect",
|
||
|
|
"params": {
|
||
|
|
"id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518",
|
||
|
|
"force": false
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "example:disconnect#2",
|
||
|
|
"method": "disconnect",
|
||
|
|
"params": {
|
||
|
|
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
|
||
|
|
"force": true
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"example_json_response": [
|
||
|
|
{},
|
||
|
|
{}
|
||
|
|
],
|
||
|
|
"author": [
|
||
|
|
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
|
||
|
|
],
|
||
|
|
"see_also": [
|
||
|
|
"lightning-connect(1)",
|
||
|
|
"lightning-listpeers(1)"
|
||
|
|
],
|
||
|
|
"resources": [
|
||
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
||
|
|
]
|
||
|
|
}
|