BigMindBigMindBigMind
Partner API
Sign inGet an API key
Partner API
OverviewAuthenticationCustomersPlansQuotesAccount & UsageBackup statusWebhooksError codesChangelog

Backup status

Is the backup working? Per customer and device: the newest finished session and its status, the last success, how many failures in a row, when the agent was last seen, and the recent sessions. Partner-wide: every device whose latest backup failed. The same facts the portal's Backup Status report shows.

Recommended pattern

  • Push: subscribe a webhook to backup.failed and backup.recovered. backup.failed fires once per failure streak per device (the first failure), backup.recovered on the next success — open and close the ticket on those.
  • Safety net: poll GET /v1/backup-status/failing (for example every 15 minutes with since=24h) and reconcile open tickets against it; it lists every device whose LATEST finished backup failed, across all your customers.
  • Detail: GET /v1/customers/{id}/backup-status for the sessions behind a failure (errorSummary), and GET /v1/customers/{id}/devices for the health of every device of one customer.

Status vocabulary

A session is running, completed, failed or cancelled. A session counts as FAILED when its status is failed, or when it completed with failed files and not one successful file — the same rule the backup.failed event uses, so the event, the device's lastBackupStatus and the /failing list always agree. lastBackupStatus is that reading of the device's newest FINISHED session (running sessions are not counted). consecutiveFailures counts such sessions since the last real success; cancelled sessions neither break nor extend the streak. online means the agent sent a heartbeat in the last 90 seconds. summary.successRate is null when no session finished in the window.

GET/v1/customers/{id}/backup-status

One customer: summary over ?days= (1–365, default 30), every device with its health, and the newest sessions (?limit= 1–200, default 100). ?deviceId= narrows to one device (404 DEVICE_NOT_FOUND if it is not the customer's).

curl -H "Authorization: Bearer sk_live_..." "https://eu-bigmind2.genie9.com/api/partner/v1/customers/pc_42_.../backup-status?days=7&limit=20"

Device health fields (also on GET /v1/customers/{id}/devices)

FieldTypeDescription
agentVersion, lastSeenAt, onlinestring | null, string | null, booleanFrom the agent's connection: its version, its last heartbeat, and whether that was within the last 90 seconds.
lastBackupAt, lastBackupStatusstring | nullWhen the newest FINISHED session ended, and how (completed, failed, cancelled …). null for a device that has never finished a backup.
lastSuccessfulBackupAtstring | nullWhen the newest completed session ended.
consecutiveFailuresintegerFailed sessions since the last completed one, newest first (0 when the latest finished session succeeded). Counted over the last 50 sessions.
sessions[].errorSummarystring | nullThe first 500 characters of the session's error log.
GET/v1/backup-status/failing

Partner-wide: every device whose LATEST finished backup failed, among the sessions started since ?since= (24h by default; 1h … 90d, or an ISO 8601 date within 90 days). Newest failure first; page / limit (max 200); archived and deleted devices are left out. A device whose next backup really succeeds drops off the list.

curl -H "Authorization: Bearer sk_live_..." "https://eu-bigmind2.genie9.com/api/partner/v1/backup-status/failing?since=24h&limit=100"