Manage API Gateway deployments


When connected to the Admin Node Manager server in Policy Studio, you can deploy configurations to API Gateway instances running in groups in a domain. In Policy Studio, the Group / API Gateway topology view enables you to edit the configuration of currently running API Gateway instances. You can update the downloaded configuration, and deploy it to the server, where it can be reloaded later. You can deploy modified configuration to multiple API Gateway instances managed by Policy Studio. You can also create groups and API Gateway instances.

The web-based API Gateway Manager enables you to deploy configurations to API Gateway instances running in groups in a domain, to create groups and API Gateway instances, and to manage Admin users. In this way, Policy Studio and the API Gateway Manager enable policy developers and administrators to centrally manage the policies that are enforced at all nodes throughout the network.

In addition, Policy Studio enables you to compare and merge differences between versions of the same policy. Policies can be merged, and deployed to any running instance that is managed by Policy Studio. One of the most powerful uses of this centralized management capability is in transitioning from a staging environment to a production environment. For example, policies can be developed and tested on the staging environment, and when ready, they can be deployed to all instances deployed in the production environment.

Connect to a server in Policy Studio

Before starting Policy Studio, you should first ensure that the Admin Node Manager and the server instance that you wish to connect to have been started.

When Policy Studio starts up, click a link to a server to display the Open Connection dialog. You can use this dialog to specify Connection Details (for example, host, port, user name, and password) or to specify Saved Sessions. If you wish to connect to the server using a non-default URL, click Advanced, and enter the URL. The default Admin Node Manager URL is:


Alternatively, you can connect to a server configuration file by clicking the Open File button. For more details on connecting using a server URL, configuration file, or deployment archive,

[Note] Note

You must connect to the Admin Node Manager server to deploy API Gateway configuration or manage multiple API Gateway instances in your network.

When the connection to the server has been made, the Group / API Gateway topology view is displayed. This displays the list of server instances currently managed by the Admin Node Manager in Policy Studio, and enables you to manage the configuration for server instances.

Edit a server configuration in Policy Studio

The Group / API Gateway topology view lists all available instances in each group. Double-click an instance name in the list to load its active configuration. Alternatively, right-click an instance name, and select Edit Configuration. The active server configuration is loaded and displayed in the following format: InstanceName [HostName:Port] (for example, test_server []).

When an active server configuration is loaded, its services are displayed under the Listeners node in the Policy Studio tree on the left. Expand one of the top-level nodes in the tree to display additional details (for example, Business Services, External Connections, Resources, Libraries, or Settings).

When editing an active server configuration, you can deploy updates using the Deploy button in the toolbar (alternatively, press F6). You can also deploy configuration packages in the Group / API Gateway topology view. For more details, see Deploy API Gateway configuration.

Manage deployments in API Gateway Manager

In the web-based API Gateway Manager tool, the TOPOLOGY section on the Dashboard tab enables you to create groups and API Gateway instances, and to deploy configuration. For details on how to access the API Gateway Manager, see Start the API Gateway tools.

Compare and merge configurations in Policy Studio

You can compare and merge differences between the currently loaded API Gateway configuration with a configuration stored in a deployment package (.fed file). Click the Compare button on the Policy Studio toolbar to select a .fed file to compare the current configuration against. The results are displayed in the Compare/Merge tab.

For example, you can view the differences made to particular fields in an Authentication filter that occurs in both configurations. When a difference is located, you can merge the differences, and thereby update the fields in the Authentication filter in the current configuration with the field values for the same Authentication filter in the deployment package.

For more details,

Manage Admin users in API Gateway Manager

You can add new Admin Users to enable role-based access to the API Gateway configuration managed by Policy Studio and API Gateway Manager. The default admin user has access to all API Gateway features in Policy Studio and API Gateway Manager, and can view and modify all API Gateway configurations.

To add or remove Admin Users, click the Settings > Admin Users tab in the API Gateway Manager. For more details, see Manage Admin users.

For more details on role-based access,

Configure policies in Policy Studio

You can use Policy Studio to manage the configuration of your policies, which can then be deployed to running instances of Oracle API Gateways.