Administer API Gateway

Configure and manage the components in an API Gateway domain.

Introduction to API Gateway administration

Introduces the main issues involved in API Gateway administration.

Plan an API Gateway system

Discover the most important factors to look at when architecting an API Gateway deployment.

Configure an API Gateway domain

Use the managedomain command to configure a managed API Gateway.

Manage domain topology in API Gateway Manager

Use the topology view in API Gateway Manager to manage an existing API Gateway domain.

Configure API Gateway high availability

Recommended architecture for an API Gateway HA production environment.

Configure Admin Node Manager high availability

Use managedomain to configure ANM high availability.

Operate and maintain API Gateway

API Gateway operations, including starting and stopping, zero-downtime shutdown, and backup and disaster recovery.

Run API Gateway on privileged ports

Grant the required privileges to API Gateway processes running as non-root to listen on privileged ports.

Configure encryption passphrase

Encrypt API Gateway configuration data using an encryption passphrase.

Manage certificates and keys

Import CA certificates, and import and create server certificates and private keys in the certificate store.

Hide sensitive data

Redact sensitive content message content types such as HTTP headers, JSON, XML, HTML form, and plain text.

Configure an advisory banner

Display an advisory warning message about unauthorized use of API Gateway when establishing a successful user session from Policy Studio or API Gateway Manager.

Manage API firewalling

Enable API firewalling on an API Gateway interface in Policy Studio, and monitor API firewalling in API Gateway Manager.

Run API Gateway in FIPS mode

Run an API Gateway instance or a Policy Studio client in FIPS mode.

Manage API Gateway deployments

Use Policy Studio or API Gateway Manager to deploy API Gateway configuration, and perform a zero downtime policy deployment in a multi-node API Gateway environment with a load balancer.

Monitoring and metrics

Monitor services in API Gateway Manager, and configure an API Gateway and Node Manager to store metrics on historic traffic.

Configure logging and events

Learn about the different types of logs and events that are displayed in API Gateway Manager, and how to configure them.

Configure open logging

Consolidate transaction event data, traces, and system metrics stored by API Gateway, and visualize and analyze them in external observability systems.

Configure diagnostic trace

Configure and view diagnostic trace and debugging information about API Gateway runtime execution.

Performance tuning

Optimize API Gateway performance using various configuration options.

Manage users

API Gateway users provide access to the messages and services protected by API Gateway, while admin users provide access to the API Gateway configuration management features available in Policy Studio, Configuration Studio, and API Gateway Manager.

Configure Role-Based Access Control (RBAC)

Restrict system access to authorized users based on their assigned roles.

Authentication and RBAC with Active Directory

Use LDAP to authenticate and perform Role-Based Access Control (RBAC) of API Gateway management services, and reconfigure API Gateway to use a Microsoft Active Directory LDAP repository.

Authentication and RBAC with OpenLDAP

Use LDAP to authenticate and perform Role-Based Access Control (RBAC) of API Gateway management services, and reconfigure API Gateway to use OpenLDAP as the LDAP repository and Apache Directory Studio as an LDAP browser.

Manage embedded ActiveMQ messaging

The Messaging view in API Gateway Manager enables you to manage the Apache ActiveMQ messaging broker that is embedded in the API Gateway instance.

Set up DNS wildcards for virtual hosts

Configure a DNS service with wildcards for virtual hosting. This is a prerequisite for configuring the API Gateway or API Manager for virtual hosts.

Get help with API Gateway

Access help and documentation for API Gateway, find your installed version (including any installed service pack and patches), and what other information you need when contacting Axway Support.