Creating a backup of an API Connect configuration

You can back up your API Connect configuration and user data, and store the file on an FTP server by using the command-line interface (CLI).

About this task

To provide a fallback, you can create a backup of your API Connect configuration and store the file on an FTP server. All configuration information from the Cloud Manager, and API Manager, is backed up (which includes all the user data entered in these user interfaces). Analytics data is not backed up. In the future, you can restore the API Connect configuration. For more information, see Restoring an API Connect configuration.

The Developer Portal configuration is backed up separately. For more information, see Backing up and restoring the Developer Portal.

Note: You must take a backup from the Primary Management server in the Management cluster. To identify which server is the primary server, open the Cloud Manager and, in the Clusters page, click the Server details icon for each server in the Management cluster. The Management servers in a cluster automatically synchronize so only the primary Management server backup is required.

Important: You can only restore configurations that are at the same fix pack level that the back up was taken on.

By default, the Management server automatically takes a daily configuration backup at 00:00 UTC, and stores it locally. The performance impact of taking a configuration backup is minimal, and the maximum disk space used for these daily backups is by default 500 MB on /wip. You can access this backup by using CLI commands; for details, see Configuration commands. To turn off the automatic configuration backup process, use the following command:

config autobackup disable

Procedure

Log in to the CLI for the Management server through a Secure Shell (SSH).
For information on logging into, and using the CLI, see The Command Line Interface.
To create a backup of an API Connect configuration and user data, and store the file on an FTP server, you can use either FTP or SFTP.
For FTP, enter the following command:
```
config save apiconfig ftp  <host> [port <portnumber>] [user <username>] [file <filename>]
```
For SFTP, enter the following command:
```
config save apiconfig sftp  <host> [port <portnumber>] user <username> [file <filename>]
```
Where
- host - the name of the host where FTP is running and where the backup configuration file is stored.
- port - the port number that you are accessing.
- user - the user name that is used to log in to FTP.
- file - the absolute path or relative path to the stored file on the FTP server.
Restriction: When you use SFTP, you must specify a user name. Anonymous logins are not allowed with SFTP.

To view the CLI help about the config commands, enter config help.
Make a note of the user ID or password of your Management servers at the time of the backups.
If you change your credentials in the future, you must know the correct login details when you restore the configuration. You might have to update the servers by using the API Connect cloud console. Otherwise, the cloud console cannot communicate with the servers.