docker.list_backups

List existing app backups.

Type: object

Call parameters

Type: array
No Additional Items

Return value

DockerBackupInfo

Type: object

Object mapping backup names to their detailed information.

Additional Properties

Each additional property must conform to the following schema

BackupInfo

Type: object
No Additional Properties

name Required

Name

Type: string

Name of the backup.

Must be at least 1 characters long

apps Required

Apps

Type: array of object

Array of applications included in this backup.

No Additional Items

Each item of this array must be:

AppInfo

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier of the application.

Must be at least 1 characters long

name Required

Name

Type: string

Human-readable name of the application.

Must be at least 1 characters long

state Required

State

Type: string

Current running state of the application.

Must be at least 1 characters long

snapshot_name Required

Snapshot Name

Type: string

ZFS snapshot name associated with this backup.

Must be at least 1 characters long

created_on Required

Created On

Type: string

Timestamp when the backup was created.

Must be at least 1 characters long

backup_path Required

Backup Path

Type: string

Filesystem path where the backup is stored.

Must be at least 1 characters long

Required roles: DOCKER_READ