Skip to content

backup

konigle.managers.website.backup

Backup managers for the Konigle SDK.

This module provides managers for backup resources, enabling backup creation, listing, deletion, and restoration operations.

AsyncBackupManager

Bases: BaseBackupManager, BaseAsyncManager

Async manager for backup resources.

create(data) async

Create a new backup.

PARAMETER DESCRIPTION
data

Backup creation data including kind, backup_type, target_id, description, and trigger.

TYPE: BackupCreate

RETURNS DESCRIPTION
Backup

Created backup resource.

restore(id_) async

Restore a backup.

PARAMETER DESCRIPTION
id_

ID of the backup to restore.

TYPE: str

RETURNS DESCRIPTION
Dict[str, str]

Dictionary with restoration status.

BackupManager

Bases: BaseBackupManager, BaseSyncManager

Manager for backup resources.

create(data)

Create a new backup.

PARAMETER DESCRIPTION
data

Backup creation data including kind, backup_type, target_id, description, and trigger.

TYPE: BackupCreate

RETURNS DESCRIPTION
Backup

Created backup resource.

restore(id_)

Restore a backup.

PARAMETER DESCRIPTION
id_

ID of the backup to restore.

TYPE: str

RETURNS DESCRIPTION
Dict[str, str]

Dictionary with restoration status.

BaseBackupManager

base_path = '/backup/api/v1/backups' class-attribute instance-attribute

The API base path for this resource type.

filter_class = BackupFilters class-attribute instance-attribute

The filter class used for listing resources.

resource_class = Backup class-attribute instance-attribute

The resource model class this manager handles.