Backing up and Restoring Tenant-specific Data

API Portal Administrator's Guide : Managing Data in API Portal : Backing up and Restoring Tenant-specific Data

Registering Nodes Using the ACC REST Service

Registering Nodes Using the Configuration File

Troubleshooting Backup and Restore Failures

This section covers information on how an API Portal Administrator can back up or restore tenant-specific data.

API Portal is multi-tenant capable and each tenant administrator can manage their data. Generally, the tenant-specific data comprises of

API Portal objects: APIs, Access Keys, and other related data, users, user groups, licenses, and configurations, API documents and files.

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

API Portal analytics: Page views, user registrations, API lifecycle events, access token lifecycle events, provider lifecycle events, and run-time analytics data for APIs.

You can back up and restore tenant-specific data in the following ways:

Using the API Portal Cloud Controller (ACC)

From the API Portal User Interface

Note:

For details on backing up and restoring data through the API Portal UI, see webMethods API Portal Online Help

Prerequisites for Backup and Restore in a Distributed Environment

The following points are to be considered if the API Portal server is installed in a clustered high availability setup.

Note:

If the API Portal is a single node installation, then you can skip this section.

In a typical multi-node setup, the different parts of the application (runnables) are installed on the different nodes (machines). It is important to verify that all the nodes are up and accessible. All the nodes must be registered to the parent node and the API Portal Cloud Controller (ACC) needs to know about your distributed environment. There are a couple of ways to register the different nodes to ACC.

Contact Support | Community | Feedback