Backup and restore

Overview

Data is an integral part of Developer Portal and contains all the information about your APIs, packages, and your customized themes. Hence, it is essential to manage data efficiently. To protect any accidental loss of data, you must take regular backups of your data and save in a fail-proof repository.

Developer Portal provides you an option through the UI to create backup of your data and restore any backed up data.

The following sections explain the backup and restore processes.

How do I take a backup?

This use case starts when you want to create a backup of your data and ends when you have successfully created the backup.

Before you begin:

Ensure that you have the API Administrator privilege.

To take backup:

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Backup and restore from the left pane.

  3. Select Backup.

  4. Select the Modules that you want to be included in the backup.

    Available options are:

    • Collaboration. Collaboration groups, posts and discussions related data, and comments or posts related to APIs.

    • Core. Includes the meta data information of APIs and packages, access tokens of APIs, Applications, Communities, and Providers.

    • Theme. Includes the UI customization templates.

    • User. Includes details of users, user groups, and user privileges.

    • Analytics. Includes Page views, User registrations, API lifecycle events, and run-time analytics data for APIs

  5. Click Backup.

    A dialog box appears to allow you save the backup file.

  6. Click Save.

    The backup data, in zipped folder format, is saved to the default downloads location of your browser.

    Note: Ensure that your browser setting allows pop-ups.

Next steps:

How do I restore data from a backup file?

This use case starts when you have a backup file to be restored and ends when you have successfully restored the backup data in your environment.

Important: When you restore data in an environment that already has User data, it is not overwritten by the restored data. The restored data is integrated with the existing data. Data of other types in the target environment are overwritten with the data from the backup file.

Before you begin:

Ensure that you have the API Administrator privilege.

To restore from a backup:

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Backup and restore from the left pane.

  3. Select Restore.

  4. Click Browse file and select the backup file that has to be restored.

  5. Select the Modules that must be restored.

  6. Click Restore.

    The selected data is restored in your environment.