How to back up

Edge for Private Cloud v4.18.05

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

The backup command:

  1. Stops the component (except for PostgreSQL and Cassandra which must be running to backup).
  2. Creates a tar file of the following directories and files, where component_name is the name of the component:
    1. Directories
      • /opt/apigee/data/component_name
      • /opt/apigee/etc/component_name.d
    2. Files if they exist
      • /opt/apigee/token/application/
      • /opt/apigee/customer/application/
      • /opt/apigee/customer/
      • /opt/apigee/customer/conf/license.txt
  3. Creates a .tar.gz file in the /opt/apigee/backup/component_name directory. The file name has the following form:,hour.min.seconds.tar.gz

    For example:


    For PostgreSQL, the file name has the following form:,hour.min.seconds.dump
  4. 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.