# backup

Source: https://zotonic.com/docs/1522/backup

URI: https://zotonic.com/id/1522

Language: en



Model for backup configuration and operational status, including backup permissions, listing, directory, encryption settings, and active backup state.

Available Model API Paths
-------------------------

| Method | Path pattern                 | Description                                                                      |
| ------ | ---------------------------- | -------------------------------------------------------------------------------- |
| `get`  | `/admin_panel/...`           | Return backup admin-panel configuration/state map as provided by `backup_config:admin_panel/1`. |
| `get`  | `/allow_manual_backup/...`   | Return whether the current site/user is allowed to start manual backups (`backup_config:allow_manual_backup/1`; requires `use` on `mod_backup`). |
| `get`  | `/allow_backup_download/...` | Return whether backup file download is allowed (`backup_config:allow_backup_download/1`; requires `use` on `mod_backup`). |
| `get`  | `/daily_dump/...`            | Return configured daily dump setting as binary value (`backup_config:daily_dump/1`; requires `use` on `mod_backup`). |
| `get`  | `/encrypt_backups/...`       | Return whether backup archives are configured to be encrypted (`backup_config:encrypt_backups/1`; requires `use` on `mod_backup`). |
| `get`  | `/has_encrypt_password/...`  | Return whether a non-empty backup encryption password is configured (`backup_config:encrypt_password/1`; requires `use` on `mod_backup`). |
| `get`  | `/list_backups/...`          | Return available backup files/entries from `mod_backup:list_backups/1` (requires `use` on `mod_backup`). |
| `get`  | `/is_backup_in_progress/...` | Return whether a backup job is currently running (`mod_backup:backup_in_progress/1`; requires `use` on `mod_backup`). |
| `get`  | `/directory/...`             | Return the resolved backup directory path used for backup files (`backup_create:dir/1`; requires `use` on `mod_backup`). |

`/+name` marks a variable path segment. A trailing `/...` means extra path segments are accepted for further lookups.

License: 

Attribution: 

Related resources: https://zotonic.com/api/agent/related/1522?language=en


## API access

- [API help](<https://zotonic.com/api-help>)
- [OpenAPI specification](<https://zotonic.com/openapi.json>)
- [This resource as JSON](<https://zotonic.com/api/agent/resource/1522?language=en>)