API Overview

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

curl -X POST https://backlox.com/api/v1/backups \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "daily-backup",
    "size_bytes": 1048576
  }'

# Step 1: Request upload URL
curl -X POST https://backlox.com/api/v1/backups \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "daily-backup-2024-01-15",
    "size_bytes": 52428800,
    "content_type": "application/gzip",
    "metadata": {
      "source": "production-server",
      "database": "myapp"
    }
  }'

# Response:
{
  "id": "bkp_abc123def456",
  "name": "daily-backup-2024-01-15",
  "status": "pending",
  "upload_url": "https://storage.backlox.com/upload/...",
  "upload_expires_at": "2024-01-15T11:00:00Z"
}

# Step 2: Upload the file to the upload URL
curl -X PUT "https://storage.backlox.com/upload/..." \
  -H "Content-Type: application/gzip" \
  --data-binary @backup.tar.gz

# Step 3: Mark upload as complete
curl -X POST https://backlox.com/api/v1/backups/bkp_abc123def456/complete \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# Response:
{
  "id": "bkp_abc123def456",
  "name": "daily-backup-2024-01-15",
  "status": "completed",
  "size_bytes": 52428800,
  "checksum": "sha256:a1b2c3d4e5f6...",
  "created_at": "2024-01-15T10:30:00Z"
}

# List all backups with pagination
curl "https://backlox.com/api/v1/backups?limit=10&offset=0" \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# Filter by status
curl "https://backlox.com/api/v1/backups?status=completed" \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# Filter by date range
curl "https://backlox.com/api/v1/backups?created_after=2024-01-01&created_before=2024-01-31" \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# Response:
{
  "backups": [
    {
      "id": "bkp_abc123",
      "name": "daily-backup-2024-01-15",
      "status": "completed",
      "size_bytes": 52428800,
      "created_at": "2024-01-15T10:30:00Z"
    },
    // ...more backups
  ],
  "total": 42,
  "limit": 10,
  "offset": 0
}

# Get download URL
curl https://backlox.com/api/v1/backups/bkp_abc123/download \
  -H "Authorization: Bearer lox_xxxxxxxxxxxx"

# Response:
{
  "download_url": "https://storage.backlox.com/download/...",
  "expires_at": "2024-01-15T11:30:00Z",
  "size_bytes": 52428800,
  "checksum": "sha256:a1b2c3d4e5f6..."
}

# Download the file
curl -o backup.tar.gz "https://storage.backlox.com/download/..."

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

# Response:
{
  "used_bytes": 1073741824,
  "quota_bytes": 5368709120,
  "used_percentage": 20.0,
  "backup_count": 15,
  "oldest_backup": "2024-01-01T00:00:00Z",
  "newest_backup": "2024-01-15T10:30:00Z"
}

{
  "error": {
    "code": "validation_error",
    "message": "Invalid request body",
    "details": {
      "name": "Name is required",
      "size_bytes": "Must be a positive integer"
    }
  }
}

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 1704288000
Retry-After: 30  # Only on 429 responses

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705320000

# Webhook payload for backup.completed event
{
  "event": "backup.completed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "bkp_abc123",
    "name": "daily-backup",
    "status": "completed",
    "size_bytes": 52428800,
    "checksum": "sha256:a1b2c3d4..."
  }
}

# Webhook payload for backup.failed event
{
  "event": "backup.failed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "bkp_abc123",
    "name": "daily-backup",
    "status": "failed",
    "error": "Upload timeout exceeded"
  }
}