docker/ucp backup

Estimated reading time: 1 minute

These are the docs for UCP version 2.2.22

To select a different version, use the selector below.

Create a backup of a UCP manager node


docker container run --log-driver none --rm -i \
    --name ucp \
    -v /var/run/docker.sock:/var/run/docker.sock \
    docker/ucp \
    backup [command options] > backup.tar


This command creates a tar file with the contents of the volumes used by this UCP manager node, and prints it. You can then use the restore command to restore the data from an existing backup.

To create backups of a multi-node swarm, you only need to back up a single manager node. The restore operation will reconstitute a new UCP installation from the backup of any previous manager.


  • During the backup, UCP is temporarily stopped. This does not affect your applications.

  • The backup contains private keys and other sensitive information. Use the --passphrase flag to encrypt the backup with PGP-compatible encryption.


Option Description
--debug, D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, i Run in interactive mode and prompt for configuration values
--id The ID of the UCP instance to back up
--passphrase Encrypt the tar file with a passphrase
ucp, cli, backup