Ingest: how backups report to Servatum

Every backup job reports its runs to Servatum. Pick the method that fits the tool: an HTTPS call, a heartbeat URL, the CLI wrapper, a JetBackup or cPanel hook, or a forwarded notification email.

Run API (webhook)

Report a finished run with one HTTPS request. The job key identifies the job; no other authentication is needed for reporting.

POST https://in.servatum.io/v1/jobs/{job_key}/runs
Content-Type: application/json

{
  "status": "ok",
  "started_at": "2026-10-24T00:00:04Z",
  "finished_at": "2026-10-24T00:37:12Z",
  "size_bytes": 48211993600,
  "snapshot_id": "a1b2c3d4",
  "message": "1,204 accounts, 0 errors"
}

status is ok, failed or running. Every other field is optional. Size and duration trends are tracked, so a backup that suddenly shrinks is flagged even when it reports ok.

Heartbeat URLs

For tools that can only call a URL. The ping API follows the same scheme as Healthchecks.io, so anything that already supports Healthchecks-style ping URLs, such as borgmatic's Healthchecks hook, can point at Servatum unchanged. If a success ping doesn't arrive within the schedule and grace period, the job turns missing.

curl -fsS https://in.servatum.io/p/{job_key}          # success
curl -fsS https://in.servatum.io/p/{job_key}/start    # job started
curl -fsS https://in.servatum.io/p/{job_key}/fail     # job failed
curl -fsS https://in.servatum.io/p/{job_key}/$?       # exit status: 0 = success
curl -fsS --data-binary @job.log https://in.servatum.io/p/{job_key}/log   # attach log only

A POST body on any of these is kept as the run's log. Example with borg: BorgBackup integration.

CLI wrapper

The open-source servatum agent wraps any command. It reports start, finish, exit code and duration, and reads extra detail (snapshot ID, bytes added) from restic, borg and rclone output.

export SERVATUM_JOB_KEY=nightly-full:xxxxxxxx
servatum run -- restic backup /home --tag nightly
servatum run --job db-dump -- pg_dump -Fc app > /backup/app.dump

The wrapper never changes your command's exit code, so existing cron alerts keep working.

JetBackup and cPanel

JetBackup 5 (cPanel, DirectAdmin, Plesk or Linux): install the Servatum hook script, then add it in JetBackup as a Post Backup hook, and optionally as a Post Backup Account hook for per-account results. JetBackup passes each job's status, start and end time, destination IDs and log ID; it does not pass backup size. Jobs that never start are caught by their schedule. Details: JetBackup monitoring.

cPanel native backups: the script runs as cPanel's post-backup hook. That hook doesn't say whether the backup succeeded, so the script reads the final state from cPanel's backup log.

Hosts get one proof page per client account if they want it, white-labelled under their own brand.

Email ingest

Every account gets an inbox address. Point the notification emails of tools like Veeam, Veritas Backup Exec, Acronis, Proxmox or Synology at it. Servatum recognises the sender, reads the job name, result, size and warnings, and matches the email to the right job.

{account}@in.servatum.io