Running an on-demand backup of the portal database

When your portal database backup settings are configured, you can use apicup to create an on-demand backup of the portal database.

About this task

A complete portal database backup consists of the following items:

System configuration backup. All configured portal subsystem settings that apply to all sites.
Site backups. Each portal site has its own database backup.

You can backup the system configuration, the sites, or both.

Important: A portal database backup alone cannot be used for disaster recovery. Ensure that you also always have a recent Project directory backup.

Ensure that your portal subsystem is healthy:
```
apicup subsys health-check <subsystem name>
```
When successful, the command returns silently with an exit code of 0.
Create a backup:
```
apicup subsys backup <subsystem name> <flags>
```
Set <flags> according to the type of backup you want:
- To backup the portal system configuration (and not the sites), specify --type system:
```
apicup subsys backup <subsystem name> --type system
```
- To backup a specific portal site or all sites, specify --type site and --site-name:
```
apicup subsys backup <subsystem name> --type site --site-name <site ID>
```
  where <site ID> is a specific site UUID or URL, or to backup all sites set --site-name installed.
- To backup the entire portal subsystem (the system and all installed sites), do not specify any flags:
```
apicup subsys backup <subsystem name> 
```

To view your backups and their status:

apicup subsys list-backups <subsystem name>