Voltage API

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 { "name" "get list of nodes", "method" "get", "url" "https //api voltage cloud/organizations/\ organization id/nodes", "description" "get a list of nodes owned by an organization ", "tab" "examples", "examples" { "languages" \[ { "id" "vgjdj9o9mn20jjopluywk", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}'", "customlabel" "" }, { "id" "lvkpir208f7so otkjvw ", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "7cniqaghqqdpe5ttlcez6", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "0lm1dqfckobjxyuftwuzs", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "8gf5l4jyvkhrjoi 38ui6", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "8gf5l4jyvkhrjoi 38ui6" }, "results" { "languages" \[ { "id" "vnuwt0wpv5iehhfk5k2c5", "language" "200", "customlabel" "", "code" "{\n \\"nodes\\" \[\n {\n \\"node name\\" \\"myvoltagenode\\",\n \\"status\\" \\"running\\",\n \\"node id\\" \\"555c5108 7438 488d b227 5f80baf8a23an\\",\n \\"expires\\" \\"never\\",\n \\"created\\" \\"2024 01 08t00 49 55z\\",\n \\"type\\" \\"standard\\",\n \\"purchased type\\" \\"paid\\",\n \\"purchase status\\" \\"active\\",\n \\"api endpoint\\" \\"myvoltagenode m voltageapp io\\",\n \\"network\\" \\"mainnet\\",\n \\"lnd version\\" \\"0 17 4 beta\\",\n \\"volt version\\" \\"v0 5 0\\",\n \\"update available\\" false\n },\n \n ]\n}" }, { "id" "kby2ido1nx9d 9rocv07i", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "vnuwt0wpv5iehhfk5k2c5" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that you want to list nodes for ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "get a node", "method" "get", "url" "https //api voltage cloud/organizations/{organization id}/nodes/{node id}", "description" "get information about a specific node ", "tab" "examples", "examples" { "languages" \[ { "id" "erskc6crpsmlas3m6jckr", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}'", "customlabel" "" }, { "id" "omybq6w4szz7fe17cgscq", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "1wniifwo5 i4dwuib7iws", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "qyn0ncx7s3pj6jeaxehxz", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "puzjmbx8tbdvujl5yf2ax", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "erskc6crpsmlas3m6jckr" }, "results" { "languages" \[ { "id" "jqfxdpu6bbvpybuxifpf0", "language" "200", "customlabel" "", "code" "{\n \\"node name\\" \\"myvoltagenode\\",\n \\"status\\" \\"running\\",\n \\"node id\\" \\"7b12b510 8633 4c49 af2b 9cb5b73d6feen\\",\n \\"expires\\" \\"never\\",\n \\"created\\" \\"2024 01 29t18 55 12z\\",\n \\"type\\" \\"standard\\",\n \\"purchased type\\" \\"paid\\",\n \\"purchase status\\" \\"active\\",\n \\"lnd version\\" \\"0 17 4 beta\\",\n \\"volt version\\" \\"v0 5 0\\",\n \\"update available\\" false,\n \\"api endpoint\\" \\"myvoltagenode m voltageapp io\\",\n \\"network\\" \\"mainnet\\",\n \\"command history\\" \[\n {\n \\"action\\" \\"stop\\",\n \\"time\\" \\"2024 01 29t18 55 12z\\"\n },\n {\n \\"action\\" \\"start\\",\n \\"time\\" \\"2024 01 29t18 59 12z\\"\n }\n ],\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\" true,\n \\"rest\\" true,\n \\"keysend\\" true,\n \\"alias\\" \\"myvoltagenode\\",\n \\"color\\" \\"#ef820d\\",\n \\"whitelist\\" \[\n \\"1 1 1 1\\",\n \\"2 2 2 2\\"\n ],\n \\"wumbo\\" false,\n \\"webhook\\" \\"\\",\n \\"webhook secret\\" \\"19cef4784ff04ff5bc8053d5847254e0\\",\n \\"sphinx\\" true,\n \\"minchansize\\" \\"\\",\n \\"maxchansize\\" \\"\\",\n \\"autocompaction\\" true,\n \\"defaultfeerate\\" \\"\\",\n \\"numgraphsyncpeers\\" \\"3\\",\n \\"maxpendingchannels\\" \\"2\\",\n \\"allowcircularroute\\" false,\n \\"gccanceledinvoicesonthefly\\" false,\n \\"gccanceledinvoicesonstartup\\" false,\n \\"amp\\" true,\n \\"wtclient\\" false,\n \\"torskipproxyforclearnettargets\\" false,\n \\"rpcmiddleware\\" false,\n \\"optionscidalias\\" false,\n \\"zeroconf\\" false\n }\n}" }, { "id" "zghc06vmdxw5mgev8mcpb", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "zghc06vmdxw5mgev8mcpb" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to get information for ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "create a node", "method" "post", "url" "https //api voltage cloud/organizations/{organization id}/nodes", "description" "create a new lightning node ", "tab" "examples", "examples" { "languages" \[ { "id" "pdmzgb8prnzkwo5pzhs1x", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}' \\\\\n data '{\\"name\\" \\"node name\\",\\"network\\" \\"mainnet\\",\\"type\\" \\"standard\\",\\"settings\\" {\\"autopilot\\" false,\\"grpc\\"\ true,\\"rest\\"\ true,\\"keysend\\"\ true,\\"whitelist\\" \[],\\"alias\\" \\"node alias\\",\\"color\\" \\"#ff5000\\"}}'", "customlabel" "" }, { "id" "r97mze6o zsn6yhhpqm n", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n },\n body json stringify({\n \\"name\\" \\"node name\\",\n \\"network\\" \\"mainnet\\",\n \\"type\\" \\"standard\\",\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\"\ true,\n \\"rest\\"\ true,\n \\"keysend\\"\ true,\n \\"whitelist\\" \[],\n \\"alias\\" \\"node alias\\",\n \\"color\\" \\"#ff5000\\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "0gvausentbb54dh232a2o", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar raw = json stringify({\n \\"name\\" \\"node name\\",\n \\"network\\" \\"mainnet\\",\n \\"type\\" \\"standard\\",\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\"\ true,\n \\"rest\\"\ true,\n \\"keysend\\"\ true,\n \\"whitelist\\" \[],\n \\"alias\\" \\"node alias\\",\n \\"color\\" \\"#ff5000\\"\n }\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "z5gzitah6pinuyz58y0ql", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes\\"\n\npayload = json dumps({\n \\"name\\" \\"node name\\",\n \\"network\\" \\"mainnnet\\",\n \\"type\\" \\"standard\\",\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\"\ true,\n \\"rest\\"\ true,\n \\"keysend\\"\ true,\n \\"whitelist\\" \[],\n \\"alias\\" \\"node alias\\",\n \\"color\\" \\"#ff5000\\"\n }\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "yfzqazragrbulxlzxk9dw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\nrequest body = json dump({\n \\"name\\" \\"node name\\",\n \\"network\\" \\"mainnet\\",\n \\"type\\" \\"standard\\",\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\"\ true,\n \\"rest\\"\ true,\n \\"keysend\\"\ true,\n \\"whitelist\\" \[],\n \\"alias\\" \\"node alias\\",\n \\"color\\" \\"#ff5000\\"\n }\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "yfzqazragrbulxlzxk9dw" }, "results" { "languages" \[ { "id" "jl pmqrugbgoducglpktz", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"8ac52ac6 b205 4051 8ac6 c538c2f269a0n\\",\n \\"owner id\\" \\"2936b2c7 8980 442c b037 4845ee6e84f1\\",\n \\"network\\" \\"mainnet\\",\n \\"created\\" \\"2024 01 10t19 21 57z\\",\n \\"purchased type\\" \\"ondemand\\",\n \\"type\\" \\"standard\\",\n}" }, { "id" "n4hikog9p7orsymw9vyuv", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "jl pmqrugbgoducglpktz" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that owns the node ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "name", "kind" "required", "type" "string", "description" "user defined node name given at creation" }, { "name" "network", "kind" "required", "type" "string", "description" "network the node is running on can be either 'testnet' or 'mainnet' ", "children" \[] }, { "name" "type", "kind" "required", "type" "string", "description" "type of node, either 'standard' or 'professional'", "children" \[] }, { "name" "version", "kind" "optional", "type" "string", "description" "specific lnd version to create", "" "specific lnd version to create" }, { "name" "settings", "kind" "required", "type" "object", "description" "settings for the lightning node", "children" \[ { "name" "autopilot", "kind" "required", "type" "boolean", "description" "when enabled, lnd will turn on its autopilot feature" }, { "name" "grpc", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the grpc api" }, { "name" "rest", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the rest api" }, { "name" "keysend", "kind" "required", "type" "boolean", "description" "when enabled, lnd will enable the keysend feature" }, { "name" "whitelist", "kind" "required", "type" "array", "description" "a list of ips that are allowed to talk to your node" }, { "name" "alias", "kind" "required", "type" "string", "description" "your node's alias on the peer to peer network" }, { "name" "color", "kind" "required", "type" "string", "description" "your node's color on the peer to peer network" }, { "name" "wumbo", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will accept wumbo channels" }, { "name" "webhook", "kind" "optional", "type" "string", "description" "your webhook endpoint if you wish to receive webhook events" }, { "name" "minchansize", "kind" "optional", "type" "string", "description" "the minimum channel size your node will accept" }, { "name" "maxchansize", "kind" "optional", "type" "string", "description" "the maximum channel size your node will accept" }, { "name" "autocompaction", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will automatically compact the databases on startup" }, { "name" "defaultfeerate", "kind" "optional", "type" "string", "description" "your default fee rate for your channels" }, { "name" "basefee", "kind" "optional", "type" "string", "description" "your base fee rate for your channels" }, { "name" "amp", "kind" "optional", "type" "boolean", "description" "enables atomic multipath payments" }, { "name" "wtclient", "kind" "optional", "type" "boolean", "description" "enables the watchtower client" }, { "name" "maxpendingchannels", "kind" "optional", "type" "string", "description" "maximum number of pending channels allowed for a single peer" }, { "name" "allowcircularroute", "kind" "optional", "type" "boolean", "description" "if enabled, allows a payment to exit and enter the same channel" }, { "name" "numgraphsyncpeers", "kind" "optional", "type" "string", "description" "number of peers used for syncing the graph" }, { "name" "gccanceledinvoicesonstartup", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices only when lnd starts up" }, { "name" "gccanceledinvoicesonthefly", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices while lnd is running" }, { "name" "torskipproxyforclearnettargets", "kind" "optional", "type" "boolean", "description" "optimization for clearnet peers see lnd docs " }, { "name" "rpcmiddleware", "kind" "optional", "type" "boolean", "description" "enables the rpcmiddleware, which can interecept certain rpc calls see lnd docs " }, { "name" "optionscidalias", "kind" "optional", "type" "boolean", "description" "if enabled, and zeroconf is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "zeroconf", "kind" "optional", "type" "boolean", "description" "if enabled, and optionscidalias is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "remotesigning", "kind" "optional", "type" "boolean", "description" "turn on or off remote signing" }, { "name" "remotesigninghost", "kind" "optional", "type" "string", "description" "ip address or hostname of the remote signing instance" }, { "name" "remotesigningmacaroon", "kind" "optional", "type" "string", "description" "macaroon used for authentication to the remote signer" }, { "name" "remotesigningcert", "kind" "optional", "type" "string", "description" "tls certificate of the remote signer" } ], "schema" \[ { "name" "autopilot", "kind" "required", "type" "boolean", "description" "when enabled, lnd will turn on its autopilot feature" }, { "name" "grpc", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the grpc api" }, { "name" "rest", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the rest api" }, { "name" "keysend", "kind" "required", "type" "boolean", "description" "when enabled, lnd will enable the keysend feature" }, { "name" "whitelist", "kind" "required", "type" "array", "description" "a list of ips that are allowed to talk to your node" }, { "name" "alias", "kind" "required", "type" "string", "description" "your node's alias on the peer to peer network" }, { "name" "color", "kind" "required", "type" "string", "description" "your node's color on the peer to peer network" }, { "name" "wumbo", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will accept wumbo channels" }, { "name" "webhook", "kind" "optional", "type" "string", "description" "your webhook endpoint if you wish to receive webhook events" }, { "name" "minchansize", "kind" "optional", "type" "string", "description" "the minimum channel size your node will accept" }, { "name" "maxchansize", "kind" "optional", "type" "string", "description" "the maximum channel size your node will accept" }, { "name" "autocompaction", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will automatically compact the databases on startup" }, { "name" "defaultfeerate", "kind" "optional", "type" "string", "description" "your default fee rate for your channels" }, { "name" "basefee", "kind" "optional", "type" "string", "description" "your base fee rate for your channels" }, { "name" "amp", "kind" "optional", "type" "boolean", "description" "enables atomic multipath payments" }, { "name" "wtclient", "kind" "optional", "type" "boolean", "description" "enables the watchtower client" }, { "name" "maxpendingchannels", "kind" "optional", "type" "string", "description" "maximum number of pending channels allowed for a single peer" }, { "name" "allowcircularroute", "kind" "optional", "type" "boolean", "description" "if enabled, allows a payment to exit and enter the same channel" }, { "name" "numgraphsyncpeers", "kind" "optional", "type" "string", "description" "number of peers used for syncing the graph" }, { "name" "gccanceledinvoicesonstartup", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices only when lnd starts up" }, { "name" "gccanceledinvoicesonthefly", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices while lnd is running" }, { "name" "torskipproxyforclearnettargets", "kind" "optional", "type" "boolean", "description" "optimization for clearnet peers see lnd docs " }, { "name" "rpcmiddleware", "kind" "optional", "type" "boolean", "description" "enables the rpcmiddleware, which can interecept certain rpc calls see lnd docs " }, { "name" "optionscidalias", "kind" "optional", "type" "boolean", "description" "if enabled, and zeroconf is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "zeroconf", "kind" "optional", "type" "boolean", "description" "if enabled, and optionscidalias is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "remotesigning", "kind" "optional", "type" "boolean", "description" "turn on or off remote signing" }, { "name" "remotesigninghost", "kind" "optional", "type" "string", "description" "ip address or hostname of the remote signing instance" }, { "name" "remotesigningmacaroon", "kind" "optional", "type" "string", "description" "macaroon used for authentication to the remote signer" }, { "name" "remotesigningcert", "kind" "optional", "type" "string", "description" "tls certificate of the remote signer" } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "upload an encrypted macaroon", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/macaroon", "description" "upload an encrypted macaroon for a node for backup and dashboard functionality ", "tab" "examples", "examples" { "languages" \[ { "id" "onkb n0mdhn3ytkhitjlt", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/macaroon' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}' \\\\\n data '{\\"name\\" \\"invoice\\",\\"macaroon\\" \\"zw5jcn lwdgvkcg==\\"}'", "customlabel" "" }, { "id" "kmomy rfuokmjccxzynzv", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/macaroon',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n },\n body json stringify({\n \\"name\\" \\"invoice\\",\n \\"macaroon\\" \\"zw5jcn lwdgvkcg==\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "ww bw rjrtlgxjvuxirw ", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar raw = json stringify({\n \\"name\\" \\"invoice\\",\n \\"macaroon\\" \\"zw5jcn lwdgvkcg==\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/\ organization id/nodes/\ node id/macaroon/{organization id}/{node id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ysdc0hsbkv0gztzymuw1w", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/macaroon\\"\n\npayload = json dumps({\n \\"name\\" \\"invoice\\",\n \\"macaroon\\" \\"zw5jcn lwdgvkcg==\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "ptqa6ulhf065j bscf9qw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/macaroon\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\nrequest body = json dump({\n \\"name\\" \\"invoice\\",\n \\"macaroon\\" \\"zw5jcn lwdgvkcg==\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ptqa6ulhf065j bscf9qw" }, "results" { "languages" \[ { "id" "w8j3nil5svm0r8hhveqql", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"7b12b510 8633 4c49 af2b 9cb5b73d6feen\\",\n \\"name\\" \\"invoice\\",\n \\"created\\" \\"2024 01 29t18 55 12z\\"\n}" }, { "id" "viqtcdyrr09f5n2wvob6s", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "w8j3nil5svm0r8hhveqql" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to backup a macaroon for ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "macaroon", "kind" "required", "type" "string", "description" "encrypted string of the macaroon do not upload unencrypted data ", "children" \[] }, { "name" "name", "kind" "required", "type" "string", "description" "name of the macaroon you're backing up ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "upload an encrypted seed", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/seed", "description" "upload an encrypted seed phrase for a node for backup ", "tab" "examples", "examples" { "languages" \[ { "id" "tnlxddkga1ny zskf8 fb", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/seed' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}' \\\\\n data '{\\"seed\\" \\"zw5jcn lwdgvkcg==\\"}'", "customlabel" "" }, { "id" "mcz5mgpdhtzli5o0fu9py", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/seed',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n },\n body json stringify({\n \\"seed\\" \\"zw5jcn lwdgvkcg==\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "yw2fssfmjn mgoznyja0l", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar raw = json stringify({\n \\"seed\\" \\"zw5jcn lwdgvkcg==\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/seed\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "oeitgixkfpy tng9hxxqj", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/seed\\"\n\npayload = json dumps({\n \\"seed\\" \\"zw5jcn lwdgvkcg==\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "nfruxhguih yck1anmbt", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/seed\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\nrequest body = json dump({\n \\"seed\\" \\"zw5jcn lwdgvkcg==\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "nfruxhguih yck1anmbt" }, "results" { "languages" \[ { "id" "tapjpdp7n9guxmoocr7ex", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"f8f2256d d443 4d73 8f9c cae0831e55cfn\\",\n \\"node name\\" \\"myvoltagenode\\",\n \\"seed\\" \\"kljdlkjfklahelkjhlkjh==\\"\n}" }, { "id" "23d9 cannln9ho6vapjw2", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "23d9 cannln9ho6vapjw2" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that you want to list nodes for ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to backup a seed for ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "seed", "kind" "required", "type" "string", "description" "encrypted string of the seed do not upload unencrypted data " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "update a node's whitelist", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/whitelist", "description" "update the ip addresses that are allowed to talk to a node's apis", "tab" "examples", "examples" { "languages" \[ { "id" "gxtcskap3i2g7y2ihknwz", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/whitelist' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}' \\\\\n data '{\\"whitelist\\" \[\\"1 2 3 4\\"]}'", "customlabel" "" }, { "id" "gbem6h9grhqo1ogki6xjz", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/whitelist',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n },\n body json stringify({\n \\"whitelist\\" \[\n \\"1 2 3 4\\"\n ]\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "crejbac4oxr8e09dd0hlp", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar raw = json stringify({\n \\"whitelist\\" \[\n \\"1 2 3 4\\"\n ]\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/whitelist\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ofp5kwcrfuv17ssdiyul6", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/whitelist\\"\n\npayload = json dumps({\n \\"whitelist\\" \[\n \\"1 2 3 4\\"\n ]\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "9imgwxixf0zr2318ljpxb", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/whitelist\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\nrequest body = json dump({\n \\"whitelist\\" \[\n \\"1 2 3 4\\"\n ]\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "9imgwxixf0zr2318ljpxb" }, "results" { "languages" \[ { "id" "ktqimbverhgrbprczorkb", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"7b12b510 8633 4c49 af2b 9cb5b73d6feen\\",\n \\"whitelist\\" \[\n \\"1 1 1 1\\",\n \\"2 2 2 2\\"\n ]\n}" }, { "id" "vrwlonguqpiehewaikf2b", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "vrwlonguqpiehewaikf2b" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "whitelist", "kind" "required", "type" "array", "description" "list of ip addresses that are allowed to talk to your node" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "get a certificate for a node", "method" "get", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/cert", "description" "get the tls certificate for a node ", "tab" "examples", "examples" { "languages" \[ { "id" "n1 nms3fkq53ywq6tqfer", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/cert' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}'", "customlabel" "" }, { "id" "mamo0y2oi9su8t1l qwm9", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id]/cert',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "ow580zv6oguj4jemxgz7l", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/cert\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ma2ssz evmx t6ap5msfr", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/cert\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "sv ub glg59zk0wwz8qwt", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/cert\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "sv ub glg59zk0wwz8qwt" }, "results" { "languages" \[ { "id" "ycrjjft3mcxdrptt5m528", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"7b12b510 8633 4c49 af2b 9cb5b73d6feen\\",\n \\"tls cert\\" \\"ls0tls1crudjtibdrvjusuzjq0furs0tls0tck1jsudnrendqkdpz0f3sujbz0lrse5wvmxds3rmmgzou1y5ugtjoejhvefoqmdrcwhrauc5dzbcqvf3rkfeqkwktvfzd0nrwurwuvfhrxdkqlzervfnqtrhqtfvrunotuhxbvz5yjfovfrerxfnq2dhqtfvruf4twhxbvz5yjfovapuq0jtvtbfz1jhoxrzv2x1suzobfkzvnlau0juyvhsbelftkjnqjryrfrjee1erxlpvef3turbd01gb1hevel4ck1euxlpvel6tlrrmu9wb3dkrevptunbr0exvuvbee1awwk1mexutjbzv2rwym1jdwrtoxnkr0zuwldgd2ndnxakynpdq0ftsxdeuvlks29aswh2y05buuvcqlfbrgdnrvbbrendqvfvq2dnrujbthz0bejwykpcrmn3evfeb1zydgplzmjmahlrtdfbym80mwrhtmtaahn2bhk5t3flautodmy1u05ptko4r2jzutzpug5qt0vqqjj3n1qwb3l6mutvcjzkd3rjeva2wtdpbg9vblhrbzuzd21czdk3rtrka2xzovbpcndnwlpbetjndmfqt1h2tdrmwxznodjnahqrdhmkzxhlv2fjvfi3nctjm1i5wwrmbldlmlazn3c2s1rsuwnmemmzaepnahu3mff3ewhhse1mmlblcudwumsxqlc4aapkytd1dgrelzhkv0fwbwhbtfhzl0q2bzgzaxpxq0xwwu1wcutweednbndav2deq2s4awvooufhufjmsvrkblhpckzjauf4lzv0ckxbsjdymnl5y2jkemn3v0xqtmlcewjdsnrlanlhzvp1tulptwy0sm4xstkxvtjpog1toxnnrwckz2prq0f3rufbyu9dqw9vd2dns0jnqjhhqtfvzel3uvlnqmfbrk1qwmvhawkyumxvmvqxetnsoetqdhkxag9hbqpnqjbhqtfvzernuvdcqljunhlywvblvtu0c0jvdvnzrxlqslppmm1kberbt0jntlziuthcqwy4rujbtuncyuf3ckrbwurwujbuqvfil0jbsxdbrefkqmdovkhtvuvgakfvqmdnckjnruzcuwneqvfzsut3wujcuvviqxdjd1nrwuqkvliwz0jfsxdrreewqmdzckjnruvbykl4qvfjq1rqqwxnq01hq0nzr0frvuzcd0lcrmhkb2riundjem92tdnobapzm1jwwji4dvkyoxrmme5rvxpbsujnwm5nuxdcqwdfd2dzz0ddq3nhqvfvrkj3rujcshd3zwpctejnz3jcz0vgckjry3dbb1kvyuhsmgneb3zmm3bsy205emmyd3vzm0owtg5obfkzunbamjh1wti5dewxcgxjbtluvtb4u1uwrkukyjixagfxnvrav04xy21wvgfyumxrmev1wtnkme1dc0ddq3nhqvfvrkj6qujoadlvzehsd09pohzlbvz5yjnoegpiqzv2wtnod0xutmxzm1jwwji4dvkyoxrnsulcqkfzs0t3wujcquhxzvfjrufnu0i5uvncogded0fiwufmvdd5citjly9prlzvsk1mqxlwnvnpwgtyefe1nenyohvhcgrvbvg0athoy0fbquyzvdrdeuj3qufcqu1bunpcrkfpqkokoc9oy0pgofu4rhj0a1znamvvwdlbszuxmdfqnm4xwxc3empaa3dvk1bbswhbtkdwzkfwdffpuzlmtmnuwwrizaprsdledvduu2zxr09nethfs3m4bgdtdkhbsflbbendoehvn1zqv3ljy3grq2l5sxnezehhvfy1c1q1utlzzhrpckwxae5vc0lbqufgm1q0q3pvqufbqkfnqvj6qkzbauvbn1vhl3q5rnbivuvmadm2ywtjderhyujyzzf2tmgxu2mkagv4q3ptcunnk2tdsuvysmvpbfb1bkjsevdhqwrjsuu3qwtuwhlzuglyqxfuwwirukvvytznd1lnq1fhqtfvzapfuvfktuj1q0dxsxvkqzv6zedgbmfxnw5mblp2ykhsafoyvmhjsef1yvc4d0rrwuplb1pjahzjtkfrru1cuufecmdnsujbqwdaditwetzummkzsw92ck5wcjfvaw9pcve2z0nqq2erwi8rqzc1ufzxtfpvtknnl291azlhts9dse4kujhqmvjfd0f3mvviky8vv0mwum53vknouuffmu5kmg5aos9qtytcb05xsxduk1nbyu1eu0xtukpjemtpu2p0tapvl2fjoullb0iwwktoynhyk3fiass0qwhvmmv2uhh2t3ory3nxz041cu9vsnrkcjvrwmu4z3urmytrqkxunejcclyvuevxtge3sghjuhbwcdzknmdhq29ntfdibud6rhdtsnltk2jlenjzl252n1ppc3fjbko0a0pcz0o3nlhfqwykyvv4bkhzmujor1jjtk9knwfhm2xyrxm5ty81nmloexfnyjkrvejfmlhutwrxnevqre9qyvnerdn0mux0kzbmsqovzuzxwkvvdmhnqvvpblbwrupjzhjrrnz5sheydmnpaxrxuenzwmztwtdxny9oz1dcwxznafneegjeykluzjrecnrswwh3aeg4vg9ws0pjn1k2utbprvdyaktuvnhtutrmehp2anzvqno5odjmy1losnrzy0yxbktxuhiztzc1ekykvthsnevsm1rpd3bytvnndhb3mgdgnnkvyxhsdnzenkvpclrnd2vmcxruudjytw4zaktwuxjuzzl4afzxchk0tworvw5mwxjbwdgxcjvsk2lqmw9mq2xks0xmadrwucsvalvua1zayxrrnlp5thjvqnpibfdntnzhnxhketfwtkq0cljxovhsuk8xqwtlythld1jgchrrmzbrqvhhlzldcxm0emxyv0hir2ptnxpkwk9su0lmnwjfsxo2oetnutvsy2qktlfvszfnvu9yz0uwwvrzcmxwdzhtnnjlzfzeblfwsxbrzjfawkjwqmfxuzm0nee4ci0tls0tru5eienfulrjrkldqvrfls0tls0kci0tls0tqkvhsu4gq0vsvelgsunbveutls0tlqpnsulhmvrdq0jmmmdbd0lcqwdjuwjgv3iyoufia3nlzej3ellfwjdxdnpbtkjna3foa2lhoxcwqkfrd0zbrenccmleruxnqwthqtfvrujotunwvk14rxpbukjntlzcqwduq2s1bgr5qktawep6wlhreezeqvncz05wqkfjvemwcgwky25obgvtqkrhwfi1tvi0d0hbwurwuvflrxhwvwfhvwdwvk5gvwxsu1zwtlvjrtvszehkdmntc3hmakfzqmdovgpcqu1uslzwvfjwslvjblz6zencu1uwrwdrmlz5zedsbwfxtmhkr2x2ymlcqmryum9im0pwzehrd0hoy05nakf3ck1utxdnref3turbd1doy05nekf3tvrjnu1qttfpvfu1v2pcte1rc3dduvlevlfrr0v3skjwrevrtue0r0exvuukq2hnsfdtvnlimu5uverfcu1dz0dbmvvfqxhnafdtvnlimu5uvencu1uwrwdsrzl0wvdsdulgtmxzm1z5wlncvaphwfjssuvoqk1jsunjakfoqmdrcwhrauc5dzbcqvffrkfbt0nbzzhbtuljq0nns0nbz0vbag1semzxtzfnzgdqcjrxm2rwqlbuvkjymuf1dmnbeucxzmwwzfvudy9nzxvlq1d6ulduagvamzvmvm85mwtmstnerfzhwktxk1rcqxmkskjqrwjzbu13y1dtvfdzq2c1mzm0u0ywk2n0refzrnhzwctyveroowttckcvng1wnk9tahvitgffsvvkavpvnap0odczvhvtzdbxajvev3qzrhrwquc4vdm1bc92k3hytjh1yjhqu1nvwdvwa2d3k2pxzjrluxrodlvgterxog1gcldovw5qtdzqsefbrfhwdnm0bfrowxdpdhg5evf0ynb4d1n0n1fkwtersunybvjkqjzcdutsdc9qzkrkrjlkc2mkulfwbehjeffks0fkbddvyvzuwgdea3f0azjxzgrkm2tdrfhknzrndjgxm0c5mxo3q2pzr3lkotnvsklstlmzvqpnrmjenly1nepnz1ozclntb3rzyno5og9aefg3tutidentmwfkl3erafr2mlllmxlnehjuzmnpzuttt1lcykzecmhuvzvpnljnqtcwm2rcszkyajzyuk4yrxr0tgtrdxvqwmd5k2pyukt0yvdnswxrtmtxsm1pauhtrxjrbmdidnqkau5rswnqsnvtctfkzezynglhvek0mge2emd2suj0eezlrhmyumzjyug3m2vyn2n0tlvvcwdrvdvyrmdkae1trgp4nzzyuwdcnu9avwtvzgi1azjleddqk0d1neo4nmjtmtuwotrvdvljvja5afzla25tvgg1rxg5q0jlaxbmuzjxcjj3s0jha2yryvzzbk5dvtztmg5bu3f0mnhywnbhqzf2n3y2rgh1zxb5eup0bjnxu1yyug9cavu1u3fsk2fbunakd1vpylfnr200ngdqeu5ecursvnaru2hmuwxvsdl4oenbd0vbqwfpq0fyvxdnz0z4tui4r0exvwrjd1fztujhqqpgrk41djfxcuswclbwsuromkp2qw5ms3lbmmjmtuiwr0exvwrez1fxqkjustjyag9vdgtayu5vown0nwzdajdjcnrzyudwakfpqmdovkhroejbzjhfqkfnq0fzwxdfz1levliwvefrsc9cqwd3qmdfqi93sujbrefkqmdovkhtvuukrmpbvujnz3jcz0vgqlfjrefrwulld1lcqlfvsef3sxdjz1levliwz0jcc3dhvefoqmdzckjnruvbykl4qvfjqwpuakfjqmdabmdrd0jbz0v3vufzrfzsmgzcrwt3unpcrm9ft2drwvkvyuhsmgneb3zmmk55ykm1mwmyvnlkseoxcmmzuxvzmjl0tdfwvfjwslvjblz6zezkvffvtmxjbljwwm1sallyunbimjvczfhsb2izsnbksgt1wtnkc01iwuckq0nzr0frvuzcd0vcqkdvd2feqs9cz2dyqmdfrkjry3dbb1l6yuhsmgneb3zmmk55zem1mwmyvnlkseoxyznrdqpzmjl0tdfwvfjwslvjblz6zezkvffvrmtarlj5zfhomfewrxvzm0owtunvr0ndc0dbuvvgqnpbqmhobg9ksfj3ck9pohzimk56y0m1mwmyvnlkseoxyznrdvkyoxrnqtbhq1nxr1njyjneuuvcrefvque0sunbuufwrhdvsxprrfykzxjjvdblwxfaakjosjhwtld3vkzsuu90wkvscw41avdurvzhtfpazhp4bgj2ejjgedbfefvodvvfz1lrsvznnapzb2nla0nrn2hpnw5vawnvcs9eckvzsdvjdu5jdvcxsthkslo5rex1qjfmwxzjsgxamkphndzptmjws0ezewdbckv6odzsdkrrbhqyqzq5nhfxufzjdfjqcno5wwxkrudumerydhr5qxbxmflmrkr6zitamxbrtwhon2mrn2zyzuokcw1jagzkcgr1s2m4sevra1lruvnozw40mjztm0gwsnjjqwjly0jdaxlzrnvpagz5dnv3vkngrgzgdnjqqurqzao0algxdvfyzde2mul5rljibtg5czjpajvvvtf3rfl6nxn4k2hvq3vonmxtcysvdvb1v29tsxezetfhrezoywzxcitmc0hcvte2bffvnveyewgynwxhuxnlumd5ug1ncehkothlzg02etjzsfvhykftbvjiehzhaxv3d0uynwfevtakmlnbzwvweultsjjdeki4mflhn1d4bhlushfoahbfn3hmqzdqelfstgdtzkvizfurdehgzvfheljrbnjga1cyvwprcvjhsxe3y0tsbnl5chzque1ramvpvjlsumrbttlmu0p2c0izc3zvdxuxy29jrzf4eekxewvnb0dnnhi1uva0cljhsvz2wwfpstc2qzbkam9tylevzgtjvvvyuxvcoefmnwp5sdm0zzncwmfhwhl2cg1uvjrpbhbwtvhwqw5bwuckt041mvdosjzxmhhoze5kd3pzqvnawugrdg1dv0krtjywr3yytk5nr0h3tvo3ztliwgd6vunasdvgyujgredsnqptovzxcuhcnznrk095svz2swjlwwntyzj3l2ftduzlr1nbpt0kls0tls1ftkqgq0vsvelgsunbveutls0tlqo=\\"\n}" }, { "id" "zrlijuldgu1iblnxnpt9y", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "ycrjjft3mcxdrptt5m528" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "start a node", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/start", "description" "start up a node ", "tab" "examples", "examples" { "languages" \[ { "id" "p4mco2y maoeamva0puua", "language" "curl", "code" "curl location globoff request post 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/start' \\\\\n header 'x voltage auth string'", "customlabel" "" }, { "id" "x8remhwrwk8mpfhzpfaid", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop',\n 'headers' {\n 'x voltage auth' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "9ufhciv1psedvng7gunjl", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x voltage auth\\", \\"string\\");\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "k2urzr vzwzkjadsfuer ", "language" "python", "code" "import requests\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/start\\"\n\npayload = {}\nheaders = {\n 'x voltage auth' 'string'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "ycahndbl7bopy1oou9qxk", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/start\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"x voltage auth\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ycahndbl7bopy1oou9qxk" }, "results" { "languages" \[ { "id" "ycrjjft3mcxdrptt5m528", "language" "200", "customlabel" "", "code" "{\n \\"message\\" \\"node is starting up\\"\n}" }, { "id" "zrlijuldgu1iblnxnpt9y", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "ycrjjft3mcxdrptt5m528" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "stop a node", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/stop", "description" "shut down a node ", "tab" "examples", "examples" { "languages" \[ { "id" "p4mco2y maoeamva0puua", "language" "curl", "code" "curl location globoff request post 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop' \\\\\n header 'x voltage auth string'", "customlabel" "" }, { "id" "x8remhwrwk8mpfhzpfaid", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop',\n 'headers' {\n 'x voltage auth' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "9ufhciv1psedvng7gunjl", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x voltage auth\\", \\"string\\");\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "k2urzr vzwzkjadsfuer ", "language" "python", "code" "import requests\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/start\\"\n\npayload = {}\nheaders = {\n 'x voltage auth' 'string'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "ycahndbl7bopy1oou9qxk", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/stop\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"x voltage auth\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ycahndbl7bopy1oou9qxk" }, "results" { "languages" \[ { "id" "ycrjjft3mcxdrptt5m528", "language" "200", "customlabel" "", "code" "{\n \\"message\\" \\"node is shutting down\\"\n}" }, { "id" "zrlijuldgu1iblnxnpt9y", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "ycrjjft3mcxdrptt5m528" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "update a node", "method" "put", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/update", "description" "update a node to the latest version ", "tab" "examples", "examples" { "languages" \[ { "id" "p4mco2y maoeamva0puua", "language" "curl", "code" "curl location globoff request post 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/update' \\\\\n header 'x voltage auth string'", "customlabel" "" }, { "id" "x8remhwrwk8mpfhzpfaid", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/update',\n 'headers' {\n 'x voltage auth' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "9ufhciv1psedvng7gunjl", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x voltage auth\\", \\"string\\");\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/update\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "k2urzr vzwzkjadsfuer ", "language" "python", "code" "import requests\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/update\\"\n\npayload = {}\nheaders = {\n 'x voltage auth' 'string'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "ycahndbl7bopy1oou9qxk", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/update\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"x voltage auth\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ycahndbl7bopy1oou9qxk" }, "results" { "languages" \[ { "id" "ycrjjft3mcxdrptt5m528", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"8ac52ac6 b205 4051 8ac6 c538c2f269a0n\\",\n \\"lnd version\\" \\"0 18 2 beta\\",\n \\"volt version\\" \\"v0 4 16\\",\n}" }, { "id" "zrlijuldgu1iblnxnpt9y", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "ycrjjft3mcxdrptt5m528" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "version", "kind" "optional", "type" "string", "description" "specific lnd version to update to", "" "specific lnd version to update to" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "delete a node", "method" "delete", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id", "description" "delete a node from team ", "tab" "examples", "examples" { "languages" \[ { "id" "p4mco2y maoeamva0puua", "language" "curl", "code" "curl location globoff request delete 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}' \\\\\n header 'x voltage auth string'", "customlabel" "" }, { "id" "x8remhwrwk8mpfhzpfaid", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'delete',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}',\n 'headers' {\n 'x voltage auth' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "9ufhciv1psedvng7gunjl", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x voltage auth\\", \\"string\\");\n\nvar requestoptions = {\n method 'delete',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "k2urzr vzwzkjadsfuer ", "language" "python", "code" "import requests\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\"\n\npayload = {}\nheaders = {\n 'x voltage auth' 'string'\n}\n\nresponse = requests request(\\"delete\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "ycahndbl7bopy1oou9qxk", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http delete new(url)\nrequest\[\\"x voltage auth\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ycahndbl7bopy1oou9qxk" }, "results" { "languages" \[ { "id" "ycrjjft3mcxdrptt5m528", "language" "200", "customlabel" "", "code" "{\n \\"node name\\" \\"nodename\\",\n \\"status\\" \\"deleted\\",\n \\"node id\\" \\"8ac52ac6 b205 4051 8ac6 c538c2f269a0n\\",\n \\"created\\" \\"07 18 2024t00 00 00z\\",\n \\"owner id\\" \\"2936b2c7 8980 442c b037 4845ee6e84f1u\\",\n \\"api endpoint\\" \\"nodename m voltageapp io\\",\n \\"network\\" \\"mainnet\\",\n \\"type\\" \\"standard\\",\n \\"command history\\" \[\n {\n \\"action\\" \\"delete\\",\n \\"time\\" \\"07 18 2024t00 00 00z\\"\n }\n ],\n}" }, { "id" "zrlijuldgu1iblnxnpt9y", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "ycrjjft3mcxdrptt5m528" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "update a node settings", "method" "put", "url" "https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings", "description" "update a node's settings ", "tab" "examples", "examples" { "languages" \[ { "id" "5ipr6c8l3ntv7jk7x9gcj", "language" "curl", "code" "curl location globoff request put 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings' \\\\\n header 'x voltage auth string' \\\\\n data '{\\"settings\\" {\\"autopilot\\" true, }}'", "customlabel" "" }, { "id" "jvmuh bpcelbyq0i3a4mh", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings/{organization id}',\n 'headers' {\n 'x voltage auth' 'string'\n },\n body '{\\"settings\\" \\"object\\"}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "qir0vzvsx24y7jkr5m0de", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x voltage auth\\", \\"string\\");\n\nvar raw = \\"{\\\\\\"settings\\\\\\" \\\\\\"object\\\\\\"}\\";\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings/{organization id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "lopwagsd1fcmxzfy8miai", "language" "python", "code" "import requests\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings/{organization id}\\"\n\npayload = \\"{\\\\\\"settings\\\\\\" \\\\\\"object\\\\\\"}\\"\nheaders = {\n 'x voltage auth' 'string'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "offk2e8 2lcr8cjbntmfs", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/settings/{organization id}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"x voltage auth\\"] = \\"string\\"\nrequest body = \\"{\\\\\\"settings\\\\\\" \\\\\\"object\\\\\\"}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "5ipr6c8l3ntv7jk7x9gcj" }, "results" { "languages" \[ { "id" "jl pmqrugbgoducglpktz", "language" "200", "customlabel" "", "code" "{\n \\"node id\\" \\"8ac52ac6 b205 4051 8ac6 c538c2f269a0n\\",\n \\"owner id\\" \\"2936b2c7 8980 442c b037 4845ee6e84f1\\",\n \\"network\\" \\"mainnet\\",\n \\"created\\" \\"2024 01 10t19 21 57z\\",\n \\"purchased type\\" \\"ondemand\\",\n \\"type\\" \\"standard\\",\n \\"settings\\" {\n \\"autopilot\\" false,\n \\"grpc\\" true,\n \n }\n}" }, { "id" "n4hikog9p7orsymw9vyuv", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "jl pmqrugbgoducglpktz" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to update the whitelist fo ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[ { "name" "settings", "kind" "required", "type" "object", "description" "settings for the lightning node", "children" \[ { "name" "autopilot", "kind" "required", "type" "boolean", "description" "when enabled, lnd will turn on its autopilot feature" }, { "name" "grpc", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the grpc api" }, { "name" "rest", "kind" "required", "type" "boolean", "description" "when enabled, lnd will active the rest api" }, { "name" "keysend", "kind" "required", "type" "boolean", "description" "when enabled, lnd will enable the keysend feature" }, { "name" "whitelist", "kind" "required", "type" "array", "description" "a list of ips that are allowed to talk to your node" }, { "name" "alias", "kind" "required", "type" "string", "description" "your node's alias on the peer to peer network" }, { "name" "color", "kind" "required", "type" "string", "description" "your node's color on the peer to peer network" }, { "name" "wumbo", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will accept wumbo channels" }, { "name" "webhook", "kind" "optional", "type" "string", "description" "your webhook endpoint if you wish to receive webhook events" }, { "name" "minchansize", "kind" "optional", "type" "string", "description" "the minimum channel size your node will accept" }, { "name" "maxchansize", "kind" "optional", "type" "string", "description" "the maximum channel size your node will accept" }, { "name" "autocompaction", "kind" "optional", "type" "boolean", "description" "when enabled, lnd will automatically compact the databases on startup" }, { "name" "defaultfeerate", "kind" "optional", "type" "string", "description" "your default fee rate for your channels" }, { "name" "basefee", "kind" "optional", "type" "string", "description" "your base fee rate for your channels" }, { "name" "amp", "kind" "optional", "type" "boolean", "description" "enables atomic multipath payments" }, { "name" "wtclient", "kind" "optional", "type" "boolean", "description" "enables the watchtower client" }, { "name" "maxpendingchannels", "kind" "optional", "type" "string", "description" "maximum number of pending channels allowed for a single peer" }, { "name" "allowcircularroute", "kind" "optional", "type" "boolean", "description" "if enabled, allows a payment to exit and enter the same channel" }, { "name" "numgraphsyncpeers", "kind" "optional", "type" "string", "description" "number of peers used for syncing the graph" }, { "name" "gccanceledinvoicesonstartup", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices only when lnd starts up" }, { "name" "gccanceledinvoicesonthefly", "kind" "optional", "type" "boolean", "description" "if enabled, deletes cancelled invoices while lnd is running" }, { "name" "torskipproxyforclearnettargets", "kind" "optional", "type" "boolean", "description" "optimization for clearnet peers see lnd docs " }, { "name" "rpcmiddleware", "kind" "optional", "type" "boolean", "description" "enables the rpcmiddleware, which can interecept certain rpc calls see lnd docs " }, { "name" "optionscidalias", "kind" "optional", "type" "boolean", "description" "if enabled, and zeroconf is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "zeroconf", "kind" "optional", "type" "boolean", "description" "if enabled, and optionscidalias is also enabled, it is possible to create zeroconf channels see lnd docs " }, { "name" "remotesigning", "kind" "optional", "type" "boolean", "description" "turn on or off remote signing" }, { "name" "remotesigninghost", "kind" "optional", "type" "string", "description" "ip address or hostname of the remote signing instance" }, { "name" "remotesigningmacaroon", "kind" "optional", "type" "string", "description" "macaroon used for authentication to the remote signer" }, { "name" "remotesigningcert", "kind" "optional", "type" "string", "description" "tls certificate of the remote signer" } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "upload a support macaroon", "method" "post", "url" "https //api voltage cloud/organizations/\ organization id/nodes/\ node id/support macaroon", "description" "upload a macaroon for the voltage support team to use ", "tab" "examples", "examples" { "languages" \[ { "id" "onkb n0mdhn3ytkhitjlt", "language" "curl", "code" "curl location globoff 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/support macaroon' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'x voltage auth {voltage api key}' \\\\\n data 'zw5jcn lwdgvkcg=='", "customlabel" "" }, { "id" "kmomy rfuokmjccxzynzv", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api voltage cloud/organizations/{organization id}/nodes/{node id}/support macaroon',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n },\n 'body' 'zw5jcn lwdgvkcg=='\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "ww bw rjrtlgxjvuxirw ", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"x voltage auth\\", \\"voltage api key\\");\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body \\"zw5jcn lwdgvkcg==\\",\n redirect 'follow'\n};\n\nfetch(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/support macaroon\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ysdc0hsbkv0gztzymuw1w", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/support macaroon\\"\n\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'x voltage auth' 'voltage api key'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=\\"zw5jcn lwdgvkcg==\\")\n\nprint(response text)\n", "customlabel" "" }, { "id" "ptqa6ulhf065j bscf9qw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api voltage cloud/organizations/{organization id}/nodes/{node id}/support macaroon\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"x voltage auth\\"] = \\"voltage api key\\"\nrequest body = \\"zw5jcn lwdgvkcg==\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "onkb n0mdhn3ytkhitjlt" }, "results" { "languages" \[ { "id" "w8j3nil5svm0r8hhveqql", "language" "200", "customlabel" "", "code" "{\n \\"message\\" \\"ok\\"\n}" }, { "id" "viqtcdyrr09f5n2wvob6s", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"not found\\"\n}" } ], "selectedlanguageid" "w8j3nil5svm0r8hhveqql" }, "request" { "pathparameters" \[ { "name" "organization id", "kind" "required", "type" "string", "description" "the voltage id of the organization that owns the node ", "children" \[] }, { "name" "node id", "kind" "required", "type" "string", "description" "the voltage id of the node that you want to backup a macaroon for ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x voltage auth", "kind" "required", "type" "string", "description" "your voltage api key that can be created on your voltage dashboard ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }