Voltage
Search…
Voltage
Welcome
Support
Powered by Voltage
Voltage Quick Start Guide
Lightning Nodes
Webhooks
Changelog
FAQ
Flow
Flow and Pool: An Introduction
Installing Pool
Using Flow Dashboard
Using Flow API
Corporate Accounts
API Specification
FAQ
API
Authentication
Encrypted Data Backups
Creating a Node Walkthrough
API Specification
BTCPay Server
BTCPay Server FAQ
Thunderhub Guides
Starting Thunderhub
Opening a Channel
Basics of Channel Management
Intermediate Channel Management
Analyzing Basic Data in Thunderhub
Balance of Satoshis Guides
Balance of Satoshis
BOS - Rebalancing Channels
BOS - Probe Command
BTCPayServer Guides
BTCPay General Overview
Stores
Powered By
GitBook
Authentication
This document outlines how to create and manage your API Keys, as well as how to use them to authenticate to the API.
Creating a new API Key
1.
Login to your
Voltage Dashboard
.
2.
In the upper right, click on your email address to show the dropdown menu.
3.
Click on Settings.
4.
Click on the Voltage logo in the upper left.
5.
Find the section labeled as
API Keys.
6.
Input an alias for your API key and choose whether it is for
Node Control
or
Flow Control.
7.
Give your API Key a memorable alias and click
Create New API Key.
8.
Copy the generated API Key's value into a safe and secure place.
You can only view the API Key when it's created. If you lose your key you must delete it and generate a new one.
Deleting an API Key
1.
Login to your
Voltage Dashboard
.
2.
In the upper right, click on your email address to show the dropdown menu.
3.
Click on Settings.
4.
Click on the Voltage logo in the upper left.
5.
Find the section labeled as
API Keys.
6.
Find the API Key you want to delete and click
Delete
.
As soon as you delete an API Key it will no longer be able to authenticate to the API.
Using the API Key
When communicating with our API the service expects the API Key to be present in the
X-VOLTAGE-AUTH
header.
Example Request
1
curl -H 'X-VOLTAGE-AUTH: vcsn-619YNWcw...' \
2
https://api.voltage.cloud/nodes
Copied!
Flow - Previous
FAQ
Next - API
Encrypted Data Backups
Last modified
5mo ago
Copy link
Contents
Creating a new API Key
Deleting an API Key
Using the API Key