backup-runs

Report a backup run

Record that a backup run started or finished.

Report started when a run begins and finished with a status when it ends. A finished run with status: success clears any outstanding stale-backup alert, so the next outage produces a fresh notification.

post/backup-runs

Request

  • Base URL: https://api.cogram.com/v1
  • URL: https://api.cogram.com/v1/backup-runs
  • Auth: HTTP bearer

Request body

event'started' | 'finished' required

Lifecycle point a connector reports.

schedule_interval_hoursinteger required

The connector's configured interval between runs. Cogram measures backup health against this rather than a server-side setting, because only the connector knows its own schedule.

status'success' | 'failed'

Outcome of a finished run. Absent on started events.

projects_syncedinteger nullable

Projects filed by this run. Zero is a healthy result — a run with no changed projects exports nothing.

errorstring nullable

Failure detail. Only meaningful when status is failed.

Response

Successful Response

idstring required
event'started' | 'finished' required

Lifecycle point a connector reports.

status'success' | 'failed' required

Outcome of a finished run. Absent on started events.

schedule_interval_hoursinteger required
projects_syncedinteger nullable required
errorstring nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.