SSAQ10_11.1 - Documentation Index

Table of Contents

• Welcome
• IBM webMethods API Gateway Documentation
• Release Readme
  • Critical Information
  • Known Issues
  • Usage Notes
  • Fixes Included in Each Release
  • Other Resolved Issues
  • Documentation Changes
  • Terminology Changes
  • Added, Removed, Deprecated, or Changed Items
• What is API Gateway?
• Deployment
  • How to install webMethods API Gateway using Docker?
  • How Do I Install webMethods API Gateway using IBM Installer?
  • Connecting to External Database and Kibana
  • Launching and logging on to webMethods API Gateway
  • IBM License Service for API Gateway
    • Enabling IBM License Service for API Gateway in Kubernetes
    • Enabling IBM License Service for API Gateway in OpenShift
  • Troubleshooting Tips: Starting and configuring Elasticsearch and Kibana
• Create your first REST API
  • Creating a REST API by importing an API from a file
  • Creating a REST API by importing an API from a URL
  • Testing a REST API
• Create your first SOAP API
  • Creating a SOAP API by importing an API from a file
  • Creating a SOAP API by importing an API from a URL
  • Testing a SOAP API using SOAPUI
  • Testing a SOAP API using curl
• Create your first GraphQL API
  • Creating a GraphQL API by Importing an API from URL
  • Creating a GraphQL API by Importing an API from a File
  • Testing a GraphQL API using Postman
• Publish an API to Developer Portal
• Monitor your API
• Debug an API
• API Mocking
• Authenticate your API
• Rate limit your APIs
  • Configuring rate limit for an API
  • Testing the ratelimit API
• API Transaction Logging
• Request and Response Transformation
  • Use case 1: E-Commerce API Request Header Transformation
  • Use case 2: Response Message Transformation
  • Testing Request and Response Transformation Policies
• Global Policies
• Routing Policies
• Validate API Specification
• Concepts
  • Security Considerations
  • API Gateway Components
  • Deployment Models
    • Single-node Deployment
    • Multi-node Cluster Deployment
      • High Availability, Disaster Recovery, and Fault Tolerance
      • Disaster Recovery vs Fault Tolerance
      • Cluster Deployment Options
  • Elasticsearch and Kibana
  • Reference Architectures
    • Recommended High Availability Architecture
    • High Availability and Disaster Recovery (HADR) solution
    • High Availability and Fault Tolerance (HAFT) solution
  • API Analytics
  • Containerization
  • Product Configurations
• Deployment Configurations
  • Cluster Deployment
    • API Gateway Cluster Configuration
    • Enabling Clustering for API Gateway through the User Interface
    • Elasticsearch Cluster Configuration
      • Configuring Elasticsearch Cluster
      • Adding New Nodes to an Elasticsearch Cluster
    • Load Balancer Configuration
    • Ports Configuration
    • Configuring Multiple Instances of API Gateway in a Single Installation
  • Paired Deployment
    • Configuring Reverse Invoke Setup
    • Paired Deployment with Integration Server in Green Zone
    • Importing a Certificate and Mapping to User
    • Troubleshooting Tips: API Gateway and DMZ Connectivity
  • Connecting to an Elasticsearch
  • Connecting to Kibana
  • Externalizing Configurations
    • Using the Externalized Configuration Files
    • Default Scenario
    • Troubleshooting tips: Externalized Configuration
    • Connecting IBM webMethods API Gateway to API Control Plane
      • API Control Plane Agent Configuration
      • API Control Plane Agent Properties
      • API Control Plane Agent Configuration using Properties
      • API Control Plane Agent Configuration using YAML file
      • Connecting API Gateway to API Control Plane using API Gateway UI
      • Logger Configuration
      • Example: Usage Scenarios of Connecting containerized API Gateway to API Control Plane using Properties
      • Example: Usage Scenarios of Connecting Non-containerized API Gateway to API Control Plane using Properties
  • API Gateway, Elasticsearch, Kibana, OpenSearch and OpenSearch Dashboard
