Quick Start

Get started with LOX Backup in under 5 minutes. Follow these steps to create your first backup.

What you'll accomplish:

  • Create a LOX account and get your API key
  • Install the CLI or SDK
  • Create your first backup
  • Verify and download your backup

1Create Your Account

Sign up for a free LOX account to get started. You'll receive 5GB of free storage.

Create Free Account

2Get Your API Key

After logging in, navigate to Settings → API Keys and create a new API key.

Your API Key

Your API key looks like this:

lox_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Keep your API key secret! Never commit it to version control.

3Choose Your Integration Method

Select the method that best fits your workflow:

CLI Tool

Best for servers, scripts, and CI/CD pipelines.

Use CLI →

Python/Node.js SDK

Best for applications and custom integrations.

Use SDK →

CMS Plugin

Best for WordPress, WooCommerce, PrestaShop, Drupal.

Use Plugin →

REST API

Direct API access for any language or platform.

Use API →

Option A: Using the CLI

Install the CLI

# macOS / Linux
curl -fsSL https://get.backlox.com | sh

# Or with Homebrew
brew install loxbackup/tap/lox

# Or with npm
npm install -g @loxbackup/cli

# Windows (PowerShell)
irm https://get.backlox.com/windows | iex

Configure your API key

# Set your API key
export LOX_API_KEY="lox_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Or use the login command
lox auth login

Create your first backup

# Backup a directory
lox backup create --name "my-first-backup" --path /path/to/data

# Backup a database
lox backup create --name "db-backup" \
  --type mysql \
  --host localhost \
  --database myapp \
  --user root

# Wait for completion and show status
lox backup create --name "my-backup" --path ./data --wait

List and download backups

# List recent backups
lox backup list

# Download a backup
lox backup download <backup-id> -o backup.tar.gz

# Check storage usage
lox storage info

Option B: Using the SDK

Python

# Install
pip install loxbackup

# Create a backup
from loxbackup import LoxClient

client = LoxClient(api_key="lox_xxxxxxxxxxxx")

# Upload a file
backup = client.backups.create(
    name="my-first-backup",
    file_path="/path/to/data.tar.gz"
)
print(f"Backup created: {backup.id}")

# List backups
for backup in client.backups.list():
    print(f"{backup.name}: {backup.size_human}")

Node.js

// Install
npm install @loxbackup/sdk

// Create a backup
import { LoxClient } from '@loxbackup/sdk';

const client = new LoxClient({ apiKey: 'lox_xxxxxxxxxxxx' });

// Upload a file
const backup = await client.backups.create({
  name: 'my-first-backup',
  filePath: '/path/to/data.tar.gz'
});
console.log(`Backup created: ${backup.id}`);

// List backups
const backups = await client.backups.list();
backups.forEach(b => console.log(`${b.name}: ${b.sizeHuman}`));

Option C: Using a CMS Plugin

We offer plugins for popular CMS platforms with automatic scheduled backups:

WordPress

Database, uploads, themes, plugins

WooCommerce

Products, orders, customers

PrestaShop

Full store backup

Drupal

Database, files, config

Option D: Using the REST API

Use the REST API directly with any HTTP client:

# Get upload URL
curl -X POST https://backlox.com/api/v1/backups \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-first-backup",
    "size_bytes": 1048576,
    "content_type": "application/gzip"
  }'

# Response includes upload URL
{
  "id": "bkp_abc123",
  "upload_url": "https://storage.backlox.com/upload/...",
  "status": "pending"
}

# Upload your file
curl -X PUT "<upload_url>" \
  -H "Content-Type: application/gzip" \
  --data-binary @backup.tar.gz

# Confirm upload
curl -X POST https://backlox.com/api/v1/backups/bkp_abc123/complete \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# List backups
curl https://backlox.com/api/v1/backups \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

4Verify Your Backup

After creating a backup, verify it was successful:

# Check backup status
lox backup status <backup-id>

# Output:
# ID:       bkp_abc123
# Name:     my-first-backup
# Status:   completed
# Size:     156.2 MB
# Created:  2024-01-15 10:30:00 UTC
# Checksum: sha256:a1b2c3d4...

✓Next Steps

Now that you've created your first backup, explore more features:

API Reference

Complete API documentation

CLI Commands

All CLI commands and options

CI/CD Integration

Automate backups in your pipeline

Database Agents

Automated database backups

← IntroductionAPI Overview →