Backup Chief API v1

The team the request acts on, with its plan limits and their usage.

Endpoints for the servers of the team. Each server runs the Backup Chief agent, which runs its backup jobs and reports their results.

Endpoints for the storage destinations of the team: S3-compatible storage or SFTP servers the team owns, where the agents write the encrypted backup repositories. Credentials can be set but are never returned.

Endpoints for the backup jobs of the team. A job backs up files or databases of one server to a storage destination on a schedule. The agent on the server runs it, so changes and runs take effect when the agent next checks in.

Endpoints to test the source of a backup job on its server before saving it. The agent checks it can read the directories, or sign in to the database and list the selected databases and tables.

Endpoints for the runs of the team's backup jobs: backups and maintenance operations such as retention cleanup, pruning and integrity checks. A backup run is a recovery point, which can be kept forever or expired.

Endpoints for the restic snapshots of the team's backup jobs. Every backup run makes one snapshot for a file backup or one per database for a database backup. Restore them with the agent or restic, or prepare a hosted download.

Endpoints for hosted downloads: ZIPs of a file, a directory or a database dump from a snapshot, prepared by Backup Chief so they can be downloaded without access to the server. A download copies backup contents out of the team's own storage for a limited time, so only prepare one when it is needed. Restores on the team's own servers with the agent or restic need no download.