• Administering API Gateway through API Gateway User Interface
• Starting and Stopping API Gateway Using Scripts
• Starting, Stopping, and Restarting Elasticsearch on LINUX
• Data Management
  • Types of Data and their Storage
  • Difference between Archive and Backup
  • Data Housekeeping
    • Archive and Purge using API
    • Restoring Archived Data using API
    • Archive and Purge using UI
      • Archiving Data
      • Purging Data
    • Restoring Archived Data using UI
    • List of Indexes that can be archived or purged
    • Job Listing
    • Archive and Purge Configuration
  • Data Backup
    • Backup Requirements Analysis
    • Backup Repository Capacity Sizing
    • Backup Considerations
    • Backup Operation
    • Data Store Backup
      • Backup Repository
        • Configuring a File System Repository
        • Configuring a Container Repository
        • Configuring a Cloud Repository in Amazon S3
      • Creating Elasticsearch Backup
    • Advanced Backup Options
      • Creating Backup of specific Indexes
      • Creating Rollover of an Index
      • Viewing Backup Files List
      • Verifying Backup Status
      • Deleting a Backup File
    • Platform Data Backup
      • Creating Platform Data Backup using API
      • Creating Platform Data Backup Manually
    • Restore Operation
      • Restoring Elasticsearch Backup
      • Restoring Backup of specific Indexes
      • Verifying Restore Status
      • Restoring Platform Data backed up using the Script
      • Restoring the manually backed up Platform data
    • Adding New Nodes to an Elasticsearch Cluster
  • Troubleshooting Tips: Elasticsearch
• Monitoring API Gateway
  • Cluster-level Monitoring
  • Troubleshooting: Cluster-level Monitoring
  • Node-level Monitoring
    • Monitoring API Gateway
      • Monitoring API Gateway through Prometheus Metrics
      • Application Metrics
      • API Operational Metrics
      • Monitoring API Gateway Health
      • System Metrics
      • Monitoring API Gateway through Dashboards
        • API Gateway Dashboard
        • Creating custom dashboards
        • Kibana Limitation
      • Runtime Events and Metrics Data Model
        • API Gateway
        • Developer Portal
        • Audit Log
        • CentraSite
        • Elasticsearch
        • Email
        • JDBC
        • Local Log
      • Troubleshooting: Monitoring API Gateway
      • How Do I Generate Thread Dump?
      • How Do I Generate Heap Dump?
      • Causes for timeout errors
    • Monitoring Elasticsearch
      • Application Metrics
      • Infrastructure Metrics
        • Container Metrics
      • Troubleshooting: Monitoring Elasticsearch
    • Monitoring Kibana
    • Troubleshooting Tips: Monitoring Performance
• General Administration Configuration
  • Clusters and Load Balancers
    • Configuring Load Balancer URLs
  • Configuring Extended Settings
  • Configuring API Fault Settings
  • Approval Configuration
    • Configuring Approvals for Creating an Application
    • Configuring Approvals for Registering Application
    • Configuring Approvals for Updating Application
    • Configuring Approvals for Subscribing Package
    • Configuring Approvals for Updating Subscription
    • Configuring Approvals for Deleting Subscription
    • How Do I Configure the Approval Process for Ownership Change of Assets?
    • Email templates variable
    • Approval Requests
      • Deleting Requests
  • Outbound Proxy
    • Configuring Proxy Server Alias
    • Modifying a Proxy Server Alias
    • Deleting a Proxy Server Alias
  • Proxy Bypass
    • Adding a Proxy Bypass
    • Modifying a Proxy Bypass
    • Deleting a Proxy Bypass
  • URL Aliases
    • Creating URL Alias
      • Using Port Mappings with URL Alias
      • Adding Port Mapping to URL Alias
      • Deleting Port Mapping for URL Alias
    • Enabling Partial Matching of URL Aliases
    • Modifying a URL Alias
    • Deleting a URL Alias
    • Example: Usage Scenarios of URL Aliases
  • Custom Content-types
    • Configure Custom Content-types
  • Cache Configuration
    • Configuring Cache to Improve Performance
  • Application Log Configurations
    • Configuring Log Levels
    • Downloading the Log Files
    • Logs Housekeeping
    • API Gateway Log Aggregation with Fluentd
    • Fluentd.conf
    • Configuring Fluentd Sidecar Container in Kubernetes
  • Configuring API Callback Processor Settings
  • Messaging
    • Creating a JNDI Provider Alias
    • Creating a JMS Connection Alias
  • Web Services Endpoint Alias
    • Creating an Endpoint Alias for a Provider Web Service Descriptor
    • Creating an Endpoint Alias for a Consumer Web Service Descriptor
  • JMS Triggers
    • Updating JMS triggers
