CLI

Manage Backup from the terminal with norcube / nrc — org-wide job listings, pause/resume, and scripting against the same API.

Not verified yet

The Norcube CLI (norcube, alias nrc) exposes Backup under the nrc snapdb command group (the service's internal name). It's the tool for the things the dashboard doesn't do: org-wide backup listings, pausing and resuming datasources and policy attachments, and scripting.

Every command supports --org <slug> to override the organization and -o table|json|yaml for output. Setup is the standard CLI login:

nrc login
nrc org use <slug>
nrc snapdb datasource list     # sanity check

Datasources

# list, with optional name filter
nrc snapdb datasource list
nrc snapdb datasource list --query prod

# raw details for one datasource
nrc snapdb datasource get <id>

# master switch: stop/start all scheduled backups for a database
nrc snapdb datasource pause          # interactive picker in a TTY
nrc snapdb datasource pause <id>
nrc snapdb datasource resume <id>

The list shows name, engine, environment, active state, and ID. pause/resume toggle the datasource's active flag — semantics in Pause and resume: future scheduling stops, queued/running jobs still finish, no catch-up on resume.

Policy attachments

# what's attached to a datasource (policy, enabled, priority, destination)
nrc snapdb policy list --datasource <id>

# pause/resume one attachment (other policies keep running)
nrc snapdb policy pause  --datasource <id> --policy <policyId>
nrc snapdb policy resume --datasource <id> --policy <policyId>

# detach — destructive, so it confirms (or takes --yes for scripts)
nrc snapdb policy detach --datasource <id> --policy <policyId> --yes

Detach semantics are the same as the dashboard's: future runs stop, existing archives and job history stay — see Attach a policy.

Backups (org-wide job history)

The dashboard shows jobs per datasource; the CLI lists them across the whole organization — the tool for "did anything fail last night?":

nrc snapdb backup list                          # newest first, all datasources
nrc snapdb backup list --datasource <id>        # repeatable to filter several
nrc snapdb backup list --limit 100 --cursor <c> # manual paging
nrc snapdb backup list --all-pages --max-items 5000 -o json

Columns: datasource, status, trigger (schedule/manual), started, duration, size, job ID. With -o json the output pipes straight into jq:

# every failed job, with its error-relevant fields
nrc snapdb backup list -o json \
  | jq '[.[] | select(.jobStatus == "failed")]'

When more pages exist, the CLI prints the --cursor hint on stderr — so it never corrupts piped JSON.

Scripting patterns

# maintenance window: pause, do the work, resume
nrc snapdb datasource pause "$DS_ID"
./run-migration.sh
nrc snapdb datasource resume "$DS_ID"

# export full history before deleting a datasource
nrc snapdb backup list --datasource "$DS_ID" --all-pages -o json > history.json

Non-interactive environments need explicit arguments — commands that would open a picker error out without one, and destructive commands require --yes when there's no TTY to confirm on.

What stays in the dashboard (or API)

Creating datasources, credentials, policies, and destinations, running manual backups, and downloading archives aren't CLI commands today — use the dashboard or call the API directly; the CLI authenticates with the same session tokens the dashboard uses.

On this page