webMethods API Gateway Documentation
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Configuring API Gateway
API Gateway Architecture
API Gateway Deployment
API Gateway Deployment Scenarios
API Gateway Data Store
Overview of API Gateway Data Store
Administering API Gateway Data Store
Starting, Stopping, and Restarting API Gateway Data Store
Starting API Gateway Data Store in Command Central
Stopping API Gateway Data Store in Command Central
Starting, Stopping, and Restarting API Gateway Data Store on Windows
Starting, Stopping, and Restarting API Gateway Data Store on LINUX
Changing the API Gateway Data Store HTTP Port
Changing the API Gateway Data Store HTTP Port using Template
Changing the API Gateway Data Store TCP Port
Configuring an API Gateway Data Store Cluster
Configuring Data Store Cluster using Template
Configuring Custom API Gateway Data Store Properties
Configuring Elasticsearch Properties
Configuring Elasticsearch Properties using Template
Configuring API Gateway Data Store to run Executables
Renaming Data Store Windows Service
Securing Communication with API Gateway Data Store
Configuring API Gateway Data Store Keystores
Configuring the API Gateway Data Store HTTP Keystore
Configuring the API Gateway Data Store TCP Keystore
Configuring the API Gateway Data Store sgadmin Keystore
Configuring the API Gateway Data Store Truststore
Configuring the API Gateway Data Store Truststore using Template
Secure API Gateway Data Store
Securing API Gateway Data Store
Preparing the Clients
Verifying API Gateway and Browsers
Command Line to Manage API Gateway Data Store
Commands that API Gateway Data Store Supports
Configuration Types that API Gateway Data Store Supports
Run-Time Monitoring Statuses for API Gateway Data Store
Lifecycle Actions for API Gateway Data Store
API Gateway Configuration
API Gateway Cluster Configuration
Nodes and Clusters
Configuring an API Gateway Cluster
API Gateway Cluster Configuration
API Gateway Data Store Cluster Configuration
Configuring Elasticsearch Cluster
Adding New Node to an Elasticsearch Cluster
Terracotta Server Array Configuration
Load Balancer Configuration
Ports Configuration
API Gateway Availability and Health Status
Externalizing Configurations
Using the Externalized Configuration Files
Default Scenario
Troubleshooting
Connecting to an External Elasticsearch
API Gateway, Elasticsearch, Kibana Compatibility Matrix
Connecting to an External Kibana
Configuring Multiple Instances of API Gateway in a Single Installation
Changing the JVM Heap Size to Tune API Gateway Performance
Accessing the API Gateway User Interface
Restarting API Gateway Using Scripts
Restarting API Gateway Using User Interface
Securing API Gateway and its Components
Overview
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 API Portal?
How do I Secure API Gateway Data Store Communication?
Search Guard Properties
Creating a Custom Keystore with Self-Signed Certificates
API Gateway Configuration with Command Central
Overview
Installing API Gateway using Command Central
Installing API Gateway Using Command Central User Interface
Connecting to Repository
Configuring Platform Manager on Remote Nodes
Installing API Gateway
Creating API Gateway Instance
Installing API Gateway using Command Central Templates
Manage API Gateway Data Store Configurations in Command Central
Manage API Gateway Product Configurations in Command Central
Configuring Properties
Configuring Keystores
Configuring Keystores using Template
Configuring Licenses
Configuring Loggers
Configuring HTTP Port
Configuring HTTPS Port
Configuring HTTPS Port using Template
Configuring Truststores
Configuring Truststores using Template
Manage Inter-component and Cluster configurations
Configuring Elasticsearch Connection Settings
Configuring External Elasticsearch using Template
Configuring Kibana Connection Settings
Configuring Kibana using Template
Configuring API Gateway Cluster
Configuring Cluster using Template
Docker Configuration
Overview
Building the Docker Image for an API Gateway Instance
Retrieving Port Information of the API Gateway Image
Running the API Gateway Container
Load Balancer Configuration with the Docker Host
Stopping the API Gateway Container
Managing API Gateway Images
API Gateway Docker Container with Externalized Elasticsearch and Kibana
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 Elasticsearch Containers
Running Clustered API Gateway and Elasticsearch Containers and a Kibana Container
Kubernetes Support
Overview
Deploying API Gateway Pod with API Gateway and Elasticsearch Containers
Deploying API Gateway Pod with API Gateway Container connected to an Elasticsearch Kubernetes Service
Kubernetes Sample Files
Helm Chart
Using Helm to Start the API Gateway Service
OpenShift Support
Building a Docker Image for an API Gateway Instance in OpenShift Environment
Running the API Gateway Docker Image with the sagadmin User
OpenShift Sample Files
Configuration Properties
Configuration Types and Properties
webApp Configuration Properties
API Gateway Package Configuration Properties
Configuration Properties to Secure Elasticsearch
API Gateway Data Management
Data Backup and Restore
API Gateway Backup and Restore Commands
Backing up API Gateway Configuration Data
Restoring API Gateway Configuration Data
API Gateway Staging and Promotion
Staging and Promotion
Asset Promotion in API Gateway
Promoting Assets Using webMethods Deployer
Promoting Assets Using Promotion Management API
Mediator Migration to API Gateway
Migrating Mediator to API Gateway
Using API Gateway
webMethods API Gateway
Introduction to webMethods API Gateway
Searching Data in API Gateway
Configuring the Number of APIs listed on a Page
Using Help in API Gateway
API Gateway Administration
Overview of Administration Tasks
General 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
Managing Pending 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 Logs
Configuring Log Levels
Downloading the Log Files
Configuring Log Aggregation
License Configuration
Viewing Licensing Information
Configuring Licenses
Enabling Clustering for API Gateway
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
Transaction Alerts
Configuring Criteria for Transaction Alert Notification
Modifying License Alert Configurations
Deleting a Transaction Alert Configuration
Security Configuration
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
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 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
OAuth Authentication Use case and Workflow
Retrieving OAuth Token
JWT Authentication Use case and Workflow
Retrieving JWT Token
Retrieving JWT Token with Claim
OpenID Authentication Use case and Workflow
Configuring the Internal Authorization Server
Adding a Provider
Adding an External Authorization Server
Mapping 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
Destination Configuration
Configuring Events for API Gateway Destination
Configuring API Portal Destination
Configuring Events for API Portal Destination
Configuring Transaction Logger Destination
Configuring CentraSite Destination
Configuring Events for CentraSite Destination
Configuring Events for Database Destination
Configuring Events for Digital Events Destination
Configuring Elasticsearch Destination
Configuring Events for Elasticsearch Destination
Configuring Email Destination
Configuring Email Templates
Configuring SNMP Destination
Configuring Events for SNMP Destination
Audit Logging
Configuring Audit Logs
Viewing Audit Logs
Downloading Audit Logs
Data Management
Archive and Purge
Archiving Data
Purging Data
Restore
Restoring Data
System Settings
Modifying API Gateway Configuration Parameters
Configuring SAML Settings for Single Sign-on
External Accounts
Adding a Service Registry
Removing a Service Registry
Configuring Integration Server Instance for API Implementation
User Management
Manage 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
Creating Teams
Setting Password Restrictions
Setting Password Expiry Restrictions
Configuring Account Locking Settings
Unlocking User Accounts
Restricting User Accounts
Configuring API Gateway to Use LDAP
Managing LDAP Directories
Manage Your User Settings and Preferences
Changing Your Account Settings
Changing Your Password
Changing Your Display Language
Viewing Your Roles and Permissions
APIs
Overview
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
Overview of Creating a REST API from Scratch
Creating a REST API
Creating a WebSocket API
API Mashups
Creating an API Mashup
Viewing API List and API Details
REST API Details
SOAP API Details
OData API Details
Filtering APIs
Activating an API
WSDLs in API Gateway
Deactivating an API
Publishing APIs
Publishing APIs to API Portal
Publishing a Single API to API Portal
Publishing Multiple APIs to API Portal in a Single Operation
Publishing APIs to Service Registries
Publishing a Single API to Service Registries
Publishing Multiple APIs to Service Registries in a Single Operation
Unpublishing APIs
Unpublishing APIs from API Portal
Unpublishing a Single API from API Portal
Unpublishing Multiple APIs from API Portal in a Single Operation
Unpublishing APIs from a Service Registry
Unpublishing a Single API from Service Registries
Unpublishing Multiple APIs from Service Registries in a Single Operation
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
API Mocking
Enabling API Mocking
Modifying API Mocking Details
Custom Replacer
Attaching Documents to an API
SOAP to REST Transformation
Activating SOAP to Rest Transformation
Modifying the REST Definitions for SOAP Operations
Supported Content-types and Accept Headers
REST API Endpoints
Samples for REST Request
Limitations
CentraSite Provided APIs
Versioning APIs
Creating New API Version
API Scopes
Creating an API Scope
Viewing List of API Scopes and Scope Details
Modifying API Scope Details
Exposing a REST API to Applications
Deleting an API Scope
Example: Usage Scenarios of API Scopes
Exposing a SOAP API to Applications
API Grouping
API Tagging
Adding Tags to an API
Exporting APIs
Exporting Specifications
Deleting APIs
Deleting a Single API
Deleting Multiple APIs in a Single Operation
Example: Managing an API
Policies
Overview
Policy Validation and Dependencies
Managing 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
System-defined Stages and Policies
Transport
Enable HTTP/HTTPS
Enable JMS/AMQP
Configuring API Gateway for JMS with AMQP Protocol
Using Enable JMS/AMQP for a SOAP API
Using Enable JMS/AMQP for a REST API
Set Media Type
Identify and Access
Inbound Authentication - Message
Authorize User
Identify and Authorize Application
Request Processing
Invoke webMethods IS
Request Transformation
Validate API Specification
Data Masking
Routing
Content-based Routing
Context-based Routing
Dynamic Routing
Load Balancer Routing
Straight Through Routing
Custom HTTP Header
Outbound Authentication - Transport
Outbound Authentication - Message
JMS/AMQP Policies
Using JMS/AMQP Policy for a SOAP API
Using JMS/AMQP Policy for a REST API
JMS/AMQP Properties
Traffic Monitoring
Log Invocation
Uncompressing a payload
Monitor Service Performance
Monitor Service Level Agreement
Throttling Traffic Optimization
Service Result Cache
Response Processing
Invoke webMethods IS
Response Transformation
Validate API Specification
CORS
Data Masking
Error Handling
Conditional Error Processing
Data Masking
The API for Context Variables
Managing 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
Managing API-level Policies
Assigning a Policy to an API
Viewing API Policy Details
Modifying API Policy Details
Managing Scope-level Policies
Creating a Scope-level Policy
Viewing List of Scope-level Policies and Policy Details
Modifying Scope-level Policy Details
Deleting a Scope-level Policy
Managing 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
Supported Alias and Policy Combinations
Aliases
Overview
Creating a Simple Alias
Creating an Endpoint Alias
Creating an HTTP Transport Security Alias
Creating a SOAP Message Security Alias
Creating a webMethods Integration Server Service Alias
Creating an XSLT Transformation Alias
Applications
Overview
Creating an Application
Viewing List of Applications and Application Details
Regenerating API Access Key
Modifying Application Details
Registering an API with Consumer Applications from API Details Page
Registering APIs with Consumer Applications from Application Details Page
Suspending an Application
Activating a Suspended Application
API Packages and Plans
Overview
Creating a Package
Creating a Plan
Viewing List of Packages and Package Details
Modifying a Package
Deleting a Package
Activating a Package
Publishing a Package
Viewing List of Plans and Plan Details
Modifying a Plan
Deleting a Plan
Export and Import Assets and Configurations
Overview
Importing Asset and Configuration Archives
Asset Promotions
Manage Stages, Promotions, and Rollbacks
Stages
Adding a Stage
Viewing Stage List and Stage Details
Modifying Stage Details
Deleting a Stage
Promotions
Promoting Assets
Viewing Promotion List and Promotion Details
Repromoting Assets
Rollbacks
Rollback Asset Promotions
Viewing Rollback List and Rollback Details
API Gateway Analytics
Analytics Dashboards
API Gateway Dashboard
API-specific Dashboard
Runtime Events and Metrics Data Model
API Gateway
API Portal
Audit Log
CentraSite
Elasticsearch
Email
JDBC
Local Log
Microgateway Management
Overview
Microgateway Groups
Microgateway Details
Microgateway Analytics
REST APIs in API Gateway
API Gateway Administration
Alias Management
Application Management
API Gateway Archive
API Gateway Availability
Document Management
Internal Service
Policy Management
Promotion Management
Public Services
API Gateway Search
Server Information
Service Management
Transaction Data
User Management
Backward compatibility support for REST APIs
Remove User Data from API Gateway
Removing User Data
Usage Scenarios
Change Ownership of Assets
How Do I Change the Ownership of an Application?
How Do I Change the Ownership of an API?
How Do I Change the Ownership of Multiple Assets?
How Do I Configure the Approval Process for Ownership Change of Assets?
Custom Policy Extension
How Do I Invoke a Service through HTTP/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?
Configuring an AWS Alias
How Do I Invoke a Service Asynchronously through JMS/AMQP using a Custom Extension?
Custom Extension Properties
Data Objects and Variables Available in API Gateway
Team Support
When to use Team support?
What is a Team in API Gateway?
When not to use 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
Scenarios where you cannot use Teams support
API Gateway Functional Privileges
API First Implementation
API First Implementation using Integration Server
API First Implementation using a Third-party Server
List of Parameters used in API Implementation
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
SAML SSO
How to enable SAML SSO in API Gateway?
SAML Assertion
How to map an API Gateway group based on SAML assertion from IdP?
Troubleshoot tips for SSO configuration
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?
Copyright
webMethods API Gateway Documentation
Copyright
gtw_introduction
gtw_search
gtw_administration
gtw_gen_config
gtw_configure_load_balancer
gtw_configure_extended_settings
gtw_configure_fault_settings
gtw_configure_approvals
gtw_configure_approvals_create
gtw_configure_approvals_register
gtw_configure_approvals_update
gtw_configure_approvals_subscribe
ta_pending_request
gtw_configure_outbound_proxy
gtw_configure_proxy_bypass
gtw_configure_url_aliases
gtw_custom_content_type
gtw_configure_cache
gtw_configure_loglevels
gtw_download_logfiles
gtw_configure_log_aggregation
gtw_license_info
gtw_configure_license
gtw_configure_cluster
gtw_configure_callback_settings
gtw_configure_license_alerts
gtw_sec_config
gtw_configure_keystore
gtw_configure_truststore
gtw_configure_keystore_truststore
gtw_config_key_trust_outbound_connections
gtw_configure_ports
gtw_configure_ipaccessmode
gtw_configure_accessmode
gtw_configure_global_ip
gtw_configure_saml_issuer
gtw_policy_assertions
gtw_configure_policy_assertion
gtw_configure_kerberos
gtw_manage_master_password
gtw_configure_auth_server_int
gtw_configure_provider
gtw_configure_auth_server_ext
gtw_map_oauth_scope
gtw_configure_gateway
gtw_configure_portal
gtw_configure_audit_logger
gtw_configure_cs
gtw_configure_cs_events
gtw_configure_database
gtw_configure_des
gtw_configure_es
gtw_configure_es_events
gtw_configure_email
ta_configure_email_template
gtw_configure_snmp
gtw_configure_snmp_events
gtw_archive_purge
gtw_restore
gtw_configure_system_settings
gtw_service_registries
gtw_configure_is
gtw_manage_users_groups_profiles
gtw_add_user
ta_modify_user
co_user_groups
gtw_add_group
ta_modify_group
gtw_manage_pwd_restrictions
gtw_manage_pwd_expiry_settings
gtw_manage_account_lock_settings
gtw_manage_locked_users
gtw_manage_provider_configuration
gtw_manage_ldap_directories
gtw_manage_user_accounts_settings
gtw_manage_apis
gtw_create_api_file
gtw_create_api_url
gtw_create_api_scratch
gtw_create_rest_api_scratch
gtw_create_websockets_api_scratch
gtw_add_api_mashup
gtw_view_api_details
updating_apis
updating_apis_file
updating_apis_url
api_mocking
ta_modifying_api_mocking
soap_rest_transformation
modifying_rest_definitions
content_type
endpoint
sample_rest_request
limitations
versioning_apis
create_new_versioning_apis
exporting_apis
exporting_specifications
gtw_manage_policies
gtw_manage_threat_protection_policies
gtw_transport_policies
gtw_iam_policies
gtw_payload_request
gtw_transformation_request
gtw_routing_policies
gtw_lmt_policies
gtw_payload_response
gtw_transformation_response
gtw_error_handling
gtw_manage_global_policies
gtw_create_global_policy
gtw_view_global_policy
gtw_modify_global_policy
exporting_global_policies
gtw_manage_policy_templates
gtw_create_policy_template
gtw_view_policy_template
gtw_modify_policy_template
gtw_apply_policy_template
gtw_manage_aliases
create_is_alias
create_transformation_alias
gtw_manage_applications
gtw_create_application
gtw_view_application_details
ta-modify_appln_ui
gtw_manage_packages
gtw_create_package
gtw_create_plan
ta-modify_package
ta-modify_plan
exporting_importing_files
gtw_manage_promotions
gtw_add_stage
ta_modify_stage
gtw_analytics
gtw_manage_microgateways
gtw_view_microgateways_group_details
gtw_view_microgateway_details
gtw_configure_approval_cahnge_owner
gtw_configure_aws_alias
gtw_add_profile
gtw_configure_saml_sso