Voltage
Search…
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. 1.
    Login to your Voltage Dashboard.
  2. 2.
    In the upper right, click on your email address to show the dropdown menu.
  3. 3.
    Click on Settings.
  4. 4.
    Click on the Voltage logo in the upper left.
  5. 5.
    Find the section labeled as API Keys.
  6. 6.
    Input an alias for your API key and choose whether it is for Node Control or Flow Control.
  7. 7.
    Give your API Key a memorable alias and click Create New API Key.
  8. 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. 1.
    Login to your Voltage Dashboard.
  2. 2.
    In the upper right, click on your email address to show the dropdown menu.
  3. 3.
    Click on Settings.
  4. 4.
    Click on the Voltage logo in the upper left.
  5. 5.
    Find the section labeled as API Keys.
  6. 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!
Last modified 2d ago