POST

Lightning - Unlock node

This is only used for self-custody lightning. Unlock the Lightning Network Daemon (LND) node with the given wallet password.

Path Params

coin string required

A lightning coin name.
walletId string required

The wallet ID.

matches ^[0-9a-f]{32}$

Body Params

object

passphrase string

Passphrase to decrypt the unlock the node.

Responses

200

Response Body

object

message string

400

Bad Request

Response Body

ONE OF

error string required

Human-readable error message
requestId string required

Client request id
context object

Properties that apply to a specific error name
name string required

Error code

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidWalletId

curl --request POST \ --url 'http://localhost:3080/api/v2/coin/wallet/walletId/unlockwallet' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"passphrase":"string"}'

const url = 'http://localhost:3080/api/v2/coin/wallet/walletId/unlockwallet'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"passphrase":"string"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("http://localhost:3080/api/v2/coin/wallet/walletId/unlockwallet") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"passphrase":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'http://localhost:3080/api/v2/coin/wallet/walletId/unlockwallet', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"passphrase":"string"}', ]); echo $response->getBody();

import requests url = "http://localhost:3080/api/v2/coin/wallet/walletId/unlockwallet" payload = {,"passphrase":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)