• Users, Groups, and Teams
  • Adding a User
  • Modifying User Details
  • Deleting a User
  • User Groups
    • Adding a Group
    • Modifying a Group
    • Deleting a Group
    • API Gateway Functional Privileges
  • Team Support
    • Teams management using API Gateway
    • Enabling Team Support
    • Creating Teams
    • How do I Assign Teams during Asset Creation?
    • How do I Assign Teams Using Team Assignment Rule?
    • How do I Modify Teams Assigned to an API?
    • How do I Change the Ownership of Multiple Teams?
    • Team Support Considerations
  • Setting Password Restrictions
  • Setting Password Expiry Restrictions
  • Configuring Account Locking Settings
  • Unlocking User Accounts
  • Restricting Login and Access accessibility to User Accounts
  • Configuring API Gateway to Use LDAP
  • Managing LDAP Directories
  • User Settings and Preferences
    • Changing Your Account Settings
    • Changing Your Password
    • Changing Your Display Language
    • Viewing Your Roles and Permissions
• Destination Configuration
  • Configuring Events for webMethods API Gateway Destination
    • Troubleshooting Tips: API Gateway Destination
  • Configuring webMethods Developer Portal Destination
    • Troubleshooting Tips: Developer Portal Destination
  • Configuring Events for Developer Portal Destination
  • Configuring API Control Plane
  • Configuring Transaction Logger Destination
  • Configuring CentraSite Destination
  • Configuring Events for CentraSite Destination
  • Configuring Events for Database Destination
  • Configuring Elasticsearch Destination
    • Troubleshooting Tips: Elasticsearch Destination
  • Configuring Events for Elasticsearch Destination
  • Configuring Email Destination
    • Configuring Email Templates
  • Configuring SNMP Destination
  • Configuring Events for SNMP Destination
  • Custom Destination
    • How Do I Publish Data to an External Endpoint using Custom Destination?
      • How Do I Publish API-specific Traffic Monitoring Data to a Custom Destination?
    • How Do I Publish Data to an Integration Server Service using Custom Destination?
    • How Do I Publish Data to an AWS Lambda Function using Custom Destination?
    • How Do I Publish Data to a Message Queue using Custom Destination?
  • Troubleshooting Tips: API Gateway - Developer Portal Integration
• Audit Logging
  • Configuring Audit Logs
  • Viewing Audit Logs
  • Downloading Audit Logs
• System Settings
  • Modifying webMethods API Gateway Configuration Parameters
  • SAML SSO
    • SAML Assertion
    • How to enable SAML SSO in API Gateway?
    • Precedence in Group Mapping
    • Troubleshooting Tips: SSO configuration
• Configuring External Accounts
  • Adding a Service Registry
  • Removing a Service Registry
  • Configuring an AWS Alias
  • Configuring Integration Server Instance for API Implementation
• Configuration Types and Properties
  • webApp Configuration Properties
  • API Gateway Package Configuration Properties
  • Troubleshooting Tips: wmAPIGateway Package
• Overview of Security Configuration in API Gateway
• Keystore and Truststore
  • Configuring Keystore Information
  • Modifying Keystore Information
  • Deleting Keystore Information
  • Configuring Truststore Information
  • Modifying Truststore Information
  • Deleting Truststore Information
  • Configuring Keystore and Truststore Information for Inbound Messages
  • Configuring Keystore and Truststore Information for Outbound Connections
• Ports
  • Adding an HTTP Port
  • Adding an HTTPS Port
  • Adding an API Gateway External Port
  • Configuring the API Gateway Internal listener
  • Configuring the WebSocket Listener
  • Configuring IP Access Mode for a Port
    • Allowing Access to All IP Hosts
    • Denying Access to All IP Hosts
  • Configuring Access Mode for a Port
  • Deactivating Default Primary Port
  • Configuring API Gateway UI Shutdown Port
• Global IP Access Settings For Ports
  • Allowing Connections from Specified Hosts
  • Denying Connections from Specified Hosts
  • If You Inadvertently Deny IP Access to All Hosts
  • Configuring Restriction to IP Address based on Authentication
