Quickstart guide

Create an account and project

Sign up at app.syncblaze.cc. A project groups your documents, sync jobs, backups and buckets, and has one home region. You can create as many projects as you like; usage from all projects counts toward your plan.

API keys and tokens

Each project has a publishable key (pk_…) that is safe to ship in client apps, and a secret key (sk_…) that must stay on your server. Agents and the CLI use separate agent tokens that can be limited to specific jobs.

export BLAZE_TOKEN=sk_live_…
blaze login --token $BLAZE_TOKEN
blaze projects list

Real-time Sync API

Install the client SDK, request a token from your server and open a document. Changes made with set, insert and delete merge with changes from other clients.

import { SyncBlaze } from "@syncblaze/client"
const blaze = new SyncBlaze({ key: "pk_live_…", token })
const doc = blaze.doc("todo:team-a")
doc.insert("items", { text: "Write docs", done: false })

See the Real-time Sync API overview for SDK platforms and limits.

Install the blaze agent

The agent is a single binary that runs sync and backup jobs on your servers. It needs outbound HTTPS only.

curl -fsSL https://get.syncblaze.cc | sh
sudo blaze service install --token $BLAZE_AGENT_TOKEN
blaze status

Create a sync job

A job has one source, one or more targets, a mode and a schedule. Use --watch for real-time sync on Pro and above.

blaze sync create site-assets \
  --source web1:/srv/assets --target s3://assets-eu \
  --mode mirror --every 5m
blaze sync run site-assets --dry-run

Schedule a backup

blaze backup create web1-etc --source web1:/etc --every 1h --keep daily=30
blaze backup list web1-etc
blaze restore web1-etc --file /etc/nginx/nginx.conf --at latest

Connect to S3 Storage

Create an access key in the dashboard under Storage › Keys, then point any S3 client at https://s3.syncblaze.cc with the region of your bucket, for example eu-fra.

rclone config create blaze s3 provider Other \
  endpoint https://s3.syncblaze.cc access_key_id SBK… secret_access_key …
rclone ls blaze:my-bucket

Limits and errors

When a free plan limit is reached, the API returns HTTP 429 with the code plan_limit_reached and the name of the limit. Paid plans continue and record overage. Rate limits for the REST API are 50 requests per second per project on Free and 500 on paid plans.