Developer Resources

Encrypted Data Backups

3min

This page describes how we utilize encrypted backups on the platform and how you can leverage this with our API.

Explainer

When creating nodes via our dashboard there's a lot that goes on behind the scenes to make sure your node is secure but still usable from the site. To acheive this, we backup the seed phrase and admin macaroon after they are encrypted client-side. This allows us to still display connection information and other functionality (like Thunderhub) without ever being able to actually see your credentials. Because we can't automate these tasks for you when creating nodes from the API, you will have to perform these backups yourself.

You will not be able to use things like Connection tab or Thunderhub without backing up an encrypted macaroon.

Encryption Example

We use AES-256 when encrypting and decrypting the data. On our dashboard, we use the node's password as the secret key for encryption. Here's what that would look like in Node.js:

JS
īģŋ

Endpoints

Using the above encryption example, you are able to make encrypted strings of text for both your admin macaroon and seed phrase. With the Upload Seed and Upload Macaroon endpoints, you are able backup that encrypted data for later use.

Updated 22 Feb 2024
Doc contributor
Doc contributor
Did this page help you?