Send feedback
How to back up
Caution: This documentation covers Edge for
Private Cloud 4.18.05, which is no longer supported. Google does not provide security
patches, bug fixes, or technical support for this version. The current supported
version is 4.54.00. See the
Edge for Private Cloud documentation for
the current version, or All versions to compare
releases.Edge for Private Cloud v4.18.05
Note: When backing up a complete Edge installation, you must back up
all components. See "What to Backup" at Backup and restore
for more.Use the following command to perform a backup:
/opt/apigee/apigee-service/bin/apigee-service component_name backup Where component_name is the name of the component. Possible values include:
apigee-cassandra (Cassandra)apigee-openldap (OpenLDAP)apigee-postgresql (PostgreSQL database)apigee-qpidd (Qpidd)apigee-sso (Edge SSO)apigee-zookeeper (ZooKeeper)edge-management-server (Management Server)edge-management-ui (new Edge UI)edge-message-processor (Message Processor)edge-postgres-server (Postgres Server)edge-qpid-server (Qpid Server)edge-router (Edge Router)edge-ui (Classic UI)
For example:
/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra backup Warning: The backup utility writes the generated backup file to
/opt/apigee/backup/component_name where component_name is the name of the
component. Because you can generate many backup files, and because these files can get large, you
can mount a separate disk at /opt/apigee/backup just for backup files.Note: For components not associated with a data store, such as the
Router or Message Processor, the backup command still creates a backup file containing
configuration and other information.Note: For PostgreSQL only, you can optionally create a network storage
snapshot as an alternative to using the Apigee backup command. This snapshot cab be useful
because the Apigee backup command takes time to run and PostgreSQL data generated while the
backup runs could be omitted from the resulting .dump file.The backup command:
Stops the component (except for PostgreSQL and Cassandra which must be running to
backup).
Creates a tar file of the following directories and files, where
component_name is the name of the component:
Directories
/opt/apigee/data/component_name /opt/apigee/etc/component_name .d
Files if they exist
/opt/apigee/token/application/component_name .properties/opt/apigee/customer/application/component_name .properties/opt/apigee/customer/defaults.sh/opt/apigee/customer/conf/license.txt
Creates a .tar.gz file in the /opt/apigee/backup/component_name directory. The
file name has the following form:
backup-year .month .day ,hour .min .seconds .tar.gz For example:
backup-2018.05.29,11.13.42.tar.gz For PostgreSQL, the file name has the following form:
year .month .day ,hour .min .seconds .dump
Restarts the component (except for PostgreSQL, Cassandra, ZooKeeper, and OpenLDAP which are
not restarted).
If you have multiple Edge components installed on the same node, you can back up them all with
a single command:
/opt/apigee/apigee-service/bin/apigee-all backup This command creates a backup file for each component on the node.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-10-16 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-10-16 UTC."],[],[]]
