diff --git a/docs/slate/index.html.md b/docs/slate/index.html.md index 5a9831ffd..b507dbd44 100644 --- a/docs/slate/index.html.md +++ b/docs/slate/index.html.md @@ -37,7 +37,7 @@ The rest of this document will use '21satoshi' as password which encoded as bas6 ## GetInfo ```shell -curl -X POST "http://localhost:8080/getinfo" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -X POST "http://localhost:8080/getinfo" -u : # with eclair-cli eclair-cli getinfo @@ -69,7 +69,7 @@ Returns information about this instance such as **nodeId** and current block hei ## Connect via URI ```shell -curl -X POST -F uri= "http://localhost:8080/connect" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -X POST -F uri= "http://localhost:8080/connect" -u : # with eclair-cli eclair-cli connect --uri= @@ -97,7 +97,7 @@ uri | The URI in format 'nodeId@host:port' | No | String ## Connect manually ```shell -curl -X POST -F nodeId= -F host= -F port= "http://localhost:8080/connect" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -X POST -F nodeId= -F host= -F port= "http://localhost:8080/connect" -u : # with eclair-cli eclair-cli connect --nodeId= --host= --port= @@ -129,7 +129,7 @@ port | The port of the node | No | Integer ```shell curl -X POST -F nodeId= -F fundingSatoshis= \ - "http://localhost:8080/open" -H "Authorization: OjIxc2F0b3NoaQ==" + "http://localhost:8080/open" -u : #with eclair-cli eclair-cli open --nodeId= --fundingSatoshis= @@ -163,7 +163,7 @@ channelFlags | Flags for the new channel: 0 = private, 1 = public | Yes | Intege ## Close ```shell -curl -X POST -F channelId= "http://localhost:8080/close" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F channelId= "http://localhost:8080/close" #with eclair-cli eclair-cli close --channelId= @@ -193,7 +193,7 @@ scriptPubKey | A serialized scriptPubKey that you want to use to close the chann ## Force Close ```shell -curl -X POST -F channelId= "http://localhost:8080/forceclose" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F channelId= "http://localhost:8080/forceclose" #with eclair-cli eclair-cli forceclose --channelId= @@ -224,8 +224,9 @@ shortChannelId | The shortChannelId of the channel you want to close | Yes | Sho ## updaterelayfee ```shell -curl -X POST -F channelId= -F feeBaseMsat= -F feeProportionalMillionths= \ - "http://localhost:8080/updaterelayfee" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F channelId= \ + -F feeBaseMsat= -F feeProportionalMillionths= \ + "http://localhost:8080/updaterelayfee" #eclair-cli eclair-cli updaterelayfee \ @@ -259,7 +260,7 @@ feeProportionalMillionths | The new proportional fee to use | No | Integer ## peers ```shell -curl -X POST "http://localhost:8080/peers" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/peers" #with eclair-cli eclair-cli peers @@ -294,7 +295,7 @@ Returns the list of currently known peers, both connected and disconnected. ## channels ```shell -curl -X POST "http://localhost:8080/channels" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/channels" #with eclair-cli eclair-cli channels @@ -441,7 +442,7 @@ toRemoteNodeId | The remote node id to be used as filter for the channels | Yes ## channel ```shell -curl -X POST -F channelId= "http://localhost:8080/channel" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F channelId= "http://localhost:8080/channel" #with eclair-cli eclair-cli channel --channelId= @@ -591,7 +592,7 @@ A set of API to query the network view of eclair. ## allnodes ```shell -curl -X POST "http://localhost:8080/allnodes" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/allnodes" #with eclair-cli eclair-cli allnodes @@ -632,7 +633,7 @@ Returns information about all public nodes on the lightning network, this inform ## allchannels ```shell -curl -X POST "http://localhost:8080/allchannels" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/allchannels" #with eclair-cli eclair-cli allchannels @@ -660,7 +661,7 @@ Returns non detailed information about all public channels in the network. ## allupdates ```shell -curl -X POST "http://localhost:8080/allupdates" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/allupdates" #with eclair-cli eclair-cli allupdates @@ -723,8 +724,8 @@ Interfaces for sending and receiving payments through eclair. ## receive ```shell -curl -X POST -F description= -F amountMsat= \ - "http://localhost:8080/receive" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F description= \ + -F amountMsat= "http://localhost:8080/receive" #with eclair-cli eclair-cli receive --description= --amountMsat= @@ -753,7 +754,7 @@ expireIn | Number of seconds that the invoice will be valid | Yes | Seconds (int ## send ```shell -curl -X POST -F invoice= "http://localhost:8080/send" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F invoice= "http://localhost:8080/send" ``` > The above command returns: @@ -817,7 +818,7 @@ amountMsat | Amount in to pay if the invoice does not have one | Yes | Millisato ## sendToNode ```shell -curl -X POST -F nodeId= -F amountMsat= -F paymentHash= "http://localhost:8080/sendtonode" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F nodeId= -F amountMsat= -F paymentHash= "http://localhost:8080/sendtonode" ``` > The above command returns: @@ -882,7 +883,7 @@ paymentHash | The payment hash for this payment | No | 32bytes-HexString (String ## checkpayment ```shell -curl -X POST -F paymentHash= "http://localhost:8080/checkpayment" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F paymentHash= "http://localhost:8080/checkpayment" #with eclair-cli eclair-cli checkpayment --paymentHash= @@ -908,7 +909,7 @@ paymentHash | The payment hash you want to check | No | 32bytes-HexString (Strin ## parseinvoice ```shell -curl -X POST -F invoice= "http://localhost:8080/parseinvoice" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F invoice= "http://localhost:8080/parseinvoice" #with eclair-cli eclair-cli parseinvoice --invoice= @@ -945,7 +946,7 @@ invoice | The invoice you want to decode | No | String ## findroute ```shell -curl -X POST -F invoice= "http://localhost:8080/findroute" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F invoice= "http://localhost:8080/findroute" #with eclair-cli eclair-cli findroute --invoice= @@ -976,8 +977,8 @@ amountMsat | The amount that should go through the route | Yes | Millisatoshi (I ## findrouteToNode ```shell -curl -X POST -F nodeId= -F amountMsat= \ - "http://localhost:8080/findroutetonode" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST -F nodeId= \ + -F amountMsat= "http://localhost:8080/findroutetonode" #with eclair-cli eclair-cli --nodeId= --amountMsat= @@ -1010,7 +1011,7 @@ amountMsat | The amount that should go through the route | No | Millisatoshi (In ## audit ```shell -curl -X POST "http://localhost:8080/audit" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/audit" #with eclair-cli eclair-cli audit @@ -1066,7 +1067,7 @@ to | Filters elements no younger than this unix-timestamp | Yes | Unix timestam ## networkfees ```shell -curl -X POST "http://localhost:8080/networkfees" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/networkfees" #with eclair-cli eclair-cli networkfees @@ -1102,7 +1103,7 @@ to | Filters elements no younger than this unix-timestamp | Yes | Unix timestam ## channelstats ```shell -curl -X POST "http://localhost:8080/channelstats" -H "Authorization: OjIxc2F0b3NoaQ==" +curl -u : -X POST "http://localhost:8080/channelstats" #with eclair-cli eclair-cli channelstats