About this guide

This guide explains how to configure and manage the components in an API Gateway domain.

Who should read this guide

The intended audience for this guide is API Gateway administrators. For details on installing API Gateway, see the API Gateway Installation Guide.

For details on API Gateway concepts and features, see the API Gateway Concepts Guide.

How to use this guide

This guide should be used with the other guides in the API Gateway documentation set. Before you begin, review this guide thoroughly. The following is a brief description of the contents:

  • API Gateway administration: Gives an overview of the main issues involved in API Gateway administration, how to plan an API Gateway system, and how it interacts with existing infrastructure.
  • Manage an API Gateway domain: Explains how to configure an API Gateway domain, and Admin Node Manager high availability and security.
  • Manage API Gateway operation: Describes how to start and stop the API Gateway, Admin Node Manager, and API Gateway tools, and API Gateway high availability and disaster recovery.
  • Manage API Gateway security: Explains how to configure API Gateway passphrases, certificates, API firewalling, and redaction of sensitive data. This part also explains how to run API Gateway in Federal Information Processing Standards (FIPS) mode.
  • Deploy API Gateway configuration: Describes how to deploy and manage updates to API Gateway configuration.
  • Monitoring and metrics: Explains how to perform root cause analysis using real-time monitoring of API services and message traffic, and how to configure storage of metrics for historic traffic in a relational database.
  • Troubleshoot your API Gateway installation: Describes how to configure an API Gateway logging, events, and trace, and how to fine-tune performance.
  • Manage user access: Explains how to manage API Gateway and Admin users, and how to configure Role-Based Access Control (RBAC) with examples from Active Directory and OpenLDAP.
  • Manage network-level settings: Describes how to configure a DNS service with wildcards for virtual hosting.
  • Manage ActiveMQ messaging: Explains how to manage the Apache ActiveMQ messaging broker embedded inAPI Gateway.
  • API Gateway settings reference: Provides reference information on API Gateway configuration settings.

Related Links