• SAML Issuer
• Custom Assertions
  • Creating a Custom Assertion
  • Viewing Custom Assertion List and Assertion Configuration
  • Modifying Custom Assertion
  • Deleting Custom Assertion
  • Example: Custom Assertions
• Kerberos Settings
  • Configuring webMethods API Gateway to Use Kerberos
• Master Password Management
  • Backing up the Password and Master Password Files
  • Updating the Master Password
  • Managing Master Password Expiry Interval
  • Advanced Configuration to Manage Master Password
  • Restoring the Password and Master Password Files
  • Resetting the Master Password
• OAuth, JWT, and OpenID Configuration
  • Configuring the Internal Authorization Server
  • Adding a Provider
  • Adding an External Authorization Server
  • OAuth or OpenID Scopes
  • Viewing Scope Mapping Details
  • Viewing Provider List and Provider Configuration
  • Modifying the Provider Configuration
  • Viewing Authorization Server List and Server Configuration
  • Modifying Authorization Server Configuration
  • Deleting an Authorization Server
  • Deleting a Provider
  • Configuring Communication Details for Microgateway
  • Removing Expired OAuth Tokens
  • Revoking OAuth Tokens
• Threat Protection Policies
  • Configuring Global Denial of Service Policy
  • Configuring Denial of Service by IP Policy
  • Managing Denied IP List
  • Configuring Rules
  • Registering a Mobile Device or Application
  • Configuring Alert Settings
• Securing API Gateway Communication
  • How Do I Secure API Gateway Server Communication with API Clients?
  • How Do I Secure API Gateway Server Communication with Backend Services?
  • How do I Secure API Gateway User Interface Communication?
  • How do I Configure a Secure Communication Channel between API Gateway and Developer Portal?
  • How do I Secure Communication between API Gateway Server and Elasticsearch or OpenSearch?
    • Creating a Custom Keystore with Self-Signed Certificates
  • How do I Secure API Gateway User Interface Communication with Kibana or OpenDashboard?
  • How do I Secure Communication between Elasticsearch and Kibana?
  • How do I Secure Communication between OpenSearch and OpenSearch Dashboards?
• Considerations for Containers and Container Orchestration
• Docker Configuration
  • API Gateway Container Cluster Configuration
  • Running API Gateway Docker Containers with Docker Compose
    • Running a Single API Gateway and an Elasticsearch Container
    • Running Clustered API Gateway Containers and external Elasticsearch Containers
    • Running Clustered API Gateway and Elasticsearch Containers and a Kibana Container
  • API Gateway Docker Container with Elasticsearch, Kibana, OpenSearch and OpenSearch Dashboard
• Kubernetes Support
  • Deploying API Gateway Pod with API Gateway and Elasticsearch Containers
  • Deploying API Gateway Pod with API Gateway Container connected to an External Elasticsearch Kubernetes Service
  • API Gateway Clustering on Kubernetes
  • Kubernetes Sample Files
  • Helm Chart
  • Using Helm to Start the API Gateway Service
  • OpenShift Support
    • Running the API Gateway Docker Image with the sagadmin User
    • OpenShift Sample Files
• High Availability
  • Disaster Recovery vs Fault Tolerance
  • Keypoints about High Availability and Disaster Recovery (HADR) solution
  • Keypoints about High Availability and Fault Tolerance (HAFT) solution
• High Availability and Disaster Recovery
  • What is Cold Standby Mode?
    • How Do I Set Up Data Center in Cold Standby Mode?
    • How Do I Set Up Data Center in Cold Stand By Mode With Backup of Assets Data Only?
  • What is Warm Standby Mode?
    • How Do I Set Up Data Center in Warm Standby Mode?
• High Availability and Fault Tolerance
  • What is Hot Standby Mode?
  • What is Active-Active Mode?
  • Data Synchronization in Hot Standby and Active-Active Modes
  • How Do I Set Up the Data Centers in Hot Standby Mode Using Basic Operation?
  • How Do I Set Up the Data Centers in Hot Standby Mode Using Composite Operation?
  • How Do I Set Up the Data Centers in Active-Active Mode Using Basic Operation?
  • How Do I Set Up the Data Centers in Active-Active Mode Using Composite Operation?
  • How does Cross-DC Support Detect Data Center Failures?
    • How Do I Monitor the Health Status of the Data Center?
  • How Do I Bring Down a Single Data Center from Active-Active or Hot Standby Mode to Standalone Mode?
  • How Do I Bring Down Multiple Data Centers from Active-Active or Hot Standby Mode to Standalone Mode?
  • How Do I Read the Current Configuration of the Data Center?
  • Cross-DC Extended Settings
• Hardware and Product Configurations
  • Resource Sizing Guidelines
  • Logging Configurations
  • Product Configurations Guidelines
• Changing the JVM Heap Size to Tune API Gateway Performance
• Data Separation
  • Storing Analytics Data in Elasticsearch
  • Configuring Analytics Data Store using UI
  • Configuring Analytics Data Store manually
  • Connecting to Analytics Data Store
• Scaling
  • Scaling up API Gateway
  • Scaling up API Gateway in a Reverse Invoke setup
  • Scaling up Elasticsearch
  • Scaling down API Gateway
  • Scaling down API Gateway in a Reverse Invoke setup - DMZ Zone
  • Scaling down API Gateway in a Reverse Invoke setup - Green Zone
  • Scaling down Elasticsearch
• Removing User Data
• Defining and Managing APIs
• Creating an API by Importing an API from a File
• Creating an API by Importing an API from a URL
• Creating an API from Scratch
  • Handling APIs of larger size
  • Creating a REST API from Scratch
  • Creating a WebSocket API from Scratch
• Viewing API List and API Details
  • REST API Details
  • SOAP API Details
  • OData API Details
  • GraphQL API Details
• Searching Data in API Gateway
• Filtering APIs
• Configuring the Number of APIs listed on a Page
• Modifying API Details
• Updating APIs
  • Updating an API by Importing an API from a File
  • Updating an API by Importing an API from a URL
• Exporting Specifications
• Attaching Documents to an API
• API Grouping
• API Tagging
  • Adding Tags to an API
• Versioning APIs
  • Creating New API Version
• Deleting APIs
  • Deleting a Single API
  • Deleting Multiple APIs in a Single Operation
• Example: Managing an API
• CentraSite Provided APIs
• API Implementation
• API Mocking
  • Enabling API Mocking
  • Modifying API Mocking Details
  • Custom Replacer
• Consumer Applications
  • Creating an Application
  • Viewing List of Applications and Subscriptions
  • Regenerating API Access Key
  • Modifying Application Details
  • Registering an API with Consumer Applications from API Details Page
  • Suspending an Application
  • Activating a Suspended Application
• Policies
  • Transport
    • Enable Bulkhead
      • Enabling bulkhead for APIs at the API level
      • Bulkhead feature considerations
    • Enable HTTP/HTTPS
    • Set Media Type
    • Enable JMS/AMQP
      • Configuring webMethods API Gateway for JMS with AMQP Protocol
      • Using Enable JMS/AMQP for a SOAP API
      • Using Enable JMS/AMQP for a REST API
  • Identify and Access
    • Identify & Authorize
      • OAuth Authentication in webMethods API Gateway
        • Securing APIs using OAuth 2.0 in API Gateway with Local Authorization Server
        • Securing APIs using OAuth 2.0 with API Gateway as Resource Server and Remote Integration Server as Authorization Server
        • Securing APIs using OAuth 2.0 in API Gateway using Third Party Authorization Server
        • Securing APIs Using OAUTH 2.0 In API Gateway Using External Ports
        • Defining Multpile OAuth 2.0 Scopes in API Gateway
        • Retrieving OAuth Token
      • JWT Authentication Use case and Workflow
        • Retrieving JWT Token
        • Retrieving JWT Token with Claim
      • OpenID Authentication Use case and Workflow
      • Secure API using OAuth2 with refresh token workflow
        • Configuring OAuth2 Authentication with Refresh Token
        • Refresh Token Process Flow
        • How to get the access token with resource owner permission?
        • How to get the access token without resource owner permission using refresh token in the subsequent attempts?
      • Securing Access Token Calls with PKCE
        • How do I enforce PKCE globally?
        • How do I secure the access token with Authorization Code (With PKCE) grant type using postman?
        • How do I secure the access token by directly calling API Gateway's REST APIs?
        • How do I enforce PKCE selectively for each access token call?
        • How do I generate code verifier and code challenge using JAR files?
    • Inbound Auth - Message
    • Authorize User
  • Request Processing
    • Validate API Specification
    • Request Transformation
    • Invoke webMethods IS
    • Data Masking
  • Routing
    • Straight Through Routing
    • Custom HTTP Header
    • Outbound Auth - Transport
    • Content-based Routing
    • Conditional Routing
    • Dynamic Routing
    • Load Balancer Routing
    • Outbound Auth - Message
    • JMS/AMQP Policies
      • JMS/AMQP SOAP Routing
      • JMS/AMQP REST Routing
    • JMS/AMQP Properties
  • Traffic Monitoring
    • Log Invocation
      • Uncompressing a payload
    • Traffic Optimization
    • Service Result Cache
    • Monitor Performance
    • Monitor SLA
  • Response Processing
    • Validate API Specification
    • Response Transformation
    • Invoke webMethods IS
    • Data Masking
    • CORS
  • Error Handling
    • Conditional Error Processing
    • Data Masking
  • Policy Validation and Dependencies
  • Variable Framework
  • Custom Policy Extension
    • How do I Invoke an API through HTTP or HTTPS using Custom Extension?
    • How do I Invoke an IS Service using a Custom Extension?
    • How do I Invoke an AWS Lambda Function using Custom Extension?
    • How do I Invoke an API Asynchronously through JMS/AMQP using a Custom Extension?
    • How do I Define a Custom Variable?
    • Custom Variables
    • Custom Extension Properties
    • Data Objects and Variables Available in API Gateway
  • Request and Response Transformation Policies
    • How do I transform a request using Request Transformation Policy?
    • How do I transform a request and its response using Transformation Policy?
  • Invoke webMethods IS Policy
    • How do I transform a request using Invoke webMethods IS policy?
    • How do I transform a response using Invoke webMethods IS policy?
  • System Context Variables
  • The API for Context Variables
  • Assigning a Policy to an API
  • Viewing API Policy Details
  • Modifying API Policy Details
• Aliases
  • Creating a Simple Alias
  • Creating a Secure Alias
  • Creating an Endpoint Alias
  • Creating an HTTP Transport Security Alias
  • Creating a SOAP Message Security Alias
  • Creating a IBM webMethods Integration Server Service Alias
  • Creating an XSLT Transformation Alias
  • Supported Alias and Policy Combinations
• Global Policies
  • Creating a Global Policy
  • Modifying the Scope of a Global Policy
  • Refining the Scope of a Global Policy
  • Associating Policies to a Global Policy
  • Configuring Properties for a Global Policy
  • Viewing List of Global Policies and Policy Details
  • Modifying Global Policy Details
  • Activating a Global Policy
  • Deactivating a Global Policy
  • Deleting a Global Policy
  • Copying a Global Policy
  • Exporting Global Policies
• Scope-level Policies
  • API Scopes
    • Creating an API Scope
    • Viewing List of API Scopes and Scope Details
    • Modifying API Scope Details
    • Deleting an API Scope
  • Creating a Scope-level Policy
  • Viewing List of Scope-level Policies and Policy Details
  • Modifying Scope-level Policy Details
  • Deleting a Scope-level Policy
• Example: Usage Scenarios of API Scopes
• Policy Templates
  • Creating a Policy Template
  • Associating Policies with a Policy Template
  • Configuring Properties for a Policy Template
  • Viewing List of Policy Templates and Template Details
  • Modifying Policy Template Details
  • Deleting a Policy Template
  • Copying a Policy Template
  • Applying a Policy Template on the API Details Page
  • Modifying a Policy Template on the API Details Page
  • Saving Policy Definition of an API as Policy Template
• Change Ownership of Assets
  • How do I change the ownership of an API?
  • How do I change the ownership of an Application?
  • How do I change the ownership of multiple assets?
• Debugging API
  • How do I enable tracing?
  • How do I filter the runtime request?
  • How do I view the trace details?
  • How do I inspect failed runtime requests using tracer?
  • How do I import runtime requests?
  • How do I export or download runtime requests?
  • How do I archive or purge the tracer details?
  • How do I archive and purge the tracer details using REST API Calls?
