Initialize Lightning Activation Task
API-v2task::enable_lightning::init
The task::enable_lightning::init method requests a task to run a Lightning node. Use the returned task_id as an input to check the status of the Lightning node (i.e., running or still initiating). An error will be returned if a Lightning node was already running for the requested ticker.
Any methods with a task:: prefix will be linked to a numeric task_id value, which is used to query the status or outcome of the task.
| Parameter | Type | Required | Description |
|---|---|---|---|
| activation_params | object | ✓ | A standard LightningActivationParams object. |
| ticker | string | ✓ | Ticker of coin to activate. |
| Parameter | Type | Description |
|---|---|---|
| task_id | integer | An identifying number which is used to query task status. |
task::enable_lightning::init
POST
task::enable_lightning::init{
"method": "task::enable_lightning::init",
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"params": {
"ticker": "tBTC-lightning",
"activation_params": {
"name": "KomoDeFi-Docs-Node-1",
"listening_port": 9735,
"color": "000000",
"payment_retries": 5
}
},
"id": 2
}