backups

Get the backup overview of a project

Returns whether backups are enabled and ready, the schedule and its next run, the retention policy, every database and volume with its last backup, and the backup runs, newest first.

get/api/projects/{projectName}/backups

Request

  • Base URL: https://api.hostim.dev
  • URL: https://api.hostim.dev/api/projects/{projectName}/backups
  • Auth: HTTP bearer

Path parameters

projectNamestring required

Name of the project to get backups from

Response

OK

enabledboolean required

Whether backups are configured for the project

readyboolean required

Whether the restic repository is initialized

schedulestring required

The backup cron schedule from the project, UTC

nextRunTimestring date-time

When the next scheduled backup runs, omitted when the schedule is empty or invalid

Changes

No recorded changes to this operation across all 1 revision of this API.