Create Node

This method will create a new lightweight node. You must provide a username and passrphase that will be used to log into the node's administration panel.

The method will return the nodes pubkey and macaroon. This information is required to interact with the node in the future.

Endpoint

POST /v1/nodes

Authentication

You must authenticate using the admin node's macaroon.

Request Parameters


ParamTypeDescription
usernameStringUsed for logging into the web administration panel
passphraseStringUsed to encrypt seed information on disk and as your password for logging into the web administration panel
aliasStringThe name of your node that will be broadcast to the lightning network
startBooleanWhether or not to also unlock and start your node upon successful init

Response Parameters


ParamTypeDescription
pubkeyStringThe node's public key. This is often described as the node's id
macaroonStringHex encoded admin.macaroon file