You must perform this operation on old instance of API Gateway. For a cluster, you must do this at each node as quiesce mode is enabled at the instance level.

API Gateway data in the API Data Store is migrated in two phases. In the first phase, only the design time data like APIs, applications, and policies are migrated. The runtime data like audit logs, transaction logs, performance metrics, and so on are migrated in the next phase (after the runtime transactions to the old instance are stopped). This is performed after the new instance is up and running with the new data and runtime traffic is allowed to it.

Before migrating design time data in the first phase, all the updates to them through UI and REST APIs must be blocked. This can be achieved by the quiesce mode capability available in API Gateway.

You can use the following API to enable quiesce mode for design time in the old instance of API Gateway .

If the invocation is successful, the API returns 200 OK message.

Now all the design time invocations to the old instance are blocked and API Gateway returns 503 message to the client. Only the following requests are allowed:

When the quiesce mode for design time is complete, API Gateway sends out a notification with the result details through registered webhooks. You can also invoke the following REST API to check for the current status of the operation.

A Success status message implies that quiesce mode for design time is completed.

If the quiesce mode for design time API invocation fails with an error or the status returned with a failure, you must stop execution of the next steps and disable the quiesce mode for design time in all the nodes and bring them back to normal state. In this case, you must contact Software AG support team.