Voltage API

10min
Voltage has an API that you can use to manage your nodes. With this API you can create, stop, start, update your node. All the functionality that you see in our dashboard can be accomplished with the Voltage API. With our API, you can greatly extend the capabilities for the Voltage platform. For example, you can create nodes for your users directly in your own sites.
Base URL
https://api.voltage.cloud
﻿
Currently you must use HTTP 1.1 with this API. It does not suport HTTP 2.0
Authentication
To generate an API Key, navigate to your Team's home page. The menu on the left side will have an 'API' section. Expand that and click 'Keys'. Click the 'New Key' button and generate a new API Key. Give it a name and be sure to save the key as it will not be displayed again.
Once you have an API Key, you can use it in your API Requests with the X-VOLTAGE-AUTH header. All API Endpoints require authentication.
Endpoints
Get a list of nodes owned by an organization.
GET
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that you want to list nodes for. 
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"

response = https.request(request)
puts response.read_body
Responses
200
404
{
   "nodes": [
     {
       "node_name": "myvoltagenode",
       "status": "running",
       "node_id": "555c5108-7438-488d-b227-5f80baf8a23aN",
       "expires": "never",
       "created": "2024-01-08T00:49:55Z",
       "type": "standard",
       "purchased_type": "paid",
       "purchase_status": "active",
       "api_endpoint": "myvoltagenode.m.voltageapp.io",
       "network": "mainnet",
       "lnd_version": "0.17.4-beta",
       "volt_version": "v0.5.0",
       "update_available": false
     },
     ...
   ]
}
{
   "nodes": [
     {
       "node_name": "myvoltagenode",
       "status": "running",
       "node_id": "555c5108-7438-488d-b227-5f80baf8a23aN",
       "expires": "never",
       "created": "2024-01-08T00:49:55Z",
       "type": "standard",
       "purchased_type": "paid",
       "purchase_status": "active",
       "api_endpoint": "myvoltagenode.m.voltageapp.io",
       "network": "mainnet",
       "lnd_version": "0.17.4-beta",
       "volt_version": "v0.5.0",
       "update_available": false
     },
     ...
   ]
}
﻿
Get information about a specific node.
GET
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that owns the node. 
node_id
required
String
The Voltage ID of the node that you want to get information for. 
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
curl --location --globoff 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VOLTAGE-AUTH: {voltage_api_key}'
curl --location --globoff 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VOLTAGE-AUTH: {voltage_api_key}'
Responses
200
404
{
  "message": "not found"
}
{
  "message": "not found"
}
﻿
Create a new Lightning node.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that owns the node. 
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Body Parameters
name
required
String
User defined node name given at creation
network
required
String
Network the node is running on. Can be either 'testnet' or 'mainnet'.
type
required
String
Type of node, either 'standard' or 'professional'
settings
required
Object
Settings for the Lightning Node
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "name": "node-name",
   "network": "mainnet",
   "type": "standard",
   "settings": {
     "autopilot": false,
     "grpc":true,
     "rest":true,
     "keysend":true,
     "whitelist":[],
     "alias":"node-alias",
     "color":"#FF5000"
   }
})

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "name": "node-name",
   "network": "mainnet",
   "type": "standard",
   "settings": {
     "autopilot": false,
     "grpc":true,
     "rest":true,
     "keysend":true,
     "whitelist":[],
     "alias":"node-alias",
     "color":"#FF5000"
   }
})

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1",
  "network": "mainnet",
  "created": "2024-01-10T19:21:57Z",
  "purchased_type": "ondemand",
  "type": "standard",
}
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1",
  "network": "mainnet",
  "created": "2024-01-10T19:21:57Z",
  "purchased_type": "ondemand",
  "type": "standard",
}
﻿
Upload an encrypted macaroon for a node for backup and dashboard functionality.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that owns the node. 
node_id
required
String
The Voltage ID of the node that you want to backup a macaroon for.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Body Parameters
macaroon
required
String
Encrypted string of the macaroon. DO NOT UPLOAD UNENCRYPTED DATA.
name
required
String
Name of the macaroon you're backing up.
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/macaroon")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "name": "invoice",
   "macaroon": "ZW5jcn...lwdGVkCg=="
})

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/macaroon")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "name": "invoice",
   "macaroon": "ZW5jcn...lwdGVkCg=="
})

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN",
  "name": "invoice",
  "created": "2024-01-29T18:55:12Z"
}
{
  "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN",
  "name": "invoice",
  "created": "2024-01-29T18:55:12Z"
}
﻿
Upload an encrypted seed phrase for a node for backup.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that you want to list nodes for.
node_id
required
String
The Voltage ID of the node that you want to backup a seed for.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Body Parameters
seed
required
String
Encrypted string of the seed. DO NOT UPLOAD UNENCRYPTED DATA.
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/seed")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "seed": "ZW5jcn...lwdGVkCg=="
})

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/seed")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "seed": "ZW5jcn...lwdGVkCg=="
})

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "message": "not found"
}
{
  "message": "not found"
}
﻿
Update the IP Addresses that are allowed to talk to a node's APIs
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Body Parameters
whitelist
required
Array
List of IP Addresses that are allowed to talk to your node
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/whitelist")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "whitelist": [
     "1.2.3.4"
   ]
})

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/whitelist")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"
request.body = JSON.dump({
   "whitelist": [
     "1.2.3.4"
   ]
})

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "message": "not found"
}
{
  "message": "not found"
}
﻿
Get the TLS Certificate for a Node.
GET
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/cert")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/cert")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-VOLTAGE-AUTH"] = "voltage_api_key"

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN",
  "tls_cert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUdnRENDQkdpZ0F3SUJBZ0lRSE5wVmxDS3RmMGZoU1Y5UGtjOEJhVEFOQmdrcWhraUc5dzBCQVF3RkFEQkwKTVFzd0NRWURWUVFHRXdKQlZERVFNQTRHQTFVRUNoTUhXbVZ5YjFOVFRERXFNQ2dHQTFVRUF4TWhXbVZ5YjFOVApUQ0JTVTBFZ1JHOXRZV2x1SUZObFkzVnlaU0JUYVhSbElFTkJNQjRYRFRJeE1ERXlPVEF3TURBd01Gb1hEVEl4Ck1EUXlPVEl6TlRrMU9Wb3dKREVpTUNBR0ExVUVBeE1aWWk1MExuTjBZV2RwYm1jdWRtOXNkR0ZuWldGd2NDNXAKYnpDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTHZ0bEJWYkpCRmN3eVFEb1ZYdgpLZmJMaHlrTDFBYm80MWRHTmtaaHN2bHk5T3FlaUtOdmY1U05PTko4R2JZUTZPUG5qT0VqQjJ3N1Qwb3l6MUtVCjZKd3RJeVA2WTdpbG9vblhRbzUzd21CZDk3RTRKa2xZOVBPcndnWlpBeTJNdmFqT1h2TDRmWXZNODJNaHQrdHMKZXhlV2FJVFI3NCtJM1I5WWRMbldlMlAzN3c2S1RSUWNMemMzaEpnaHU3MFF3eWhhSE1mMlBlcUdwUmsxQlc4aApKYTd1dGRELzhKV0FWbWhBTFhzL0Q2bzgzaXpXQ0xwWU1wcUtWeEdnbndaV2dEQ2s4aWVOOUFHUFJmSVRKblhPCkZjaUF4LzV0ckxBSjdyMnl5Y2JKemN3V0xqTmlCeWJDSnRLanlHZVp1TUlPTWY0Sm4xSTkxVTJPOG1TOXNNRWcKZ2prQ0F3RUFBYU9DQW9Vd2dnS0JNQjhHQTFVZEl3UVlNQmFBRk1qWmVHaWkyUmxvMVQxeTNsOEtQdHkxaG9hbQpNQjBHQTFVZERnUVdCQlJuNHlYWVBLVTU0c0JVdVNzRXlqSlpPMm1kbERBT0JnTlZIUThCQWY4RUJBTUNCYUF3CkRBWURWUjBUQVFIL0JBSXdBREFkQmdOVkhTVUVGakFVQmdnckJnRUZCUWNEQVFZSUt3WUJCUVVIQXdJd1NRWUQKVlIwZ0JFSXdRREEwQmdzckJnRUVBYkl4QVFJQ1RqQWxNQ01HQ0NzR0FRVUZCd0lCRmhkb2RIUndjem92TDNObApZM1JwWjI4dVkyOXRMME5RVXpBSUJnWm5nUXdCQWdFd2dZZ0dDQ3NHQVFVRkJ3RUJCSHd3ZWpCTEJnZ3JCZ0VGCkJRY3dBb1kvYUhSMGNEb3ZMM3BsY205emMyd3VZM0owTG5ObFkzUnBaMjh1WTI5dEwxcGxjbTlUVTB4U1UwRkUKYjIxaGFXNVRaV04xY21WVGFYUmxRMEV1WTNKME1Dc0dDQ3NHQVFVRkJ6QUJoaDlvZEhSd09pOHZlbVZ5YjNOegpiQzV2WTNOd0xuTmxZM1JwWjI4dVkyOXRNSUlCQkFZS0t3WUJCQUhXZVFJRUFnU0I5UVNCOGdEd0FIWUFmVDd5CitJLy9pRlZvSk1MQXlwNVNpWGtyeFE1NENYOHVhcGRvbVg0aThOY0FBQUYzVDRDeUJ3QUFCQU1BUnpCRkFpQkoKOC9oY0pGOFU4RHJ0a1ZNamVvWDlBSzUxMDFqNm4xWXc3empaa3dvK1BBSWhBTkdWZkFWdFFPUzlmTmNuWWRIZApRSDlEdVdUU2ZXR09NeThFS3M4bGdTdkhBSFlBbENDOEhvN1ZqV3lJY3grQ2l5SXNEZEhhVFY1c1Q1UTlZZHRPCkwxaE5vc0lBQUFGM1Q0Q3pVQUFBQkFNQVJ6QkZBaUVBN1VhL3Q5RnBiVUVMaDM2YWtJdERhYUJYZzF2TmgxU2MKaGV4Q3pTcUNNK2tDSUVYSmVpbFB1bkJseVdhQWRJSUU3QWtUWHlzUGlyQXFUWWIrUkVvYTZnd1lNQ1FHQTFVZApFUVFkTUJ1Q0dXSXVkQzV6ZEdGbmFXNW5Mblp2YkhSaFoyVmhjSEF1YVc4d0RRWUpLb1pJaHZjTkFRRU1CUUFECmdnSUJBQWdaditweTZuMmkzSW92ck5wcjFvaW9pcVE2Z0NqQ2ErWi8rQzc1UFZxTFpvTkNnL291azlhTS9DSE4KUjhQMVJFd0F3MVVIKy8vV0MwUm53VkNOUUFFMU5KMG5aOS9qTytCb05XSXduK1NBYU1EU0xtUkpjemtPU2p0TApvL2FjOUlLb0IwWktoYnhyK3FIaSs0QWhVMmV2UHh2T3orY3NXZ041cU9vSnRkcjVRWmU4Z3UrMytrQkxUNEJCClYvUEVxTGE3SGhjUHBwcDZkNmdHQ29nTFdIbUd6RHdtSnltK2JLenJzL252N1pPc3FJbko0a0pCZ0o3NlhFQWYKYVV4bkhZMUJoR1JjTk9KNWFhM2xYRXM5Ty81NmlOeXFNYjkrVEJFMlhUTWRXNEVQRE9qYVNERDN0MUx0KzBMSQovZUZxWkVVdmhnQVVPblBWRUpJZHJrRnZ5SHEydmNpaXRxUENZWmZTWTdXNy9OZ1dCWXZnaFNEeGJEYklUZjRECnRsWWh3aEg4VG9wS0pJN1k2UTBpRVdYaktuVnhtUTRmeHp2anZVQno5ODJmY1lOSnRzY0YxbktxUHIzTzc1ekYKVThsNEVSM1Rpd3ByTVNNdHB3MGdGNnkvYXhsdnZENkVPclRNd2VmcXRuUDJYTW4zaktWUXJuZzl4aFZXcHk0TworVW5mWXJBWDgxcjVSK2lQMW9mQ2xkS0xmaDRwUCsvalVua1ZaYXRRNlp5THJvQnpibFdNTnZHNXhkeTFwTkQ0ClJxOVhsUk8xQWtlYThld1JGcHRRMzBrQVhhLzlDcXM0emxyV0hiR2ptNXpKWk9sU0lmNWJFSXo2OEtNUTVsY2QKTlFVSzFNVU9yZ0UwWVRZcmxwdzhtNnJlZFZEblFwSXBRZjFaWkJWQmFxUzM0NEE4Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0KCi0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLQpNSUlHMVRDQ0JMMmdBd0lCQWdJUWJGV3IyOUFIa3NlZEJ3ellFWjdXdnpBTkJna3Foa2lHOXcwQkFRd0ZBRENCCmlERUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2s1bGR5QktaWEp6WlhreEZEQVNCZ05WQkFjVEMwcGwKY25ObGVTQkRhWFI1TVI0d0hBWURWUVFLRXhWVWFHVWdWVk5GVWxSU1ZWTlVJRTVsZEhkdmNtc3hMakFzQmdOVgpCQU1USlZWVFJWSlVjblZ6ZENCU1UwRWdRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhrd0hoY05NakF3Ck1UTXdNREF3TURBd1doY05NekF3TVRJNU1qTTFPVFU1V2pCTE1Rc3dDUVlEVlFRR0V3SkJWREVRTUE0R0ExVUUKQ2hNSFdtVnliMU5UVERFcU1DZ0dBMVVFQXhNaFdtVnliMU5UVENCU1UwRWdSRzl0WVdsdUlGTmxZM1Z5WlNCVAphWFJsSUVOQk1JSUNJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBZzhBTUlJQ0NnS0NBZ0VBaG1semZxTzFNZGdqCjRXM2RwQlBUVkJYMUF1dmNBeUcxZmwwZFVudy9NZXVlQ1d6UldUaGVaMzVMVm85MWtMSTNERFZhWktXK1RCQXMKSkJqRWJZbU13Y1dTVFdZQ2c1MzM0U0YwK2N0REFzRnhzWCtyVERoOWtTckcvNG1wNk9TaHViTGFFSVVKaVpvNAp0ODczVHVTZDBXajVEV3QzRHRwQUc4VDM1bC92K3hyTjh1YjhQU1NvWDVWa2d3K2pXZjRLUXROdlVGTERxOG1GCldoVW5QTDZqSEFBRFhwdnM0bFROWXdPdHg5eVF0YnB4d1N0N1FKWTErSUNybVJKQjZCdUtSdC9qZkRKRjlKc2MKUlFWbEhJeFFkS0FKbDdvYVZuWGdEa3F0azJxZGRkM2tDRFhkNzRndjgxM0c5MXo3Q2pzR3lKOTNvSklsTlMzVQpnRmJENlY1NEpNZ1ozclNtb3RZYno5OG9aeFg3TUtidENtMWFKL3EraFR2MllLMXlNeHJuZmNpZUttT1lCYkZECmhuVzVPNlJNQTcwM2RCSzkyajZYUk4yRXR0TGtRdXVqWmd5K2pYUkt0YVdNSWxrTmtXSm1PaUhtRXJRbmdIdnQKaU5rSWNqSnVtcTFkZEZYNGlhVEk0MGE2emd2SUJ0eEZlRHMyUmZjYUg3M2VyN2N0TlVVcWdRVDVyRmdKaE1tRgp4NzZyUWdCNU9aVWtvZGI1azJleDdQK0d1NEo4NmJTMTUwOTRVdVljVjA5aFZla25tVGg1RXg5Q0JLaXBMUzJXCjJ3S0Jha2YrYVZZbk5DVTZTMG5BU3F0MnhyWnBHQzF2N3Y2RGh1ZXB5eUp0bjNxU1YyUG9CaVU1U3FsK2FBUnAKd1VpYlFNR200NGdqeU5EcURsVnArU2hMUWxVSDl4OENBd0VBQWFPQ0FYVXdnZ0Z4TUI4R0ExVWRJd1FZTUJhQQpGRk41djFxcUswclBWSURoMkp2QW5mS3lBMmJMTUIwR0ExVWREZ1FXQkJUSTJYaG9vdGtaYU5VOWN0NWZDajdjCnRZYUdwakFPQmdOVkhROEJBZjhFQkFNQ0FZWXdFZ1lEVlIwVEFRSC9CQWd3QmdFQi93SUJBREFkQmdOVkhTVUUKRmpBVUJnZ3JCZ0VGQlFjREFRWUlLd1lCQlFVSEF3SXdJZ1lEVlIwZ0JCc3dHVEFOQmdzckJnRUVBYkl4QVFJQwpUakFJQmdabmdRd0JBZ0V3VUFZRFZSMGZCRWt3UnpCRm9FT2dRWVkvYUhSMGNEb3ZMMk55YkM1MWMyVnlkSEoxCmMzUXVZMjl0TDFWVFJWSlVjblZ6ZEZKVFFVTmxjblJwWm1sallYUnBiMjVCZFhSb2IzSnBkSGt1WTNKc01IWUcKQ0NzR0FRVUZCd0VCQkdvd2FEQS9CZ2dyQmdFRkJRY3dBb1l6YUhSMGNEb3ZMMk55ZEM1MWMyVnlkSEoxYzNRdQpZMjl0TDFWVFJWSlVjblZ6ZEZKVFFVRmtaRlJ5ZFhOMFEwRXVZM0owTUNVR0NDc0dBUVVGQnpBQmhobG9kSFJ3Ck9pOHZiMk56Y0M1MWMyVnlkSEoxYzNRdVkyOXRNQTBHQ1NxR1NJYjNEUUVCREFVQUE0SUNBUUFWRHdvSXpRRFYKZXJjVDBlWXFaakJOSjhWTld3VkZsUU90WkVScW41aVduRVZhTFpaZHp4bGJ2ejJGeDBFeFVOdVVFZ1lrSVZNNApZb2NLa0NRN2hPNW5vaWNvcS9EckVZSDVJdU5jdVcxSThKSlo5REx1QjFmWXZJSGxaMkpHNDZpTmJWS0EzeWdBCkV6ODZSdkRRbHQyQzQ5NHFxUFZJdFJqcno5WWxKRUdUMERydHR5QXBxMFlMRkR6ZitaMXBrTWhoN2MrN2ZYZUoKcW1JaGZKcGR1S2M4SEVRa1lRUVNoZW40MjZTM0gwSnJJQWJLY0JDaXlZRnVPaGZ5dnV3VkNGRGZGdnJqQURqZAo0algxdVFYZDE2MUl5RlJibTg5czJPajVvVTF3RFl6NXN4K2hvQ3VoNmxTcysvdVB1V29tSXEzeTFHREZOYWZXCitMc0hCVTE2bFFvNVEyeWgyNWxhUXNLUmd5UG1NcEhKOThlZG02eTJzSFVhYkFTbVJIeHZHaXV3d0UyNWFEVTAKMlNBZWVweUltSjJDekI4MFlHN1d4bHluSHFOaHBFN3hmQzdQelFsTGdtZkVIZFUrdEhGZVFhelJRbnJGa1cyVwprcVJHSXE3Y0tSbnl5cHZqUE1ramVpVjlsUmRBTTlmU0p2c0Izc3ZVdXUxY29JRzF4eEkxeWVnb0dNNHI1UVA0ClJHSVZ2WWFpSTc2QzBkam9TYlEvZGtJVVVYUXVCOEFMNWp5SDM0ZzNCWmFhWHl2cG1uVjRpbHBwTVhWQW5BWUcKT041MVdoSjZXMHhOZE5Kd3pZQVNaWUgrdG1DV0krTjYwR3YyTk5NR0h3TVo3ZTliWGd6VUNaSDVGYUJGREdSNQpTOVZXcUhCNzNRK095SVZ2SWJLWWNTYzJ3L2FTdUZLR1NBPT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
}
{
  "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN",
  "tls_cert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUdnRENDQkdpZ0F3SUJBZ0lRSE5wVmxDS3RmMGZoU1Y5UGtjOEJhVEFOQmdrcWhraUc5dzBCQVF3RkFEQkwKTVFzd0NRWURWUVFHRXdKQlZERVFNQTRHQTFVRUNoTUhXbVZ5YjFOVFRERXFNQ2dHQTFVRUF4TWhXbVZ5YjFOVApUQ0JTVTBFZ1JHOXRZV2x1SUZObFkzVnlaU0JUYVhSbElFTkJNQjRYRFRJeE1ERXlPVEF3TURBd01Gb1hEVEl4Ck1EUXlPVEl6TlRrMU9Wb3dKREVpTUNBR0ExVUVBeE1aWWk1MExuTjBZV2RwYm1jdWRtOXNkR0ZuWldGd2NDNXAKYnpDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTHZ0bEJWYkpCRmN3eVFEb1ZYdgpLZmJMaHlrTDFBYm80MWRHTmtaaHN2bHk5T3FlaUtOdmY1U05PTko4R2JZUTZPUG5qT0VqQjJ3N1Qwb3l6MUtVCjZKd3RJeVA2WTdpbG9vblhRbzUzd21CZDk3RTRKa2xZOVBPcndnWlpBeTJNdmFqT1h2TDRmWXZNODJNaHQrdHMKZXhlV2FJVFI3NCtJM1I5WWRMbldlMlAzN3c2S1RSUWNMemMzaEpnaHU3MFF3eWhhSE1mMlBlcUdwUmsxQlc4aApKYTd1dGRELzhKV0FWbWhBTFhzL0Q2bzgzaXpXQ0xwWU1wcUtWeEdnbndaV2dEQ2s4aWVOOUFHUFJmSVRKblhPCkZjaUF4LzV0ckxBSjdyMnl5Y2JKemN3V0xqTmlCeWJDSnRLanlHZVp1TUlPTWY0Sm4xSTkxVTJPOG1TOXNNRWcKZ2prQ0F3RUFBYU9DQW9Vd2dnS0JNQjhHQTFVZEl3UVlNQmFBRk1qWmVHaWkyUmxvMVQxeTNsOEtQdHkxaG9hbQpNQjBHQTFVZERnUVdCQlJuNHlYWVBLVTU0c0JVdVNzRXlqSlpPMm1kbERBT0JnTlZIUThCQWY4RUJBTUNCYUF3CkRBWURWUjBUQVFIL0JBSXdBREFkQmdOVkhTVUVGakFVQmdnckJnRUZCUWNEQVFZSUt3WUJCUVVIQXdJd1NRWUQKVlIwZ0JFSXdRREEwQmdzckJnRUVBYkl4QVFJQ1RqQWxNQ01HQ0NzR0FRVUZCd0lCRmhkb2RIUndjem92TDNObApZM1JwWjI4dVkyOXRMME5RVXpBSUJnWm5nUXdCQWdFd2dZZ0dDQ3NHQVFVRkJ3RUJCSHd3ZWpCTEJnZ3JCZ0VGCkJRY3dBb1kvYUhSMGNEb3ZMM3BsY205emMyd3VZM0owTG5ObFkzUnBaMjh1WTI5dEwxcGxjbTlUVTB4U1UwRkUKYjIxaGFXNVRaV04xY21WVGFYUmxRMEV1WTNKME1Dc0dDQ3NHQVFVRkJ6QUJoaDlvZEhSd09pOHZlbVZ5YjNOegpiQzV2WTNOd0xuTmxZM1JwWjI4dVkyOXRNSUlCQkFZS0t3WUJCQUhXZVFJRUFnU0I5UVNCOGdEd0FIWUFmVDd5CitJLy9pRlZvSk1MQXlwNVNpWGtyeFE1NENYOHVhcGRvbVg0aThOY0FBQUYzVDRDeUJ3QUFCQU1BUnpCRkFpQkoKOC9oY0pGOFU4RHJ0a1ZNamVvWDlBSzUxMDFqNm4xWXc3empaa3dvK1BBSWhBTkdWZkFWdFFPUzlmTmNuWWRIZApRSDlEdVdUU2ZXR09NeThFS3M4bGdTdkhBSFlBbENDOEhvN1ZqV3lJY3grQ2l5SXNEZEhhVFY1c1Q1UTlZZHRPCkwxaE5vc0lBQUFGM1Q0Q3pVQUFBQkFNQVJ6QkZBaUVBN1VhL3Q5RnBiVUVMaDM2YWtJdERhYUJYZzF2TmgxU2MKaGV4Q3pTcUNNK2tDSUVYSmVpbFB1bkJseVdhQWRJSUU3QWtUWHlzUGlyQXFUWWIrUkVvYTZnd1lNQ1FHQTFVZApFUVFkTUJ1Q0dXSXVkQzV6ZEdGbmFXNW5Mblp2YkhSaFoyVmhjSEF1YVc4d0RRWUpLb1pJaHZjTkFRRU1CUUFECmdnSUJBQWdaditweTZuMmkzSW92ck5wcjFvaW9pcVE2Z0NqQ2ErWi8rQzc1UFZxTFpvTkNnL291azlhTS9DSE4KUjhQMVJFd0F3MVVIKy8vV0MwUm53VkNOUUFFMU5KMG5aOS9qTytCb05XSXduK1NBYU1EU0xtUkpjemtPU2p0TApvL2FjOUlLb0IwWktoYnhyK3FIaSs0QWhVMmV2UHh2T3orY3NXZ041cU9vSnRkcjVRWmU4Z3UrMytrQkxUNEJCClYvUEVxTGE3SGhjUHBwcDZkNmdHQ29nTFdIbUd6RHdtSnltK2JLenJzL252N1pPc3FJbko0a0pCZ0o3NlhFQWYKYVV4bkhZMUJoR1JjTk9KNWFhM2xYRXM5Ty81NmlOeXFNYjkrVEJFMlhUTWRXNEVQRE9qYVNERDN0MUx0KzBMSQovZUZxWkVVdmhnQVVPblBWRUpJZHJrRnZ5SHEydmNpaXRxUENZWmZTWTdXNy9OZ1dCWXZnaFNEeGJEYklUZjRECnRsWWh3aEg4VG9wS0pJN1k2UTBpRVdYaktuVnhtUTRmeHp2anZVQno5ODJmY1lOSnRzY0YxbktxUHIzTzc1ekYKVThsNEVSM1Rpd3ByTVNNdHB3MGdGNnkvYXhsdnZENkVPclRNd2VmcXRuUDJYTW4zaktWUXJuZzl4aFZXcHk0TworVW5mWXJBWDgxcjVSK2lQMW9mQ2xkS0xmaDRwUCsvalVua1ZaYXRRNlp5THJvQnpibFdNTnZHNXhkeTFwTkQ0ClJxOVhsUk8xQWtlYThld1JGcHRRMzBrQVhhLzlDcXM0emxyV0hiR2ptNXpKWk9sU0lmNWJFSXo2OEtNUTVsY2QKTlFVSzFNVU9yZ0UwWVRZcmxwdzhtNnJlZFZEblFwSXBRZjFaWkJWQmFxUzM0NEE4Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0KCi0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLQpNSUlHMVRDQ0JMMmdBd0lCQWdJUWJGV3IyOUFIa3NlZEJ3ellFWjdXdnpBTkJna3Foa2lHOXcwQkFRd0ZBRENCCmlERUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2s1bGR5QktaWEp6WlhreEZEQVNCZ05WQkFjVEMwcGwKY25ObGVTQkRhWFI1TVI0d0hBWURWUVFLRXhWVWFHVWdWVk5GVWxSU1ZWTlVJRTVsZEhkdmNtc3hMakFzQmdOVgpCQU1USlZWVFJWSlVjblZ6ZENCU1UwRWdRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhrd0hoY05NakF3Ck1UTXdNREF3TURBd1doY05NekF3TVRJNU1qTTFPVFU1V2pCTE1Rc3dDUVlEVlFRR0V3SkJWREVRTUE0R0ExVUUKQ2hNSFdtVnliMU5UVERFcU1DZ0dBMVVFQXhNaFdtVnliMU5UVENCU1UwRWdSRzl0WVdsdUlGTmxZM1Z5WlNCVAphWFJsSUVOQk1JSUNJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBZzhBTUlJQ0NnS0NBZ0VBaG1semZxTzFNZGdqCjRXM2RwQlBUVkJYMUF1dmNBeUcxZmwwZFVudy9NZXVlQ1d6UldUaGVaMzVMVm85MWtMSTNERFZhWktXK1RCQXMKSkJqRWJZbU13Y1dTVFdZQ2c1MzM0U0YwK2N0REFzRnhzWCtyVERoOWtTckcvNG1wNk9TaHViTGFFSVVKaVpvNAp0ODczVHVTZDBXajVEV3QzRHRwQUc4VDM1bC92K3hyTjh1YjhQU1NvWDVWa2d3K2pXZjRLUXROdlVGTERxOG1GCldoVW5QTDZqSEFBRFhwdnM0bFROWXdPdHg5eVF0YnB4d1N0N1FKWTErSUNybVJKQjZCdUtSdC9qZkRKRjlKc2MKUlFWbEhJeFFkS0FKbDdvYVZuWGdEa3F0azJxZGRkM2tDRFhkNzRndjgxM0c5MXo3Q2pzR3lKOTNvSklsTlMzVQpnRmJENlY1NEpNZ1ozclNtb3RZYno5OG9aeFg3TUtidENtMWFKL3EraFR2MllLMXlNeHJuZmNpZUttT1lCYkZECmhuVzVPNlJNQTcwM2RCSzkyajZYUk4yRXR0TGtRdXVqWmd5K2pYUkt0YVdNSWxrTmtXSm1PaUhtRXJRbmdIdnQKaU5rSWNqSnVtcTFkZEZYNGlhVEk0MGE2emd2SUJ0eEZlRHMyUmZjYUg3M2VyN2N0TlVVcWdRVDVyRmdKaE1tRgp4NzZyUWdCNU9aVWtvZGI1azJleDdQK0d1NEo4NmJTMTUwOTRVdVljVjA5aFZla25tVGg1RXg5Q0JLaXBMUzJXCjJ3S0Jha2YrYVZZbk5DVTZTMG5BU3F0MnhyWnBHQzF2N3Y2RGh1ZXB5eUp0bjNxU1YyUG9CaVU1U3FsK2FBUnAKd1VpYlFNR200NGdqeU5EcURsVnArU2hMUWxVSDl4OENBd0VBQWFPQ0FYVXdnZ0Z4TUI4R0ExVWRJd1FZTUJhQQpGRk41djFxcUswclBWSURoMkp2QW5mS3lBMmJMTUIwR0ExVWREZ1FXQkJUSTJYaG9vdGtaYU5VOWN0NWZDajdjCnRZYUdwakFPQmdOVkhROEJBZjhFQkFNQ0FZWXdFZ1lEVlIwVEFRSC9CQWd3QmdFQi93SUJBREFkQmdOVkhTVUUKRmpBVUJnZ3JCZ0VGQlFjREFRWUlLd1lCQlFVSEF3SXdJZ1lEVlIwZ0JCc3dHVEFOQmdzckJnRUVBYkl4QVFJQwpUakFJQmdabmdRd0JBZ0V3VUFZRFZSMGZCRWt3UnpCRm9FT2dRWVkvYUhSMGNEb3ZMMk55YkM1MWMyVnlkSEoxCmMzUXVZMjl0TDFWVFJWSlVjblZ6ZEZKVFFVTmxjblJwWm1sallYUnBiMjVCZFhSb2IzSnBkSGt1WTNKc01IWUcKQ0NzR0FRVUZCd0VCQkdvd2FEQS9CZ2dyQmdFRkJRY3dBb1l6YUhSMGNEb3ZMMk55ZEM1MWMyVnlkSEoxYzNRdQpZMjl0TDFWVFJWSlVjblZ6ZEZKVFFVRmtaRlJ5ZFhOMFEwRXVZM0owTUNVR0NDc0dBUVVGQnpBQmhobG9kSFJ3Ck9pOHZiMk56Y0M1MWMyVnlkSEoxYzNRdVkyOXRNQTBHQ1NxR1NJYjNEUUVCREFVQUE0SUNBUUFWRHdvSXpRRFYKZXJjVDBlWXFaakJOSjhWTld3VkZsUU90WkVScW41aVduRVZhTFpaZHp4bGJ2ejJGeDBFeFVOdVVFZ1lrSVZNNApZb2NLa0NRN2hPNW5vaWNvcS9EckVZSDVJdU5jdVcxSThKSlo5REx1QjFmWXZJSGxaMkpHNDZpTmJWS0EzeWdBCkV6ODZSdkRRbHQyQzQ5NHFxUFZJdFJqcno5WWxKRUdUMERydHR5QXBxMFlMRkR6ZitaMXBrTWhoN2MrN2ZYZUoKcW1JaGZKcGR1S2M4SEVRa1lRUVNoZW40MjZTM0gwSnJJQWJLY0JDaXlZRnVPaGZ5dnV3VkNGRGZGdnJqQURqZAo0algxdVFYZDE2MUl5RlJibTg5czJPajVvVTF3RFl6NXN4K2hvQ3VoNmxTcysvdVB1V29tSXEzeTFHREZOYWZXCitMc0hCVTE2bFFvNVEyeWgyNWxhUXNLUmd5UG1NcEhKOThlZG02eTJzSFVhYkFTbVJIeHZHaXV3d0UyNWFEVTAKMlNBZWVweUltSjJDekI4MFlHN1d4bHluSHFOaHBFN3hmQzdQelFsTGdtZkVIZFUrdEhGZVFhelJRbnJGa1cyVwprcVJHSXE3Y0tSbnl5cHZqUE1ramVpVjlsUmRBTTlmU0p2c0Izc3ZVdXUxY29JRzF4eEkxeWVnb0dNNHI1UVA0ClJHSVZ2WWFpSTc2QzBkam9TYlEvZGtJVVVYUXVCOEFMNWp5SDM0ZzNCWmFhWHl2cG1uVjRpbHBwTVhWQW5BWUcKT041MVdoSjZXMHhOZE5Kd3pZQVNaWUgrdG1DV0krTjYwR3YyTk5NR0h3TVo3ZTliWGd6VUNaSDVGYUJGREdSNQpTOVZXcUhCNzNRK095SVZ2SWJLWWNTYzJ3L2FTdUZLR1NBPT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
}
﻿
Start up a Node.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/start")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body