• API Mashups
  • Creating an API Mashup
• SOAP to REST Transformation
  • Activating SOAP to Rest Transformation
  • Modifying the REST Definitions for SOAP Operations
  • Support for SOAP headers and body mapping
  • Supported Content-types and Accept Headers
  • REST API Endpoints
  • Samples for REST Request
  • Limitations
• API First Implementation
  • API First Implementation using Integration Server
  • API First Implementation using a Third-party Server
  • List of Parameters used in API Implementation
• HTTP Header Handling with CDN and Proxy Services
• Troubleshooting Tips: Implement APIs
• Why Publish APIs?
• Activating an API
  • WSDLs in API Gateway
• Deactivating an API
• Exposing a REST API to Applications
• Exposing a SOAP API and GraphQL API to Applications
• Gateway Endpoints
  • How do I Define API-specific Gateway Endpoints?
  • How do I Define Global Gateway Endpoint?
    • How do I Edit Global Gateway Endpoint?
    • How do I Delete Global Gateway Endpoint?
  • Other Gateway Endpoint Usecases
• Publishing APIs to Developer Portal
  • Publishing a Single API to Developer Portal
  • Publishing Multiple APIs to Developer Portal
  • Unpublishing APIs from Developer Portal
    • Unpublishing a Single API from Developer Portal
    • Unpublishing Multiple APIs from Developer Portal
• Publishing APIs to Service Registries
  • Publishing a Single API to Service Registries
  • Publishing Multiple APIs to Service Registries
  • Unpublishing APIs from a Service Registry
    • Unpublishing a Single API from Service Registries
    • Unpublishing Multiple APIs from Service Registries
• Publishing APIs to Integration Server
  • Publishing a Single API to Integration Server
  • Publishing Multiple APIs to Integration Server
  • Unpublishing APIs from Integration Server
    • Unpublishing a Single API from Integration Server
    • Unpublishing Multiple APIs from Integration Server
• API Monetization
• Packages and Plans
• Creating a Package
• Creating a Plan
• Activating a Package
• Publishing a Package
• Viewing List of Packages and Package Details
• Viewing List of Plans and Plan Details
• Viewing a List of Subscriptions
• Modifying a Package
• Modifying a Plan
• Deleting a Package
• Deleting a Plan
• Analytics
• API-specific Dashboard
• Manage Microservices
• Microgateways
  • Microgateway Groups
  • Microgateway Group Analytics
  • Microgateway Details
  • Deleting Microgateway Instances
• AppMesh Support
  • Configure API Gateway to Connect to a Service Mesh Environment
    • Creating a Microgateway Image
  • AppMesh Deployment
    • Service Discovery
    • APIfy
    • Update API Definition and Policies
    • Deploy AppMesh
  • Undeploy AppMesh
  • Provisioning of API and Policy Updates
• Web Content Accessibility Guidelines
• Introduction
• Asset Promotion
• Promoting Assets using Promotion Management API
• Promoting Assets from API Gateway User Interface
  • Viewing Promotion List and Promotion Details
  • Adding a Stage
  • Repromoting Assets
  • Rollbacks
    • Rollback Asset Promotions
    • Viewing Rollback List and Rollback Details
• Export and Import Assets and Configurations
• Exporting APIs
• Importing Asset and Configuration Archives
• Troubleshooting Tips: Import and Export Assets
• Introduction
• Upgrading API Gateway with Zero Downtime
• Upgrading external Elasticsearch in API Gateway
• Migrate Elasticsearch 10.15 to Opensearch 11.1
  • Migrating core data from Elasticsearch v10.15 to Opensearch v11.1
  • Migrating analytics data from Elasticsearch v10.15 to Opensearch v11.1
• Upgrade configurations
• Quiesce Mode
• Troubleshooting Tips
• webMethods API Gateway Administration
• Alias Management
• Application Management
• API Gateway Archive
• API Gateway Availability
• Document Management
• Data Center Management
• Internal Service
• Port Configuration
• Policy Management
• Promotion Management
• Public Services
• API Gateway Search
• Server Information
• Service Management
• Transaction Data
• User Management
• Subscription Management
• Backward compatibility support for REST APIs
• Troubleshooting Tips: REST APIs
• API Gateway Error Message Reference