require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/start")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "message": "node is starting up"
}
{
  "message": "node is starting up"
}
﻿
Shut down a Node.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/stop")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body

require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/stop")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "message": "node is shutting down"
}
{
  "message": "node is shutting down"
}
﻿
Update a Node to the latest version.
PUT
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/update")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body

require "uri"
require "net/http"

url = URI("https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/update")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-VOLTAGE-AUTH"] = "string"

response = https.request(request)
puts response.read_body
Responses
200
404
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "lnd_version": "0.18.2-beta",
  "volt_version": "v0.4.16",
}
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "lnd_version": "0.18.2-beta",
  "volt_version": "v0.4.16",
}
﻿
Delete a Node from team.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization owns the node.
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
curl --location --globoff --request POST 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/delete' \
--header 'X-VOLTAGE-AUTH: string'
curl --location --globoff --request POST 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/delete' \
--header 'X-VOLTAGE-AUTH: string'
Responses
200
404
{
  "node_name": "nodename",
  "status": "deleted",
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "created": "07-18-2024T00:00:00Z",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1U",
  "api_endpoint": "nodename.m.voltageapp.io",
  "network": "mainnet",
  "type": "standard",
  "command_history": [
    {
      "action": "delete",
      "time": "07-18-2024T00:00:00Z"
    }
  ],
}
{
  "node_name": "nodename",
  "status": "deleted",
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "created": "07-18-2024T00:00:00Z",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1U",
  "api_endpoint": "nodename.m.voltageapp.io",
  "network": "mainnet",
  "type": "standard",
  "command_history": [
    {
      "action": "delete",
      "time": "07-18-2024T00:00:00Z"
    }
  ],
}
﻿
﻿
Update a node's settings.
PUT
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that owns the node. 
node_id
required
String
The Voltage ID of the node that you want to update the whitelist fo.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Body Parameters
settings
required
Object
Settings for the Lightning Node
Curl
Node.js
JS
Python
Ruby
curl --location --globoff --request PUT 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/settings' \
--header 'X-VOLTAGE-AUTH: string' \
--data '{"settings":{"autopilot": true,...}}'
curl --location --globoff --request PUT 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/settings' \
--header 'X-VOLTAGE-AUTH: string' \
--data '{"settings":{"autopilot": true,...}}'
Responses
200
404
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1",
  "network": "mainnet",
  "created": "2024-01-10T19:21:57Z",
  "purchased_type": "ondemand",
  "type": "standard",
  "settings": {
    "autopilot": false,
    "grpc": true,
    ...
  }
}
{
  "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  "owner_id": "2936b2c7-8980-442c-b037-4845ee6e84f1",
  "network": "mainnet",
  "created": "2024-01-10T19:21:57Z",
  "purchased_type": "ondemand",
  "type": "standard",
  "settings": {
    "autopilot": false,
    "grpc": true,
    ...
  }
}
﻿
Upload a macaroon for the Voltage Support team to use.
POST
Request
Path Params
organization_id
required
String
The Voltage ID of the organization that owns the node. 
node_id
required
String
The Voltage ID of the node that you want to backup a macaroon for.
Header Parameters
X-VOLTAGE-AUTH
required
String
Your Voltage API Key that can be created on your Voltage Dashboard. 
Curl
Node.js
JS
Python
Ruby
curl --location --globoff 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/support_macaroon' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VOLTAGE-AUTH: {voltage_api_key}' \
--data 'ZW5jcn...lwdGVkCg=='
curl --location --globoff 'https://api.voltage.cloud/organizations/{organization_id}/nodes/{node_id}/support_macaroon' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VOLTAGE-AUTH: {voltage_api_key}' \
--data 'ZW5jcn...lwdGVkCg=='
Responses
200
404
{
  "message": "ok"
}
{
  "message": "ok"
}
﻿
﻿
Updated 19 Jul 2024
Did this page help you?
GRPC API Examples
Creating a Node Walkthrough